Programs

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.

get/v2/loyalties/programs

Query parameters

junction'AND' | 'OR' nullable

Logical junction applied between field filters. Defaults to AND.

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.

number
OR
string

Maximum number of items to return. Between 1 and 100. Defaults to 10. Non-integer values are rounded.

string[]
OR
'-created_at' | 'created_at' | 'name' | '-name'

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.

cursorstring nullable

Pagination cursor returned by a previous call (cursor.next).

Response

Paginated list of programs.

object'list'

Object type marker.

Changes

Changed in 2 of the 62 revisions of this API.8914

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

  • v2341403eb19e5896See the full diff
    • for the query request parameter limit, the type changed from integer to number string null

      request-parameter-type-changed

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • added to the response property oneOf list for the response status

      response-property-one-of-added

    • deleted the query request parameter filters[created_at][conditions]

      request-parameter-removed

    • deleted the query request parameter filters[id][conditions]

      request-parameter-removed

    • deleted the query request parameter filters[junction]

      request-parameter-removed

    • deleted the query request parameter filters[name][conditions]

      request-parameter-removed

    • deleted the query request parameter filters[status][conditions]

      request-parameter-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • added the new optional query request parameter filters

      new-optional-request-parameter

    • query request parameter order list-of-types was widened by adding types null

      request-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 status

      response-optional-property-added

    • removed from the response property oneOf list for the response status

      response-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