Gates2b
Clientes

Consultar cliente

Devolve um cliente da conta pelo id, com documento, e-mail e telefone mascarados.

GET
/customer/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

Chave de API da conta: Authorization: Bearer <chave de API>.

Path Parameters

id*string

Id do cliente.

Response Body

O cliente.

application/json
  1. response

Cliente da conta. taxID, email e phone vêm mascarados; o endereço vem em campos separados (addressZipcode, addressStreet…).

id?string

Id do cliente (ULID). É o valor de customerId em Criar assinatura.

name?string
taxID?|

CPF/CNPJ mascarado (três primeiros e dois últimos dígitos).

email?|

E-mail mascarado (dois primeiros caracteres e domínio).

phone?|

Telefone mascarado (dois primeiros e dois últimos dígitos).

addressZipcode?string|null
addressStreet?string|null
addressNumber?string|null
addressNeighborhood?string|null
addressCity?string|null
addressState?string|null
addressComplement?string|null
addressCountry?string|null
status?CustomerStatus

ACTIVE ou BLOCKED (bloqueado por você).

Valores aceitos"ACTIVE""BLOCKED"
customerIdentityId?|

Preenchido quando o cliente cria acesso ao portal do assinante. null até lá.

invitedAt?|

Quando o convite foi emitido (modo B).

Formatodate-time
activatedAt?|

Quando o cadastro ficou completo. No modo A, na criação.

Formatodate-time
createdAt?string
Formatodate-time
updatedAt?string
Formatodate-time
Example Request
curl -X GET 'https://api.gates2b.com/customer/string'
Example Response
{  "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"}

taxID, email e phone vêm mascarados; o endereço vem completo, em campos separados (addressZipcode, addressStreet…). Responde 404 se o cliente não existe ou é de outra conta.