API Documentation

Use the Protocol API to access contacts, conversations, messages, and more — or integrate with the TypeScript SDK.

Getting started#

To get started, create an account in the developer settings, then visit our integrations directory to browse available apps. Grab an API key and follow the Quickstart guide.

Learn how to authenticate your API requests with bearer tokens.

Understand cursor and page-based pagination across list endpoints.

Read about error codes, HTTP status mapping, and retry guidance.

Configure webhooks to receive real-time event notifications.

Create and manage people and organizations in your workspace.

Open and track threaded conversations between contacts and agents.

Send and retrieve messages within conversations.

Organize contacts into reusable audience groups.