Skip to main content
GET
/
instances
/
{INSTANCE_ID}
/
token
/
{INSTANCE_TOKEN}
/
contacts
Listar Contatos
curl --request GET \
  --url https://api.example.com/instances/{INSTANCE_ID}/token/{INSTANCE_TOKEN}/contacts

Descrição

Retorna a lista de contatos sincronizados com a instância, com suporte a paginação.

Request

Headers

Client-Token: SEU_CLIENT_TOKEN

Query Parameters

CampoTipoObrigatórioDescrição
pagenumberNãoPágina atual (default: 1)
pageSizenumberNãoQuantidade por página (default: 20)

Response

Sucesso (200)

{
  "contacts": [
    {
      "phone": "5511999999999",
      "name": "João Silva",
      "pushName": "João"
    }
  ],
  "total": 500,
  "page": 1
}

Exemplo cURL

curl -X GET 'https://api.bliper.io/instances/{INSTANCE_ID}/token/{INSTANCE_TOKEN}/contacts?page=1&pageSize=20' \
  -H 'Client-Token: SEU_CLIENT_TOKEN'