GuestTrack API
Bring visitor records into your own systems, and send visits back, with project-scoped API keys.
What you can do
Connect GuestTrack to the systems you already run.
Read visitor records
Who checked in, when, through which QR code, and what they filled in. Filter by time, QR code, status or mobile number.
Record visits
Record a check-in or a pre-registration from another system, one at a time or up to 100 in a request.
Check visitors out
Close a visit when your access control, booking or rostering system knows the visitor has left.
Your first request
Create a key
In the dashboard, select your project, open Settings > Check-in Setup, then the API / Push card. Copy the key: it is shown only once.
Send it as a bearer token
curl "https://api.guesttrack.io/api/v2/projects/{projectId}/visits?limit=10" \ -H "Authorization: Bearer gt_live_..."Read the response
You get the project's most recent visits, newest first. The API docs list every field with examples.
Endpoints
| GET | /api/v2/projects/{projectId} | Get the project |
| GET | /api/v2/projects/{projectId}/form | Get the check-in form |
| GET | /api/v2/projects/{projectId}/qr-codes | List QR codes |
| GET | /api/v2/projects/{projectId}/visits | List visits |
| GET | /api/v2/projects/{projectId}/visits/{visitId} | Get a visit |
| POST | /api/v2/projects/{projectId}/visits | Record a visit |
| POST | /api/v2/projects/{projectId}/visits:batch | Record visits in bulk |
| POST | /api/v2/projects/{projectId}/visits/{visitId}/checkout | Check a visitor out |
Built for integrations
Keys belong to one project
A key only works for the project it was created in. A Read key reads; a Read + Write key can also record visits and check visitors out. Revoke a key at any time.
Paging you can rely on
List responses return items, hasMore and nextCursor. Keep calling with the cursor until hasMore is false.
Safe retries
Send an Idempotency-Key header when you record visits. A retry after a network error does not record the visit twice.
Errors your code can act on
Errors are problem+json with a stable code field, such as validation_failed or api_access_required, and every response carries a request ID for support.
A sandbox for testing
Build against api.uat.guesttrack.io with a test key, so your real visitor records are never touched.
OpenAPI reference
Every endpoint, field and example response is documented, with an OpenAPI document you can import into your tools.
Start building
API keys are included in the Portfolio plan. See pricing for details.