---
title: "List all customers"
method: GET
path: "/payments/br/customers/"
tags: ["Customers (Brazil)"]
---

# List all customers

`GET /payments/br/customers/`

List all customers associated with your Belvo account.

## Query parameters

- `page` integer
- `page_size` integer
- `id__in` string[]
- `created_at` string, date
- `created_at__gt` string, date
- `created_at__gte` string, date
- `created_at__lt` string, date
- `created_at__lte` string, date
- `created_at__range` string[]
- `customer__type` 'INDIVIDUAL' | 'BUSINESS'
- `external_id` string, uuid
- `external_id__in` string[]
- `search` string

## Headers

- `X-Belvo-API-Resource-Version` 'Payments-BR.V2'

## Response `200`

OK

- object
  - `count` integer — The total number of results in your Belvo account.
  - `next` string, uri, nullable — The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is `null`. In our documentation example, we use `{endpoint}` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, `accounts` or `owners`).
  - `previous` string, uri, nullable — The URL to the previous page of results. If there is no previous page, the value is `null`.
  - `results` union[] — Array of customer objects.
    - union
      - CustomerV2
        - `id` string, uuid, required — Belvo's unique identifier for the current item.
        - `created_at` string, date-time, required — The ISO-8601 timestamp of when the data point was created in Belvo's database.
        - `updated_at` string, date-time, required — The ISO-8601 timestamp of when the data point was updated in Belvo's database.
        - `name` string, required — The full name or business name of the customer.
        - `identifier` string, required — The CPF (11 digits) or CNPJ (14 digits) of the customer.
        - `external_id` string, uuid — An additional unique identifier for the resource for internal purposes. {% admonition type="success" name="Highly Recommended" %} We recommend using this field to store your own unique identifier for each resource (customer, bank account, payment intent, or enrollment). This can be useful for tracking the resource in your system and for debugging purposes. {% /admonition %}
      - CustomerOfpi
        - `id` string, uuid, required — Belvo's unique identifier for the current item.
        - `created_at` string, date-time, required — The ISO-8601 timestamp of when the data point was created in Belvo's database.
        - `created_by` string, uuid, required — The unique ID for the user that created this item.
        - `customer_type` 'INDIVIDUAL' | 'BUSINESS', required — The type of customer. Can be either: - `INDIVIDUAL` - `BUSINESS` (Brazil OFPI only)
        - `name` string, nullable, required — The full name of the customer.
        - `external_id` string, uuid — An additional unique identifier for the resource for internal purposes. {% admonition type="success" name="Highly Recommended" %} We recommend using this field to store your own unique identifier for each resource (customer, bank account, payment intent, or enrollment). This can be useful for tracking the resource in your system and for debugging purposes. {% /admonition %}
        - `country` 'BRA' | 'null', nullable, required — The customer's country of residence. - BRA (🇧🇷 Brazil)
        - `email` string, nullable, required — The customer's email address.
        - `identifier` string, required — The document number of the customer's ID (depending on the `identifier_type`).
        - `identifier_type` 'CPF' | 'CNPJ', required — The customer's ID document type. For Brazil, this can be either: - `CPF` (when `customer_type` is `INDIVIDUAL`) - `CNPJ` (when `customer_type` is `BUSINESS`)
        - `address` string, nullable — The customers physical address.
        - `phone` string, nullable — The customer's phone number.

## Other responses

- `401` — Unauthorized
- `403` — Access to Belvo API denied
- `404` — Not Found Error
- `408` — Request Timeout
- `500` — Unexpected Error

---

[API](https://skmtc.net/belvo/apis/belvo-api-docs.md) · [All operations](https://skmtc.net/belvo/apis/belvo-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/belvo/belvo-api-docs/revisions/3423c786ece5/schema)