Skip to main content
GET
Listar contatos

Authorizations

Authorization
string
header
required

Chave de API no cabeçalho Authorization: Bearer SUA-CHAVE.

A API também aceita x-api-key: SUA-CHAVE e Authorization: ApiKey SUA-CHAVE — as três formas são equivalentes, inclusive para o limite de requisições.

A chave dá acesso total à conta e é de servidor para servidor: não a use em navegador ou aplicativo móvel.

Query Parameters

phone_number_id
string
required

Identificador do seu número de WhatsApp na Meta.

limit
integer
default:20

Quantos contatos trazer. Teto de 100.

Required range: x <= 100
offset
integer
default:0

Quantos pular.

Response

Lista de contatos.

success
boolean
required

Sempre true nas respostas de sucesso.

data
object
required
timestamp
string<date-time>
required