API Documentation

Use the Protocol API to access contacts, conversations, group messages, and more and seamlessly integrate your product into the workflows of dozens of devoted Protocol users.

Quickstart Explore SDKs

Getting started

To get started, create a new application in your developer settings, then read about how to make requests for the resources you need to access using our HTTP APIs or dedicated client SDKs. When your integration is ready to go live, publish it to our integrations directory to reach the Protocol community.

Get your API key

Guides

Authentication

Learn how to authenticate your API requests.

Pagination

Understand how to work with paginated responses.

Errors

Read about the different types of errors returned by the API.

Webhooks

Learn how to programmatically configure webhooks for your app.

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.