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

# List customers

`GET /customers`

Used to fetch a paginated list of one or more Customers

## Query parameters

- `email` string
- `startTimestamp` integer
- `endTimestamp` integer
- `ascending` boolean
- `limit` integer
- `startsAfter` string

## Response `200`

Successfully retrieved the customers

- Customers
  - `items` Customer[]
    - `id` string — The ID of the customer
    - `email` string, email — The customer's email address
    - `firstName` string, nullable — The first name of the customer
    - `lastName` string, nullable — The last name of the customer
    - `homePhoneNumber` string, nullable — The home phone number of the customer. In E.164 format
    - `mobilePhoneNumber` string, nullable — The mobile phone number of the customer. In E.164 format
    - `defaultPaymentMethod` string, nullable — The Id of the customer's preferred/default payment method
    - `metadata` object, nullable — use this parameter to attach key-value data to the customer. These will be sent with any associated customer events on your webhooks. You can have a maximum of 5 pieces of metadata.
    - `createdTimestamp` integer — The epoch timestamp (seconds) when the customer was created
  - `paginationToken` string, nullable — A token to use for getting the next page of results - send the same request with this value in the 'paginationToken' query parameter. This field is null when there are no further items to return

## Other responses

- `400` — One or more inputs are invalid
- `500` — An unexpected error occurred when executing this request

---

[API](https://skmtc.net/ryftpay/apis/ryft-payment-api.md) · [All operations](https://skmtc.net/ryftpay/apis/ryft-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ryftpay/ryft-payment-api/revisions/a042f64d4305/schema)