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.

TypeScript

Learn about TypeScript's type system, interfaces, generics, and how to build type-safe applications with enhanced developer experience.

React

Explore React's component-based architecture, hooks system, state management, and best practices for building interactive user interfaces.

Next.js

Discover Next.js fundamentals including routing, server-side rendering, API routes, and deployment strategies for production-ready React applications.