---
title: "List customers"
method: GET
path: "/platform/v1/customers"
tags: ["Customers"]
---

# List customers

`GET /platform/v1/customers`

## Request

- Base URL: `https://api.sandbox.bvnk.com`
- URL: `https://api.sandbox.bvnk.com/platform/v1/customers`
- Auth: none declared
- TypeScript: <https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/platform/v1/customers/get.ts> (a function with typed inputs; its response is checked against the schema)

:::info Customers API v2
The [new customer onboarding flow](../../../get-started/create-embedded-partner-customer/create-customers-com) is recommended for all new integrations.

If you already have an existing integration with Customers API v1, you can continue using it. BVNK will continue to support this API going forward.
:::

Retrieves the full list of Customers.

## Query parameters

- `page` number
- `size` number
- `name` string

## Response `200`

successful operation

- CustomersPage
  - `content` CustomerOverviewDto[], required
    - `reference` string, uuid, required
    - `status` 'INFO_REQUIRED' | 'PENDING' | 'VERIFIED' | 'REJECTED', required: Current status of the customer. - `INFO_REQUIRED`: Customer information is needed for verification. A related questionnaire code is included in the response. - `PENDING`: Pending customer verification. - `VERIFIED`: Customer has been verified. - `REJECTED`: Verification has been unsuccessful.
    - `type` 'COMPANY' | 'INDIVIDUAL', required: Type of customer
    - `name` string, required: Customer name
    - `description` string: Customer description
  - `page` Page, required
    - `size` integer, required: Page size
    - `totalElements` integer, required: Total elements count
    - `totalPages` integer, required: Pages count, equal to totalElements / size
    - `number` integer, required: Current page number (starts from 0)

## Changes

- **2026-11-06** `c386d436bf2c`: 1 warning
  - added the new `INFO_REQUIRED` enum value to the `content/items/status` response property for the response status `200`

[Operation history](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/changes/platform/v1/customers/get.md)

---

[API](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints.md) - [All operations](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/revisions/c386d436bf2c?raw)