Resources

Partner API v2 reference - browse sections and individual HTTP calls.

Agency resources

Partner API v2 exposes the full agency surface under /api/v2. Authenticate with a Bearer API key that includes the matching scope (or * for full access).

Docs are organized as section → HTTP call. Machine-readable schema: GET /api/v2/openapi.json. See Authentication for scopes.

Browse by section

  • Calendar - Availability, public bookings, working hours, appointments, and booking widgets. Creating bookings uses the calendar scope; managing appointments and hours uses appointments. (14 operations)
  • Contacts - CRM contacts - create, update, soft-delete, restore, and manage tags. (7 operations)
  • Messages - Inbox messages and contact notes. (4 operations)
  • Paths - Benefit paths - drafts, publish, history, and restore. List also accepts the analytics scope (thinner catalog). (8 operations)
  • Fields - Custom contact fields. DELETE archives a field rather than hard-deleting it. (4 operations)
  • Analytics - Path Analytics reports for the agency that owns your token. (1 operation)
  • Voice AI - Named Voice AI agents, outbound call create/schedule, call history, cancel, and wallet balance. Agent editor CRUD stays in the dashboard. (7 operations)
  • Team - Agency team members and invites. (5 operations)
  • Settings - Curated agency settings (no OAuth secrets). (2 operations)