Documentação

ReferênciaWhatsApp

Listar conversas de WhatsApp

GET
/whatsapp/conversations
X-API-Key<token>

Chave de API (prefixo nbr_) ou Token de Acesso Pessoal (prefixo pat_)

In: header

Query Parameters

cursor?string

Token opaco de cursor para paginação. Obtido via page_info.end_cursor da resposta anterior.

limit?integer

Número de itens por página.

Range1 <= value <= 100
Default25
triage?string

Value in

  • "pending"
  • "promoted"
  • "dismissed"
number_id?string
party_id?string
lead_id?string

Só as conversas do contato deste lead

mine?boolean

Só as conversas do próprio usuário (exige um token pessoal)

unread?boolean

Só as conversas com mensagens não lidas

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/whatsapp/conversations"
{  "items": [    {      "id": "wac_2jxsy8cc8v0348asy6t1",      "number_id": "string",      "number_display_phone_number": "string",      "party_id": "string",      "contact_wa_id": "string",      "contact_bsuid": "string",      "contact_name": "string",      "triage": "pending",      "lead_id": "string",      "last_inbound_at": "2019-08-24T14:15:22Z",      "last_message_at": "2019-08-24T14:15:22Z",      "last_message": {        "id": "string",        "direction": "inbound",        "type": "string",        "body": "string",        "status": "string",        "occurred_at": "2019-08-24T14:15:22Z"      },      "unread_count": 0,      "last_read_at": "2019-08-24T14:15:22Z",      "opted_out_at": "2019-08-24T14:15:22Z",      "window_open": true,      "window_expires_at": "2019-08-24T14:15:22Z",      "held": true,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "page_info": {    "end_cursor": "string",    "start_cursor": "string",    "has_next_page": true,    "has_previous_page": true  }}
{  "type": "validation",  "title": "Validation Failed",  "status": 400,  "detail": "name is required",  "code": "validation.required",  "instance": "/public/v1/brokers",  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/validation",  "errors": [    {      "field": "name",      "message": "name is required",      "code": "validation.broker.name_required"    }  ]}
{  "type": "unauthorized",  "title": "Authentication Required",  "status": 401,  "detail": "authentication required",  "code": "unauthorized.auth_required",  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/unauthorized"}
{  "type": "forbidden",  "title": "Access Denied",  "status": 403,  "detail": "insufficient permissions",  "code": "forbidden.insufficient_permissions",  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/forbidden"}
{  "type": "rate_limit",  "title": "Rate Limit Exceeded",  "status": 429,  "detail": "rate limit exceeded",  "code": "rate_limit.exceeded",  "retry_after": 60,  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/rate-limit"}
{  "type": "internal",  "title": "Internal Server Error",  "status": 500,  "detail": "an unexpected error occurred",  "code": "internal.unexpected",  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/internal"}