---
title: "List customers"
method: GET
path: "/customers"
---

# List customers

`GET /customers`

## Request

- Base URL: `https://api.sandbox.cleeng.com/3.1`
- URL: `https://api.sandbox.cleeng.com/3.1/customers`
- Auth: API key in header `X-Publisher-Token`

This endpoint returns customers that match the requirements given in the API request. For example, it allows you to filter customers based on `externalId` or `email`.<br><br> **Note:** One of the parameters: either `externalId` or `email` is required. <br><br>The recommended limit for checking if a user is registered using an email address is: 1.

## Query parameters

- `offset` integer, required
- `limit` integer, required
- `externalId` string
- `email` string

## Headers

- `Content-Type` string

## Response `200`

200

- object
  - `success` boolean
  - `data` object[]
    - `id` integer
    - `email` string
    - `country` string
    - `regDate` string
    - `lastLoginDate` string
    - `lastUserIp` string
    - `currency` string
    - `locale` string
    - `externalId` string
    - `externalData` object
      - `data` string
  - `message` string

## Other responses

- `422`: Unprocessable Entity

---

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