Customers
Obtenha aniversariantes do mês
Retorna lista de contatos com aniversário no mês atual.
Observações importantes:
- Sempre retorna aniversários do mês atual
- Data de nascimento retorna no formato
DD/MM/YYYY - Campos de texto retornam em MAIÚSCULAS
- Paginação funciona normalmente (limit e offset)
- Limit máximo é 1000
Authorization
BearerAuth AuthorizationBearer <token>
In: header
Query Parameters
month?integer
[Optional] Mês para filtrar aniversariantes (1-12).
Range
1 <= value <= 12limit?integer
[Optional] Número máximo de registros a retornar (padrão e máximo: 1000)
Default
1000Range
1 <= value <= 1000offset?integer
[Optional] Número de registros a pular para paginação
Default
0Range
0 <= valueResponse Body
application/json
curl -X GET "https://app.advbox.com.br/api/v1/customers/birthdays"{
"offset": 0,
"limit": 1000,
"totalCount": 2,
"data": [
{
"id": 12345,
"name": "JOÃO SILVA",
"identification": "123.456.789-01",
"document": null,
"cellphone": "(11) 98888-7777",
"gender": null,
"civil_status": null,
"phone": "(11) 3333-4444",
"email": "JOAO@EXAMPLE.COM",
"occupation": "ADVOGADO",
"street": "Rua Exemplo, 123",
"postalcode": "01234-567",
"region": "Centro",
"city": "SÃO PAULO",
"state": "SP",
"country": "BRASIL",
"birthdate": "15/12/1990",
"number_ctps": null,
"number_pis": null,
"number_cid": null,
"notes": "Contato VIP",
"origin": "INDICAÇÃO",
"created_at": "2025-12-01 10:00:00",
"lawsuits": []
}
],
"query": {
"birthdays": true
}
}Empty