API Documentation

Use the Headpat API to access the gallery, conversations, servers, databases, and more from different platforms.

Getting started

To get started, check out the resources for each platform. As we have multiple platforms, they are each split apart into it's own category, as the API's are also split. Most API's (especially on Place) are publically accessible, however, some are not. These will require authentication via JWT, which you can get in your developer settings.

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.