Programs

List program reward assignments

<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 rewards assigned to the program, including their stock configuration and redemption counters.

get/v2/loyalties/programs/{programId}/rewards

Path parameters

programIdstring required

Unique program identifier.

Query parameters

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'

Sorting order. A single value or an array of values. Prefix with - for descending. 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 reward assignments.

object'list'

Object type marker.

Changes

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

    • 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

  • v2341403eb19e51059See 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

    • the // response's property type changed from integer to number for status

      response-property-type-changed

    • the // response's property type changed from integer to object for status

      response-property-type-changed

    • 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

    • removed the optional property from the response with the status

      response-optional-property-removed

    • api operation id listProgramRewards removed and replaced with listProgramRewardAssignments

      api-operation-id-removed

    • 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

    • added the optional property // to the response with the status

      response-optional-property-added

    • added subschema #1 subschema #2 to the // response property allOf list for the response status

      response-property-all-of-added

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

      response-property-one-of-removed

    • added the required property /// to the response with the status

      response-required-property-added

    This revision also has 292 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog