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

# API do Connecta DESK

> API REST para automatizar atendimento, CRM, campanhas e cadastros do Connecta DESK. Um token por empresa, com permissão por módulo e método.

A API pública do Connecta DESK dá acesso, em `/api/v1`, às mesmas funções que você usa na
plataforma: enviar e ler mensagens, abrir e encerrar atendimentos, manter contatos e campos
personalizados, trabalhar nos painéis do CRM, disparar campanhas e consultar relatórios.

Toda chamada é autenticada por um **token da empresa**, criado no painel com as permissões de cada
módulo e método. Um token que só tem `GET` em contatos consegue ler contatos e nada além disso.

<CardGroup cols={2}>
  <Card title="Primeira chamada" icon="rocket" href="/quickstart">
    Crie o token e receba sua primeira resposta em poucos minutos.
  </Card>

  <Card title="Autenticação" icon="key" href="/authentication">
    Formato do token, header e o que faz a API responder 401.
  </Card>

  <Card title="Permissões" icon="shield-check" href="/essentials/permissoes">
    Como o token libera cada módulo e cada método.
  </Card>

  <Card title="Referência" icon="code" href="/api-reference/introduction">
    Os 150 endpoints, com corpo da requisição, resposta e exemplos prontos para executar.
  </Card>
</CardGroup>

## O que dá para fazer

<Columns cols={2}>
  <Card title="Conversas" icon="message-square">
    Envie texto, mídia, template e mensagem interativa. Abra, transfira, encerre e qualifique
    atendimentos.
  </Card>

  <Card title="Cadastros" icon="users">
    Contatos com campos personalizados, tags, filas, tipos de qualificação, respostas rápidas e
    usuários da empresa.
  </Card>

  <Card title="CRM e produtos" icon="kanban">
    Painéis, etapas, cards, histórico e anotações. Catálogo de produtos com categorias e
    desempenho em vendas.
  </Card>

  <Card title="Campanhas e dados" icon="chart-column">
    Disparos em massa com controle de execução, além de relatórios de conversas, automações e
    dashboards.
  </Card>
</Columns>

## Como a API se comporta

Três regras valem para todos os endpoints. Conhecer essas regras antes da primeira integração
ajuda a entender a maior parte das respostas que você vai receber.

<AccordionGroup>
  <Accordion title="A empresa vem do token, nunca do corpo" icon="building">
    O token pertence à empresa, e não a um usuário. Se você enviar `companyId` no corpo ou na
    query, o valor é ignorado e a API usa sempre a empresa do token. A regra vale também para os
    endpoints que aceitam esse campo por compatibilidade.
  </Accordion>

  <Accordion title="Toda lista é paginada" icon="list">
    Todo endpoint de lista é paginado. O `meta` traz apenas `page`, `perPage` e `hasMore` e não
    informa o total de registros. Para saber se existe outra página, use `hasMore`. Veja
    [Paginação](/essentials/paginacao).
  </Accordion>

  <Accordion title="Envio de mensagem é assíncrono" icon="clock">
    `POST /messages` responde `202` com um `jobId` e faz o envio em segundo plano. O resultado
    fica disponível em `GET /messages/jobs/{jobId}`. Veja
    [Enviar mensagens](/guides/enviar-mensagens).
  </Accordion>
</AccordionGroup>

## Antes de começar

<Note>
  Para criar tokens, você precisa de um usuário **administrador** da empresa. Atendentes não veem
  o menu Integrações.
</Note>

A URL base é:

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

Instalações próprias (on-premise) usam o domínio do próprio ambiente, seguido de `/api/v1`.


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