Documentation · v1 preview
Overview
The LobbyPulse API is a JSON REST API at https://api.lobbypulse.dev/v1. It is available to approved integrators, and to customers on the Business plan and above with their own API keys. The full OpenAPI 3.1 specification is shared with approved partners together with sandbox access.
Authentication
Partner apps: OAuth 2.0
Approved apps use the authorization code flow with PKCE. A customer admin installs your app and approves its scopes, and the tokens you receive are bound to that one customer workspace.
Customer API keys
Customers can create their own keys (lp_live_…) with scopes, an expiry and an optional IP allowlist. Keys are shown once and stored hashed.
Authorization: Bearer <access token or API key>Scopes
Request the fewest scopes you need. If a scope wasn't granted, its fields are omitted from responses.
| Scope | Grants |
|---|---|
locations:read | Sites and kiosks (no device secrets) |
hosts:read | Employee directory entries used as hosts |
hosts:write | Create and update hosts when directory sync is off |
visits:read | Visit times, status, host, visitor type, visitor display name and company |
visits:write | Invite / pre-register, cancel and sign out visits |
visitors:read | Full visitor profile: email, phone, photo · sensitive, extra review |
itar:read | U.S.-person status, citizenship and escort assignments (also needs a per-workspace toggle) · sensitive, extra review |
ltv:read | Long-term visitor and contractor applications and status (never ID images) · sensitive, extra review |
ltv:write | Create and update long-term visitor applications · sensitive, extra review |
screening:read | Screening results: clear, under review or match · sensitive, extra review |
events:subscribe | Manage webhook subscriptions for the granted read scopes |
deliveries:read | Package log |
deliveries:write | Log deliveries and pickups |
audit:read | Audit log stream (SIEM) |
Resources
GET /v1/locations
GET /v1/hosts?q= POST /v1/hosts
GET /v1/visits?status=&from=&to=&location_id=&cursor=
POST /v1/visits invite / pre-register
GET /v1/visits/{id}
POST /v1/visits/{id}/cancel
POST /v1/visits/{id}/sign-out
GET /v1/visitors/{id} (visitors:read)
GET /v1/long-term-applications (ltv:read)
GET /v1/deliveries POST /v1/deliveries
GET /v1/audit-events?since= (audit:read)
GET /v1/webhooks POST /v1/webhooks DELETE /v1/webhooks/{id}
GET /v1/meConventions
- IDs are prefixed (
vis_,loc_,hst_). Timestamps are RFC 3339 UTC. - Cursor pagination with
cursorandnext_cursor. - Send an
Idempotency-Keyheader on every POST. - Errors use RFC 9457
application/problem+json. - The default rate limit is 600 requests per minute per installation, reported in
RateLimit-*headers.
Webhooks
Subscribe with events:subscribe. Payloads are thin: fetch the details with your scopes.
Events: visit.invited visit.preregistered visit.arrived visit.checked_in visit.checked_out visit.escort_required ltv.submitted ltv.approved ltv.expiring screening.review_required delivery.received
POST https://your-app.example.com/lobbypulse
LobbyPulse-Signature: t=1763474531,v1=5f2b… (HMAC-SHA256 of "<t>.<body>")
{ "id": "evt_…", "type": "visit.checked_in", "created": "2026-11-18T14:02:11Z",
"data": { "visit_id": "vis_7Qk2…", "location_id": "loc_hq" } }Reject signatures older than 5 minutes. Failed deliveries are retried with exponential backoff for 24 hours, and subscriptions that keep failing are disabled after 3 days.
Government tenants
Workspaces for GCC High customers run on U.S. Government cloud infrastructure, and they can only install apps approved for government use. If you want to serve them, tell us in your application where your service is hosted and who can access customer data.