API Documentation
Secure your apps with standards-compliant authentication and authorization. Use our OIDC/OAuth 2.0 endpoints to sign in users, manage profiles, issue access tokens, and protect APIs with roles, permissions, and scopes.
Getting started
- Create an application in the developer console and register redirect and post-logout redirect URIs.
- Choose a flow:
- Authorization Code + PKCE for user sign-in.
- Client Credentials for service-to-service.
- Use the discovery document at
/.well-known/openid-configurationto locateauthorization_endpoint,token_endpoint,userinfo_endpoint, andjwks_uri. - Request scopes like
openid,profile,email, andoffline_accessas needed. - Validate ID tokens (
iss,aud,exp,nonce) and use access tokens to authorize API calls.
Resources
Contacts
Learn about the contact model and how to create, retrieve, update, delete, and list contacts.
Conversations
Learn about the conversation model and how to create, retrieve, update, delete, and list conversations.
Messages
Learn about the message model and how to create, retrieve, update, delete, and list messages.
Groups
Learn about the group model and how to create, retrieve, update, delete, and list groups.