Skip to main content
GET
/
api
/
v1
/
customers
Listar clientes
curl --request GET \
  --url https://besimplo.com/api/v1/customers \
  --header 'Authorization: <api-key>'
{
  "object": "list",
  "url": "/api/v1/customers",
  "has_more": false,
  "data": [
    {
      "id": "cus_01h455vb4pex5vsknk084sn02q",
      "object": "customer",
      "live_mode": true,
      "created": 1680893993,
      "name": "João Silva",
      "external_code": "01953808-3a3a-712f-99ce-f6943c8141db",
      "identifier": "123.456.789-00",
      "email": "joao.silva@exemplo.com",
      "phone": "+5511999998888",
      "description": "individual",
      "address": {
        "zip_code": "12345012",
        "street": "Alguma Rua",
        "number": "9934",
        "district": "D'algum Bairro",
        "city": "Campinas",
        "state": "SP",
        "complement": "Apt. 123"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

A chave de API usada para autenticar a requisição e identificar a sua conta.

Exemplo: Authorization: ApiKey my-secure-key

Query Parameters

​
email
string<email>

Filtrar por e-mail do cliente

​
limit
integer
default:20

Resultados por página

Required range: 1 <= x <= 100
​
page
string

Cursor para próxima página

Response

Lista de clientes

​
object
enum<string>
required

Tipo do objeto. Sempre 'list'.

Available options:
list
Example:

"list"

​
url
string<uri-reference>
required

URL do recurso solicitado.

Example:

"/api/v1/customers"

​
has_more
boolean
required

Indica se há mais resultados disponíveis para paginação.

Example:

false

​
data
object[]
required

Lista de clientes.