v1

latestOpenAPI 3.0.02026-07-26253547.8 KB

Contacts

Consultar conversas / contatos

Lista conversas individuais do workspace.

get/v1/contacts

Query parameters

numberstring

Example:5511999999999

Filtrar por número de telefone

connectionstring

Example:aaaaaaaa-bbbb-cccc-dddd-111111111111

Filtrar por ID da conexão

idstring uuid

Example:1cbcb7a8-8bf6-4016-8ed5-8ea38c4a9a05

UUID do chat/contato (Chat.id) — filtra no máximo um registro

createdAfterstring

Example:2026-01-01T00:00:00Z

Filtrar contacts criados após esta data (ISO 8601)

createdBeforestring

Example:2026-12-31T23:59:59Z

Filtrar contacts criados antes desta data (ISO 8601)

modifiedAfterstring

Example:2026-01-01T00:00:00Z

Filtrar contacts modificados após esta data (ISO 8601)

modifiedBeforestring

Example:2026-12-31T23:59:59Z

Filtrar contacts modificados antes desta data (ISO 8601)

statusstring

Example:aaaaaaaa-bbbb-cccc-dddd-111111111111

Filtrar por ID do status (UUID)

stage'Open' | 'Closed' | 'Pending'

Filtrar por estágio do ticket

hasUnreadboolean

Example:true

Filtrar contacts com mensagens não lidas (true/false)

departmentstring

Example:aaaaaaaa-bbbb-cccc-dddd-111111111111

Filtrar por ID do departamento (UUID)

tagsstring

Example:aaaaaaaa-bbbb-cccc-dddd-111111111111

Filtrar por tag(s) — UUIDs separados por vírgula

pagenumber

Example:1

Página (começa em 1, padrão: 1)

limitnumber

Example:20

Itens por página (padrão: 20, máximo: 100)

Response

Lista de conversas retornada com sucesso

Example response

{
  "contacts": [
    {
      "id": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
      "contactNumber": "5511999999999",
      "contactName": "João Silva",
      "department": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
      "status": "cccccccc-cccc-cccc-cccc-cccccccccccc",
      "source": "dddddddd-dddd-dddd-dddd-dddddddddddd",
      "connection": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
      "agent": "ffffffff-ffff-ffff-ffff-ffffffffffff",
      "user": "11111111-2222-3333-4444-555555555555",
      "ticketStatus": "open",
      "createdAt": "2026-04-16T15:30:00.000Z",
      "integration": "WHATSAPP-NON-OFFICIAL",
      "lastInteraction": "2026-04-16T14:00:00.000Z",
      "tags": [
        "aaaaaaaa-bbbb-cccc-dddd-111111111111"
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 154,
    "totalPages": 8,
    "hasNextPage": true
  }
}