HSDesk APIHSDesk / API Pública
ReferenciaEntrada (v1)

Listar tickets

GET
/api/v1/tickets

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

prioridade?string

Value in

  • "baixa"
  • "media"
  • "alta"
  • "urgente"
numero?integer
busca?string
por_pagina?integer
Rangevalue <= 100

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/tickets"
{  "success": true,  "message": "Tickets listados.",  "data": {    "data": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "numero": 1024,        "assunto": "Erro no checkout",        "descricao": "O pagamento falha ao finalizar.",        "prioridade": "alta",        "canal_origem": "api",        "status": {          "nome": "Em andamento",          "categoria": "em_andamento",          "cor": "string"        },        "solicitante": {          "nome": "Maria Cliente",          "email": "string",          "telefone": "+55 11 98888-7777",          "external_id": "string"        },        "external_id": "TCK-9001",        "origem_sistema": "api",        "criado_em": "2019-08-24T14:15:22Z",        "atualizado_em": "2019-08-24T14:15:22Z",        "resolvido_em": "2019-08-24T14:15:22Z",        "respostas": [          {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "mensagem": "Já estamos verificando.",            "origem": "agente",            "editado": false,            "autor": {              "tipo": "agente",              "nome": "Ana Atendente",              "email": "string",              "external_id": "string"            },            "criado_em": "2019-08-24T14:15:22Z"          }        ]      }    ],    "total": 42,    "por_pagina": 25,    "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."  }}

Entrega e retries

Como o HSDesk entrega os webhooks, a política de retentativas e o log de entregas para depurar.

Criar ticket POST

Cria um ticket em nome de um solicitante (que vira/atualiza um Contato). Idempotente por external_id: reenviar o mesmo external_id devolve o ticket já existente (HTTP 200) em vez de duplicar. Sem external_id, cada chamada cria um novo ticket.