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

# List customers

`GET /v4/customers`

Lists all customers using pagination. The list can be filtered with query params.

## Query parameters

- `email` string
- `phone` string
- `limit` integer
- `orderBy` string[]
- `order` 'asc' | 'desc'
- `beforeCursor` string
- `afterCursor` string

## Response `200`

The paginated list of customers.

- object
  - `metadata` PageMetaDto
    - `total` number, required
    - `beforeCursor` string
    - `afterCursor` string
  - `data` CustomerEntityV4ResponseDto[]
    - `id` string, required — Slope Unique Customer ID
    - `email` string, required — Customer email
    - `businessName` string, required — Customer business name
    - `phone` string, required — Customer phone number
    - `externalId` string, required — External ID

## Other responses

- `400` — Returned when improperly formatted or missing fields in request body
- `401` — Returned when improper keys or headers are used in the request
- `403` — Returned when the caller is not authorized to access the resource
- `500` — Returned when an internal server error occurs

---

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