List loyalty programs
Retrieve the loyalty programs of your organization with optional filtering, search and pagination.
Endpoint
GET/loyalty-programs
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | number | No | ID of your organization. Optional: results are always filtered to the API key's organization. |
status | string | No | Filter by status: draft, active, paused or archived |
type | string | No | Filter by type: stamps, points, cashback, membership or gift_card |
slug | string | No | Filter by the program link name |
search | string | No | Case-insensitive search on the program name and slug |
$limit | number | No | Number of programs to return (default: 10, max: 50) |
$skip | number | No | Number of programs to skip (for pagination) |
$sort | object | No | Sort criteria, e.g. $sort[created_at]=-1 for newest first |
Request
Response
json
Each item contains every field of the Loyalty Program object (the example above is shortened).
Report an issue with this documentation
Please log in to report issues with our documentation.