GET
/
v1
/
customers
curl --request GET \
  --url https://api.base39.io/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "id": "cust_5f92f01728e009f403d8502e",
      "document": "<string>",
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "username": "<string>",
      "address": {
        "city": "São Paulo",
        "state": "SP",
        "country": "BR",
        "line1": "Av Paulista",
        "line2": "Sala 404",
        "number": "123",
        "postalCode": "12123123",
        "neighborhood": "Bela Vista"
      },
      "birthDate": "2023-12-25",
      "birthPlace": "<string>",
      "nationality": "AF",
      "gender": "female",
      "publicPerson": true,
      "maritalStatus": "single",
      "motherName": "<string>",
      "additionalDocuments": [
        {
          "type": "<string>",
          "number": "<string>",
          "issuer": "<string>",
          "state": "AC"
        }
      ],
      "attachments": [
        {
          "file": "file_6307b6c39f5d3d917009b631",
          "linkedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string

Filtro no campo id do cliente, aceitando string ou lista separada por vírgula.

​
expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

​
limit
integer
default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

​
document
string

Um filtro com base no campo document. O valor deve ser uma string ou uma lista separada por vírgula

​
email
string

Um filtro com base no campo email. O valor deve ser uma string ou uma lista separada por vírgula

​
phone
string

Um filtro com base no campo phone. O valor deve ser uma string ou uma lista separada por vírgula

​
starting_after
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

​
ending_before
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

​
fields
string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

​
deleted
boolean

Um filtro com base no campo deleted. O valor deve ser um booleano.

Response

200 - application/json
Objeto com `data` contendo array de `Customer` a partir de `starting_after`; vazio se não houver mais itens. Solicitação nunca retorna erro.

Uma lista de clientes.

​
hasMore
boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

​
data
object[]

Uma lista de clientes

Este objeto representa um cliente.