Skip to content
Paywright

List customers

GET
/api/v1/customers
curl --request GET \
  --url https://example.com/api/v1/customers \
  --header 'x-api-key: <x-api-key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
page

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
data
required
Array<object>
object
id
required
string
stripeCustomerId
required
string
email
required
string
name
required
string
nullable
phone
required
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
total
required
number
page
required
number
limit
required
number

Example generated

{
  "data": [
    {
      "id": "example",
      "stripeCustomerId": "example",
      "email": "example",
      "name": "example",
      "phone": "example",
      "createdAt": "2026-04-15T12:00:00Z",
      "updatedAt": "2026-04-15T12:00:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 1
}