Skip to main content
This section documents the 150 v1 endpoints, generated from the API’s OpenAPI specification. Each page shows the accepted parameters, the request body, the response format and a playground where you can try the call right in your browser.

​
Base URL

On-premise installations use their own environment’s domain, followed by /api/v1.
Creating, editing, rotating and revoking tokens is not part of the API. For security reasons, these operations can only be done in the panel.

​
Testing from the playground

1

Open any endpoint

Start with a GET, such as GET /contacts. Reads don’t change any data.
2

Provide the token

In the Authorization field, paste your sk_live_… key. It is stored only in your browser.
3

Check the server

The playground points to https://api.connectadesk.com/api/v1. If your installation is on-premise, replace it with your environment’s domain.
The playground makes real calls. A DELETE run here actually deletes the record, without asking for confirmation and with no way to undo it. While you are exploring, use staging data.

​
The map of the modules

Each group in the left-hand menu matches a token permission module. If an endpoint responds with 403 ERR_API_FORBIDDEN_SCOPE, your token is missing the permission for that group’s module.

Conversations

Contacts, Tickets, Messages, Channels and Webchat. This is the foundation for anyone integrating customer service.

Organization

Tags, Queues, Wrap-up types, Users and Permission profiles. They define how tickets are distributed and classified, and what each person can do.

Outreach

Scheduled messages, Quick replies and Campaigns. They cover the messages that go from the company to the customer.

Sales

CRM, Products and Custom fields. They support the sales boards and the catalog.

Reports

Conversation and automation reports, plus the dashboard indicators. They show the numbers of the operation.

​
Conventions

A few rules apply to every endpoint:

Envelope

Every resource comes in data, and every error comes in error.

Pagination

page and perPage, with hasMore to tell you whether there are more pages. There is no total.

Idempotency

Idempotency-Key on POST and PUT.

Limits

Request limit per minute, per company.

​
Versioning

The version is part of the path: /api/v1. While it exists, changes will only be additive. New fields and endpoints may appear, but the ones that already exist keep their name, type and meaning. That is why your integration should ignore fields it doesn’t recognize instead of failing when it finds them. Changes that break compatibility only come with a new version in the path.