ApiContatos
Listar
Authorization
api-key AuthorizationBearer <token>
Insira seu token de acesso abaixo. No Swagger: Não é necessário digitar "Bearer " antes do token, o sistema adiciona automaticamente.
Na API: As requisições devem incluir o header.
Exemplo: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
In: header
Query Parameters
tagId?string
isGroup?boolean
status?string
Value in
"ACTIVE" | "ARCHIVED"phoneNumber?string
Can be E.164 (+551153...) or WhatsApp ID (123456...@g.us)
name?string
Filter by exact contact name
idNumber?string
Filter by document (CPF/CNPJ)
birthday?string
Filter by birthday (YYYY-MM-DD)
instagram?string
Filter by Instagram username
email?string
Filter by exact email
idType?string
Filter by document type
Value in
"CPF" | "CNPJ"limit?number
1-200, default 50
Default
50Range
1 <= value <= 200cursor?string
Opaque pagination cursor
Response Body
application/json
curl -X GET "https://core.beemessage.app/v1/contacts"{
"success": true,
"data": {
"items": [
{
"id": "cont_abc123xyz",
"projectId": "prj_demo999",
"fullName": "João Silva",
"phoneE164": "+5511999999999",
"tags": [],
"email": "joao.silva@exemplo.com.br",
"idNumber": "12345678900",
"birthday": "1990-01-01",
"instagram": "@joaosilva_demo",
"isGroup": false,
"sequenceIds": [],
"createdAt": "2026-03-10T23:49:38.013Z"
},
{
"id": "cont_def456uvw",
"projectId": "prj_demo999",
"fullName": "Grupo Projeto VIP",
"phoneE164": "120363000000000000@g.us",
"tags": [],
"email": null,
"idNumber": null,
"birthday": null,
"instagram": null,
"isGroup": true,
"sequenceIds": [],
"createdAt": "2026-02-27T23:33:59.444Z"
}
],
"pageInfo": {
"nextCursor": null,
"hasNextPage": false
}
}
}Empty