Customers
List customers
selectkey<token>
API key para requisições autenticadas. Envie sua chave no cabeçalho selectkey (sandbox sk_test_…, produção sk_live_…).
In: header
Query Parameters
limit?integer
offset?integer
sort?string
Sort expression, e.g. "-createdAt"
daterange?|
daterangegt?string
daterangegte?string
daterangelt?string
daterangelte?string
id?string
Public identifier (cus_…)
email?string
name?string
telephoneline?string
document?string
externalreference?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/customers"{
"offset": 0,
"limit": 0,
"total": 5000,
"page": {
"offset": {
"first": 0,
"prev": 0,
"next": 0,
"last": 0
},
"current": 0,
"total": 5000
},
"hasMore": true,
"data": [
{
"id": "cus_0a1b2c3d4e5f60718293",
"firstName": "João",
"lastName": "Silva",
"email": "[email protected]",
"document": {
"type": "cpf",
"number": "string"
},
"telephone": {
"countryCode": "string",
"areaCode": "string",
"number": "string",
"line": "string"
},
"birthdate": "string",
"gender": "string",
"available": true,
"delinquent": true,
"externalReference": "string",
"additionalEmails": [
"string"
],
"metadata": {},
"createdAt": "string",
"updatedAt": "string",
"merchant": {
"name": "Acme Ltda",
"merchantId": "string",
"isSubAccount": true
},
"_links": {}
}
],
"merchant": {
"name": "Acme Ltda",
"merchantId": "string",
"isSubAccount": true
},
"_links": {}
}{
"error": {
"status": "Unauthorized",
"statusCode": 401,
"category": "authentication",
"code": "unauthorized",
"message": "Authentication is required to access this resource.",
"resource": "server"
}
}{
"error": {
"status": "Forbidden",
"statusCode": 403,
"category": "authorization",
"code": "forbidden",
"message": "You do not have permission to perform this action.",
"resource": "server"
}
}{
"error": {
"status": "Internal Server Error",
"statusCode": 500,
"category": "server",
"code": "serverError",
"message": "An unexpected error occurred. Please try again later.",
"resource": "server",
"details": "If the problem persists, contact support with the correlationId from the response headers."
}
}