List loyalty programs

⚠️ 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.

Returns a cursor-paginated list of loyalty programs. Supports filtering by id, name, status, and created_at with various conditions.

GET /v2/loyalties/programs

List loyalty programs

cURL

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

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "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

Query Parameters

filters[id][conditions] · object

Filter by program id. Supports conditions $is, $is_not, $in, $not_in.

filters[name][conditions] · object

Filter by program name. Supports conditions $is, $is_not, $contains, $not_contain, $starts_with, $ends_with, $in, $not_in, $has_value, $is_unknown.

filters[status][conditions] · object

Filter by program status. Supports conditions $is, $is_not, $in, $not_in. Values are ACTIVE, INACTIVE, DRAFT.

filters[created_at][conditions] · object

Filter by creation date. Supports conditions $before, $after, $is, $more_than, $less_than, $has_value, $is_unknown.

filters[junction] · enum<string>

Logical junction for combining filters

Available options: AND, OR

limit · integer · default: 10

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

Required range: 1 <= x <= 100

order · enum<string> enum<string>[]

Sort order for results

Available options: -created_at, created_at, name, -name

cursor · string

Cursor for pagination (from previous response)

Pattern: ^lcrsprg_[a-f0-9]+$

Response

200

application/json

Paginated list of programs

data · object[]

Show child attributes

cursor · object | null

Cursor for fetching the next page of results.

Show child attributes

object · string

Allowed value: "list"