Skip to main content
GET
Listar contatos

Authorizations

Authorization
string
header
required

Token criado em API → Tokens no painel. Prefixo wtx_live_ (ou wtx_test_).

Query Parameters

pageNumber
integer
default:1

Página (1-based).

pageSize
integer
default:40

Itens por página (máx 100). Exceção: GET .../messages usa default 100 e máx 200.

Required range: x <= 100
searchParam
string

Busca por nome ou número (parcial).

number
string

Filtro exato por número (cobre variantes com/sem o 9º dígito BR).

Example:

"5534992341048"

email
string

Filtro parcial por e-mail.

channel
string

Filtro exato por canal.

Example:

"whatsapp"

tagId
string

IDs de tag separados por vírgula. Entra o contato com QUALQUER uma delas. Use GET /v1/tags para descobrir os ids.

Example:

"3,7"

Response

Página de contatos.

requestId
string
count
integer
hasMore
boolean
contacts
object[]