Pular para o conteúdo principal
GET
Listar números

Autorizações

Authorization
string
header
obrigatório

Autentique com uma chave secreta (sk_live_…) ou uma chave restrita (rk_live_…) criada no painel. Chaves restritas só têm as permissões escolhidas na criação, como messages:send, chats:read ou broadcasts:send.

Cabeçalhos

Blu-Version
string

A versão da API a usar. Por padrão, é a versão fixada na sua conta.

Exemplo:

"2026-10-11"

Parâmetros de consulta

limit
integer
padrão:10

Quantos objetos devolver, de 1 a 100.

Intervalo obrigatório: 1 <= x <= 100
starting_after
string

O id de um objeto. Devolve a página depois dele.

ending_before
string

O id de um objeto. Devolve a página antes dele.

expand[]
string[]

Campos a expandir em objetos completos, como contact, ou data.contact em listas.

platform_type
enum<string>

A plataforma do número. Hoje, todos os números usam a API do WhatsApp Cloud, da Meta.

Opções disponíveis:
cloud_api
status
enum<string>

pending_link nunca foi conectado. connecting está conectando ou reconectando. connected pode enviar e receber. disconnected foi desconectado e precisa ser conectado de novo.

Opções disponíveis:
pending_link,
connecting,
connected,
disconnected

Resposta

Uma lista de números.

object
string
obrigatório
Allowed value: "list"
data
object[]
obrigatório
has_more
boolean
obrigatório
url
string
obrigatório
Exemplo:

"/v1/chats"