Skip to main content
POST
Look up upcoming bookings

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Body

application/json
phone
string
required

Invitee phone number in any common notation.

email
string

Invitee email address. Only yields matches together with name.

name
string

Invitee name. Only yields matches together with email.

limit
integer
default:10

Maximum number of matches to return.

Required range: 1 <= x <= 50

Response

Matching upcoming bookings, earliest first.

data
object
required