---
title: "Listar clientes"
method: GET
path: "/api/v1/customers"
tags: ["Clientes"]
---

# Listar clientes

`GET /api/v1/customers`

## Query parameters

- `name` string
- `email` string
- `cpfCnpj` string
- `externalReference` string
- `asaasId` string
- `page` integer
- `size` integer

## Response `200`

OK

- PageCustomerOutput
  - `totalElements` integer
  - `totalPages` integer
  - `last` boolean
  - `pageable` PageableObject
    - `paged` boolean
    - `unpaged` boolean
    - `pageSize` integer
    - `pageNumber` integer
    - `offset` integer
    - `sort` SortObject[]
      - `direction` string
      - `nullHandling` string
      - `ascending` boolean
      - `property` string
      - `ignoreCase` boolean
  - `numberOfElements` integer
  - `first` boolean
  - `size` integer
  - `content` CustomerOutput[]
    - `name` string, required — Nome do cliente.
    - `cpfCnpj` string, required — CPF ou CNPJ do cliente.
    - `email` string — Email do cliente.
    - `phone` string — Fone fixo.
    - `mobilePhone` string — Fone celular.
    - `billingAddress` BillingAddress — Endereço de cobrança do cliente.
      - `postalCode` string, required — CEP do endereço.
      - `address` string, required — Logradouro.
      - `addressNumber` string, required — Número do endereço.
      - `complement` string — Complemento do endereço.
      - `province` string, required — Bairro.
      - `cityName` string, required — Cidade.
      - `stateAbbrev` string, required — Sigla do estado.
      - `country` string, required — Nome do País.
    - `deliveryAddress` DeliveryAddress — Endereço de entrega do cliente.
      - `postalCode` string, required — CEP do endereço.
      - `address` string, required — Logradouro.
      - `addressNumber` string, required — Número do endereço.
      - `complement` string — Complemento do endereço.
      - `province` string, required — Bairro.
      - `cityName` string, required — Cidade.
      - `stateAbbrev` string, required — Sigla do estado.
      - `country` string, required — Nome do País.
      - `name` string — Nome do recebedor da mercadoria.
      - `cpfCnpj` string — CPF ou CNPJ do recebedor da mercadoria.
      - `email` string — Email do recebedor da mercadoria.
      - `phone` string — Fone do recebedor da mercadoria.
    - `taxInformation` TaxInformation — Informações fiscais.
      - `stateInscription` string — Inscrição estadual do cliente.
      - `municipalInscription` string — Inscrição municipal do cliente.
      - `typeOfTaxPayer` 'CONTRIBUINTE_ICMS' | 'CONTRIBUINTE_ISENTO' | 'NAO_CONTRIBUINTE' — Tipo de Contribuinte.
      - `finalConsumer` boolean — Consumidor Final.
      - `simpleTax` boolean — Optante pelo simples nacional.
      - `ruralProducer` boolean — Produtor rural.
    - `externalReference` string — Identificador único do cliente no seu sistema.
    - `observations` string — Observações adicionais.
    - `id` integer — Identificador único do cliente no Base.
    - `deleted` boolean — Cliente excluido True/False
    - `asaasId` string — Identificador único do cliente no Asaas.
  - `number` integer
  - `sort` SortObject[]
    - `direction` string
    - `nullHandling` string
    - `ascending` boolean
    - `property` string
    - `ignoreCase` boolean
  - `empty` boolean

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.dev/baseerp/apis/api-base-by-asaas.md) · [All operations](https://skmtc.dev/baseerp/apis/api-base-by-asaas/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/baseerp/api-base-by-asaas/revisions/408ce44b0d29/schema)