Referência da APIClientes
Buscar clientes
Filtra por CPF (document) ou nome (search) para reaproveitar em novos pedidos.
Authorization
ApiKey AuthorizationBearer <token>
Chave de API no formato ong_sk_...
In: header
Path Parameters
agencyId*unknown
Agência dentro do escopo da chave
Format
uuidQuery Parameters
page?integer
Página a retornar (começa em 1).
Range
1 <= valueDefault
1limit?integer
Itens por página (máximo 100).
Range
1 <= value <= 100Default
50document?string
CPF a buscar (com ou sem máscara; casa por prefixo).
search?string
Busca por nome do cliente (case-insensitive).
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/agencies/{agencyId}/customers"{ "data": [ { "id": "9b2e6c1a-4f83-4d2b-8a71-2c9e5f0a1b34", "fullName": "string", "document": "string", "email": "string", "phone": "string", "createdAt": "2019-08-24T14:15:22Z" } ], "total": 1, "page": 1, "limit": 50}{ "statusCode": 404, "message": "Pedido não encontrado", "error": "Not Found"}{ "statusCode": 404, "message": "Pedido não encontrado", "error": "Not Found"}