API Reference

Build custom integrations with the Gatekeeper REST API. Automate workflows, sync data, and extend functionality.

Base URL: https://api.gatekeeper.io/v1

API Features

API Keys

Secure authentication using API keys. Generate and manage keys from your dashboard.

RESTful JSON

Clean, predictable REST API with JSON request and response bodies.

Webhooks

Real-time notifications for check-ins, check-outs, and other events.

Rate Limiting

Generous rate limits with clear headers. 1000 requests per minute on Pro plans.

Secure

TLS 1.3 encryption, IP allowlisting, and detailed audit logs for all API calls.

SDKs

Official SDKs for JavaScript, Python, Ruby, and PHP. Community SDKs for more languages.

Authentication

Authenticate your API requests using an API key in the Authorization header.

curl -X GET "https://api.gatekeeper.io/v1/visitors" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

You can generate API keys from your Gatekeeper dashboard under Settings → API Keys. Keep your API keys secure and never expose them in client-side code.

Endpoints

Core endpoints for managing visitors and locations.

GET/api/v1/visitors

List all visitors with optional filtering and pagination

POST/api/v1/visitors

Create a new visitor check-in record

GET/api/v1/visitors/:id

Retrieve a specific visitor by ID

PATCH/api/v1/visitors/:id

Update a visitor record

POST/api/v1/visitors/:id/checkout

Check out a visitor

GET/api/v1/locations

List all locations for your organization

GET/api/v1/reports/visits

Generate visit reports with date range filtering

POST/api/v1/webhooks

Create a webhook subscription

Official SDKs

Get started quickly with our official client libraries.

JavaScript/TypeScript

npm install @gatekeeper/sdk

Python

pip install gatekeeper-sdk

Ruby

gem install gatekeeper

PHP

composer require gatekeeper/sdk

Ready to build?

Create your API key and start integrating Gatekeeper today.

Get API Access Contact Developer Support