> ## Documentation Index
> Fetch the complete documentation index at: https://docs.connectadesk.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connecta DESK API

> REST API to automate customer service, CRM, campaigns and records in Connecta DESK. One token per company, with permission per module and method.

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.

<CardGroup cols={2}>
  <Card title="First call" icon="rocket" href="/en/quickstart">
    Create the token and get your first response in a few minutes.
  </Card>

  <Card title="Authentication" icon="key" href="/en/authentication">
    Token format, the header, and what makes the API respond 401.
  </Card>

  <Card title="Permissions" icon="shield-check" href="/en/essentials/permissoes">
    How the token grants access to each module and each method.
  </Card>

  <Card title="Reference" icon="code" href="/en/api-reference/introduction">
    The 150 endpoints, with request body, response and ready-to-run examples.
  </Card>
</CardGroup>

## What you can do

<Columns cols={2}>
  <Card title="Conversations" icon="message-square">
    Send text, media, templates and interactive messages. Open, transfer, close and wrap up
    tickets.
  </Card>

  <Card title="Records" icon="users">
    Contacts with custom fields, tags, queues, wrap-up types, quick replies and
    users of the company.
  </Card>

  <Card title="CRM and products" icon="kanban">
    Boards, stages, cards, history and notes. Product catalog with categories and
    sales performance.
  </Card>

  <Card title="Campaigns and data" icon="chart-column">
    Bulk sends with execution control, plus reports on conversations, automations and
    dashboards.
  </Card>
</Columns>

## 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.

<AccordionGroup>
  <Accordion title="The company comes from the token, never from the body" icon="building">
    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.
  </Accordion>

  <Accordion title="Every list is paginated" icon="list">
    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](/en/essentials/paginacao).
  </Accordion>

  <Accordion title="Sending a message is asynchronous" icon="clock">
    `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](/en/guides/enviar-mensagens).
  </Accordion>
</AccordionGroup>

## Before you start

<Note>
  To create tokens, you need an **administrator** user of the company. Agents do not see the
  Integrations menu.
</Note>

The base URL is:

```bash theme={null}
https://api.connectadesk.com/api/v1
```

Self-hosted (on-premise) installations use their own environment's domain, followed by `/api/v1`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.