Clientes
Listar clientes
Lista os clientes da conta, do mais recente para o mais antigo, com filtro por status, e-mail e telefone.
GET
apiKeyheader
AuthorizationBearer <token>Chave de API da conta: Authorization: Bearer <chave de API>.
status?stringFiltra pelo status do cliente.
Valores aceitos
"ACTIVE""BLOCKED"email?stringFiltra pelo e-mail exato, sem diferenciar maiúsculas de minúsculas.
Formato
emailphone?stringFiltra pelo telefone exato. Envie só dígitos, com DDI e DDD, como ele é gravado.
limit?integerItens por página. Valores acima de 100 viram 100.
Intervalo
1 <= value <= 100Padrão
50offset?integerQuantos itens pular antes de começar a página.
Intervalo
0 <= valuePadrão
0Página de clientes.
application/json- response
data*array<>total*integerQuantidade de itens nesta página, não o total da conta.
curl -X GET 'https://api.gates2b.com/customer'Example Response
{ "data": [ { "id": "01JB7Z1A2B3C4D5E6F7G8H9J0K", "name": "João da Silva", "taxID": "123******09", "email": "cl*****@example.com", "phone": "55*******99", "addressZipcode": "01310100", "addressStreet": "Avenida Paulista", "addressNumber": "1000", "addressNeighborhood": "Bela Vista", "addressCity": "São Paulo", "addressState": "SP", "addressComplement": "Conjunto 51", "addressCountry": "BR", "status": "ACTIVE", "customerIdentityId": null, "invitedAt": null, "activatedAt": "2026-05-28T12:58:00.000Z", "createdAt": "2026-05-28T12:58:00.000Z", "updatedAt": "2026-05-28T12:58:00.000Z" } ], "total": 1}Exemplo
Encontrar o cliente que já tem um e-mail, por exemplo depois de um 409 em
Cadastrar cliente:
curl "https://api.gates2b.com/customer?email=cliente@example.com" \
-H "Authorization: Bearer $API_KEY"Use o id do item em data como customerId em
Criar assinatura.
Regras
emailbusca o endereço exato, sem diferenciar maiúsculas de minúsculas.phonebusca o número exato como é gravado: só dígitos, com DDI e DDD (5511999999999). Pontuação no filtro não encontra nada.- A página tem 50 itens por padrão e no máximo 100. Avance com
offset. totalé a quantidade de itens desta página, não o total da conta.taxID,emailephonevêm mascarados.