List programs
<Info><Badge color="gray">Documentation in progress</Badge>
This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.
</Info>Returns a cursor-paginated list of loyalty programs. Supports filtering by id, name, status and created_at. The same field cannot be used in both ascending and descending order at once.
Query parameters
Filters for the program list. Nested object serialized in the query string (e.g. filters[status][conditions][$is]=ACTIVE). Each field accepts a conditions object with at least one condition. Only the condition operators supported by each field type are allowed.
Maximum number of items to return. Between 1 and 100. Defaults to 10. Non-integer values are rounded.
Sorting order. A single value or an array of values. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both ascending and descending order at once.
Pagination cursor returned by a previous call (cursor.next).
Response
Paginated list of programs.
Changes
Changed in 2 of the 62 revisions of this API.8914
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
- ▲
for the
queryrequest parameterlimit, the type changed fromintegertonumberstringnullrequest-parameter-type-changed
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
added to the
response propertyoneOflist for the response statusresponse-property-one-of-added
- ●
deleted the
queryrequest parameterfilters[created_at][conditions]request-parameter-removed
- ●
deleted the
queryrequest parameterfilters[id][conditions]request-parameter-removed
- ●
deleted the
queryrequest parameterfilters[junction]request-parameter-removed
- ●
deleted the
queryrequest parameterfilters[name][conditions]request-parameter-removed
- ●
deleted the
queryrequest parameterfilters[status][conditions]request-parameter-removed
- ●
removed the optional property
from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
from the response with the statusresponse-optional-property-removed
- ○
added the new optional
queryrequest parameterfiltersnew-optional-request-parameter
- ○
queryrequest parameterorderlist-of-types was widened by adding typesnullrequest-parameter-list-of-types-widened
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
removed from the
response propertyoneOflist for the response statusresponse-property-one-of-removed
This revision also has 292 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲