HSDesk APIHSDesk / API Pública
ReferenciaEntrada (v1)

Listar atendentes da organização (nome e foto)

Atendentes ativos, paginados de 10 em 10. Use para exibir nome e avatar no seu sistema.

GET
/api/v1/atendentes

Authorization

hsdeskKey
AuthorizationBearer <token>

HSDesk Key (credencial de aplicação). Envie como Authorization: Bearer <hsk_...> ou Authorization: Basic base64("<hsk_...>:") (chave como usuário, senha vazia).

In: header

Query Parameters

page?integer
Range1 <= value

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/atendentes"
{  "success": true,  "message": "Atendentes listados.",  "data": {    "data": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "nome": "Ana Atendente",        "avatar_url": "https://.../avatar.png?signature=..."      }    ],    "total": 12,    "por_pagina": 10,    "pagina_atual": 1,    "ultima_pagina": 2  },  "errors": []}
{  "success": false,  "message": "Não autenticado.",  "status": 401,  "data": null,  "errors": {    "field": "api_key",    "message": "Credencial inválida ou revogada."  }}

Editar resposta do cliente PATCH

Edita uma resposta enviada antes pelo próprio cliente (origem=cliente_api). Marca `editado: true`. Não é possível editar resposta de atendente nem nota interna.

Listar credenciais da API pública GET

Endpoints de gestão da API Pública, usados pelo painel para gerenciar credenciais e webhooks. Autenticados por JWT do painel com a permissão api_publica:gerenciar (diferente da API v1 de parceiros, que usa HSDesk Key).