Source of truth
- OpenAPI endpoint:
GET /openapi.json - Path set in this page is generated from API tests and includes 125 unique paths.
Path groups
| Group | Paths |
|---|---|
| auth | 12 |
| organizations and members | 11 |
| channels | 17 |
| contacts and conversations | 25 |
| messages and media | 6 |
| cdp | 21 |
| settings | 16 |
| waba | 9 |
| system | 8 |
Complete path list
Copy
/v1/api-keys
/v1/api-keys/{keyID}
/v1/audit-logs
/v1/auth/email-verification/confirm
/v1/auth/email-verification/request
/v1/auth/fingerprint-events
/v1/auth/login
/v1/auth/logout
/v1/auth/me
/v1/auth/me/preferences
/v1/auth/me/presence
/v1/auth/onboarding
/v1/auth/password/confirm
/v1/auth/password/reset
/v1/auth/register
/v1/cdp/activity-log
/v1/cdp/contact-objects
/v1/cdp/contact-objects/{objectID}
/v1/cdp/contacts/{contactID}/activity
/v1/cdp/contacts/{contactID}/lifecycle-stage
/v1/cdp/custom-fields
/v1/cdp/custom-fields/{fieldID}
/v1/cdp/events
/v1/cdp/lifecycle-stages
/v1/cdp/lifecycle-stages/metrics
/v1/cdp/lifecycle-stages/{stageID}
/v1/cdp/object-types
/v1/cdp/object-types/{objectTypeID}
/v1/cdp/object-types/{objectTypeID}/fields
/v1/cdp/object-types/{objectTypeID}/fields/reorder
/v1/cdp/object-types/{objectTypeID}/fields/{fieldID}
/v1/cdp/segments
/v1/cdp/segments/{segmentID}
/v1/cdp/segments/{segmentID}/members
/v1/cdp/templates
/v1/cdp/templates/{templateID}
/v1/channels
/v1/channels/{channelID}
/v1/channels/{channelID}/capabilities
/v1/channels/{channelID}/connect
/v1/channels/{channelID}/disconnect
/v1/channels/{channelID}/media/{mediaID}
/v1/channels/{channelID}/network/proxy
/v1/channels/{channelID}/pairing-code
/v1/channels/{channelID}/profile/business
/v1/channels/{channelID}/qr
/v1/channels/{channelID}/reconnect
/v1/channels/{channelID}/reconnect/force
/v1/channels/{channelID}/settings/advanced
/v1/channels/{channelID}/settings/phone
/v1/channels/{channelID}/settings/phone/two-step
/v1/channels/{channelID}/settings/phone/two-step/enable
/v1/channels/{channelID}/status
/v1/contact-tags
/v1/contact-tags/{tagID}
/v1/contacts
/v1/contacts/phone/{phone}
/v1/contacts/{contactID}
/v1/contacts/{contactID}/notes
/v1/contacts/{contactID}/notes/{noteID}
/v1/contacts/{contactID}/tags
/v1/contacts/{contactID}/tags/{tagID}
/v1/conversations
/v1/conversations/{convID}
/v1/conversations/{convID}/archive
/v1/conversations/{convID}/assign
/v1/conversations/{convID}/close
/v1/conversations/{convID}/history-sync
/v1/conversations/{convID}/labels
/v1/conversations/{convID}/labels/{labelID}
/v1/conversations/{convID}/messages
/v1/conversations/{convID}/mute
/v1/conversations/{convID}/pin
/v1/conversations/{convID}/read
/v1/conversations/{convID}/reopen
/v1/conversations/{convID}/unarchive
/v1/conversations/{convID}/unmute
/v1/conversations/{convID}/unpin
/v1/health
/v1/invitations
/v1/invitations/{id}/accept
/v1/invitations/{invitationID}
/v1/labels
/v1/labels/{labelID}
/v1/media/assets
/v1/media/assets/{assetID}
/v1/media/uploads
/v1/members
/v1/members/{userID}
/v1/messages
/v1/messages/uploads/image
/v1/messages/{messageID}
/v1/organization
/v1/organizations
/v1/ready
/v1/settings/billing
/v1/settings/developer/webhooks
/v1/settings/developer/webhooks/alerting-settings
/v1/settings/developer/webhooks/deliveries
/v1/settings/developer/webhooks/deliveries/{messageID}/attempts
/v1/settings/developer/webhooks/deliveries/{messageID}/retry
/v1/settings/developer/webhooks/endpoints
/v1/settings/developer/webhooks/endpoints/{endpointID}
/v1/settings/developer/webhooks/endpoints/{endpointID}/rotate-secret
/v1/settings/developer/webhooks/endpoints/{endpointID}/test
/v1/settings/developer/webhooks/portal-access
/v1/settings/integrations
/v1/settings/notifications
/v1/settings/security
/v1/settings/sessions
/v1/settings/sessions/{sessionID}
/v1/teams
/v1/teams/{teamID}
/v1/teams/{teamID}/members
/v1/teams/{teamID}/members/{userID}
/v1/version
/v1/waba/errors
/v1/waba/exchange-code
/v1/waba/labels/support
/v1/waba/oauth/start
/v1/waba/progress/{progressID}
/v1/waba/register-phone
/v1/waba/signup-event
/v1/waba/subscribe-webhook
/v1/waba/sync-meta
This list is generated from test coverage and can lag behind newly added handlers. Use
GET /openapi.json as runtime source of truth.