List loyalty programs

Retrieve the loyalty programs of your organization with optional filtering, search and pagination.

Endpoint

GET
/loyalty-programs

Query parameters

NameTypeRequiredDescription
organization_idnumberNoID of your organization. Optional: results are always filtered to the API key's organization.
statusstringNoFilter by status: draft, active, paused or archived
typestringNoFilter by type: stamps, points, cashback, membership or gift_card
slugstringNoFilter by the program link name
searchstringNoCase-insensitive search on the program name and slug
$limitnumberNoNumber of programs to return (default: 10, max: 50)
$skipnumberNoNumber of programs to skip (for pagination)
$sortobjectNoSort 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.