Sign in

v1

latestOpenAPI 3.1.02026-07-26141236.8 KB
Customers

List customers

Retrieves a list of customers based on a set of provided filters.

get/customers

Query parameters

emailstring

Filter results to only customers with the provided email address.

Filter results to only customers with the provided email address.

state'candidate' | 'member' | 'disabled'

Filter results to only customers with the provided state.

Filter results to only customers with the provided state.

updated_at_minstring date-time

Filter results to only customers updated after the provided date and time.

Example:2024-04-04T15:10:42.030Z

Filter results to only customers updated after the provided date and time.

limitinteger

The maximum number of customers to retrieve.

Example:1

The maximum number of customers to retrieve.

cursorstring

Cursor for the page of customers to retrieve.

Cursor for the page of customers to retrieve.

include'vip_status'

A comma-separated list of related objects to include in the response.

A comma-separated list of related objects to include in the response.

Response

The customers were successfully retrieved.

Example response

{
  "customers": [
    {
      "id": 304169228,
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@doe.com",
      "state": "member",
      "date_of_birth": "1004-05-27",
      "points_balance": 300,
      "referral_url": "http://i.refs.cc/9qr5Pw",
      "vip_tier_id": 426715794,
      "vip_status": {
        "vip_tier_id": 426715794,
        "vip_tier_expires_at": "2026-12-31T23:59:59.999Z",
        "progress_value": 300,
        "current_vip_period_end": "2025-12-31T23:59:59.999Z",
        "next_vip_tier_id": 426715799,
        "delta_to_next_vip_tier": 200
      },
      "created_at": "2024-04-04T15:10:42.030Z",
      "updated_at": "2025-04-04T15:10:42.030Z"
    }
  ],
  "metadata": {
    "next_cursor": "aWQ6MixkaXJlY3Rpb246bmV4dA=="
  }
}