Skip to main content
The public Connecta DESK API gives you access, at /api/v1, to the same functions you use in the platform: sending and reading messages, opening and closing tickets, maintaining contacts and custom fields, working on CRM boards, sending campaigns and checking reports. Every call is authenticated by a company token, created in the panel with permissions for each module and method. A token that only has GET on contacts can read contacts and nothing else.

First call

Create the token and get your first response in a few minutes.

Authentication

Token format, the header, and what makes the API respond 401.

Permissions

How the token grants access to each module and each method.

Reference

The 150 endpoints, with request body, response and ready-to-run examples.

​
What you can do

Conversations

Send text, media, templates and interactive messages. Open, transfer, close and wrap up tickets.

Records

Contacts with custom fields, tags, queues, wrap-up types, quick replies and users of the company.

CRM and products

Boards, stages, cards, history and notes. Product catalog with categories and sales performance.

Campaigns and data

Bulk sends with execution control, plus reports on conversations, automations and dashboards.

​
How the API behaves

Three rules apply to every endpoint. Knowing these rules before your first integration helps you understand most of the responses you will get.
The token belongs to the company, not to a user. If you send companyId in the body or in the query, the value is ignored and the API always uses the token’s company. This also applies to the endpoints that accept that field for compatibility.
Every list endpoint is paginated. The meta carries only page, perPage and hasMore and does not report the total number of records. To find out whether there is another page, use hasMore. See Pagination.
POST /messages responds 202 with a jobId and sends the message in the background. The result is available at GET /messages/jobs/{jobId}. See Sending messages.

​
Before you start

To create tokens, you need an administrator user of the company. Agents do not see the Integrations menu.
The base URL is:
Self-hosted (on-premise) installations use their own environment’s domain, followed by /api/v1.