Sign in

v1

latestOpenAPI 3.0.12026-07-24373659.1 KB
Clientes

Listar clientes

get/api/v1/customers

Query parameters

namestring

Nome do cliente.

emailstring

Email do cliente.

cpfCnpjstring

CPF ou CNPJ do cliente.

externalReferencestring

Identificador único do cliente no seu sistema.

asaasIdstring

Identificador único do cliente no Asaas.

pageinteger

Página inicial da lista (0->primeira página).

sizeinteger

Número de elementos da página (max: 100).

Response

OK

totalElementsinteger
totalPagesinteger
lastboolean
numberOfElementsinteger
firstboolean
sizeinteger
numberinteger
emptyboolean

Example response

{
  "content": [
    {
      "name": "John Doe",
      "cpfCnpj": "24971563792",
      "email": "john.doe@asaas.com.br",
      "phone": "4738010919",
      "mobilePhone": "4799376637",
      "billingAddress": {
        "postalCode": "01310000",
        "address": "Av. Paulista",
        "addressNumber": "150",
        "complement": "Sala 201",
        "province": "Centro",
        "cityName": "São Paulo",
        "stateAbbrev": "SP",
        "country": "Brasil"
      },
      "deliveryAddress": {
        "postalCode": "01310000",
        "address": "Av. Paulista",
        "addressNumber": "150",
        "complement": "Sala 201",
        "province": "Centro",
        "cityName": "São Paulo",
        "stateAbbrev": "SP",
        "country": "Brasil",
        "name": "John Doe",
        "cpfCnpj": "24971563792",
        "email": "john.doe@asaas.com.br",
        "phone": "4738010919"
      },
      "taxInformation": {
        "stateInscription": "991234560",
        "municipalInscription": "1234567890000",
        "typeOfTaxPayer": "CONTRIBUINTE_ICMS",
        "finalConsumer": true,
        "simpleTax": true
      },
      "externalReference": "12987382",
      "observations": "ótimo pagador, nenhum problema até o momento",
      "id": 109988777,
      "asaasId": "cus_0001919199"
    }
  ]
}