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

# List all customers

`GET /v1/customers/list`

Retrieve a paginated list of all customers. Filter and search through your customer base.

## Query parameters

- `page_number` number
- `page_size` number

## Response `200`

Successfully retrieved customers

- CustomerListEntity
  - `items` CustomerEntity[], required — List of customer items
    - `id` string, required — Unique identifier for the object.
    - `mode` 'test' | 'prod' | 'sandbox', required — String representing the environment.
    - `object` string, required — String representing the object’s type. Objects of the same type share the same value.
    - `email` string, required — Customer email address.
    - `name` string, nullable — Customer name.
    - `metadata` object, nullable — Additional metadata associated with the customer.
    - `country` string, nullable, required — The ISO 3166-1 alpha-2 country code for the customer.
    - `created_at` string, date-time, required — Creation date of the customer
    - `updated_at` string, date-time, required — Last updated date of the customer
  - `pagination` PaginationEntity, required
    - `total_records` number, required — Total number of records in the list
    - `total_pages` number, required — Total number of pages available
    - `current_page` number, required — The current page number
    - `next_page` number, nullable, required — The next page number, or null if there is no next page
    - `prev_page` number, nullable, required — The previous page number, or null if there is no previous page

## Other responses

- `400` — Bad Request - Invalid input parameters
- `401` — Unauthorized - Invalid or missing API key
- `404` — Not Found - Resource does not exist

---

[API](https://skmtc.net/creem/apis/creem-api.md) · [All operations](https://skmtc.net/creem/apis/creem-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/creem/creem-api/versions/aa593160d96c/schema)