List members

⚠️ BETA endpoint

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

Lists members of a program with optional filtering and cursor-based pagination. Supports filtering by id, status, customer_id, and created_at.

GET /v2/loyalties/programs/{programId}/members

List members

cURL

curl --request GET \
  --url https://api.voucherify.io/v2/loyalties/programs/{programId}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "program_id": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "object": "<string>"
    }
  ],
  "cursor": {
    "next": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "object": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

programId · string · required

Unique program identifier

Query Parameters

limit · integer · default: 10

Number of results to return (1-100, default 10)

Required range: 1 <= x <= 100

order · enum<string> string[]

Sort order for results

Available options: -created_at, created_at, status, -status, customer_id, -customer_id

cursor · string

Cursor token for pagination (from previous response)

filters[junction] · enum<string>

Logical junction for combining filters

Available options: AND, OR

filters[id][conditions][$is] · string

Filter by exact member ID

filters[id][conditions][$in] · string[]

Filter by member ID in list

Maximum array length: 100

filters[status][conditions][$is] · enum<string>

Filter by exact status

Available options: ACTIVE, INACTIVE

filters[status][conditions][$in] · enum<string>[]

Filter by status in list

Available options: ACTIVE, INACTIVE

filters[customer_id][conditions][$is] · string

Filter by exact customer ID

filters[customer_id][conditions][$in] · string[]

Filter by customer ID in list

Maximum array length: 100

filters[created_at][conditions][$before] · string<date>

Filter by created_at before date (ISO 8601)

filters[created_at][conditions][$after] · string<date>

Filter by created_at after date (ISO 8601)

Response

200

application/json

List of members

data · object[]

Show child attributes

cursor · object | null

Cursor for fetching the next page of results.

Show child attributes

object · string

Allowed value: "list"