Documentação da API

Localizado em Configurações, na categoria Avançado (visível para administradores).

A Documentação da API é a referência completa para você integrar o SimplesDesk a sistemas externos: criar conversas e contatos, enviar mensagens, consultar relatórios e automatizar praticamente tudo o que é feito pela interface.

👉 Acesse agora: Documentação oficial da API → — a referência completa, com todos os endpoints e exemplos prontos para testar.

Acessando a documentação

1. Vá em Configurações (ícone de engrenagem no menu lateral).
2. Na categoria Avançado, clique no card Documentação da API.
3. A referência abre em uma nova aba, no endereço /api/swagger da sua plataforma.

Na página você encontra todos os endpoints organizados por recurso (Conversas, Contatos, Mensagens, Times, Etiquetas e muito mais), com os parâmetros aceitos, exemplos de requisição e de resposta — e pode testar as chamadas diretamente pela própria página.

Autenticação: o Token de Acesso

Toda requisição à API precisa ser autenticada com o seu token de acesso pessoal, enviado no cabeçalho api_access_token:

curl --request GET \
  --url https://chat.simplesdesk.com.br/api/v1/accounts/SEU_ID_DA_CONTA/conversations \
  --header 'api_access_token: SEU_TOKEN'

A URL base é sempre o mesmo endereço em que você acessa a plataforma (https://chat.simplesdesk.com.br) — troque apenas SEU_ID_DA_CONTA e SEU_TOKEN. Com o token válido, essa chamada devolve as conversas da conta em JSON; sem ele, a API responde 401 – Invalid Access Token.

Para localizar (ou renovar) o seu token:

1. Clique na sua foto de perfil, no canto inferior esquerdo, e depois em Configurações do Perfil.
2. Abra a aba Segurança.
3. Na seção Token de acesso, use Copiar para copiar o token ou Reiniciar para gerar um novo (o antigo deixa de funcionar imediatamente — atualize suas integrações).

Dicas importantes

• O token herda as permissões do seu usuário: token de administrador acessa tudo; token de agente enxerga apenas o que o agente enxerga.
• Trate o token como uma senha: não o compartilhe nem o exponha em códigos públicos.
• O ID da conta, usado nas URLs, está em Configurações → Configurações da Conta → aba Geral.