Programs

List program reward assignments

Changed on

Returns a cursor-paginated list of rewards assigned to the program, including their stock configuration and redemption counters.

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

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/programs/{programId}/rewards
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or HTTP bearer

Query parameters

number
OR
string

Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.

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

Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.

cursorstring nullable

Continues pagination. Pass the cursor.next value from a previous response. Format lcrsrewa_[a-f0-9]+. The cursor matches the filters and order of that response.

Response

Paginated list of reward assignments.

object'list' required

Object type marker. Always list.

Changes

  • v2d050da3a1603Revision changes
    • warning

      deleted the path request parameter programId

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added to the response body allOf list for the response status

    • info

      removed the non-success response with the status

  • v2c56e6909b766Revision changes
    • breaking

      added the new path request parameter programId

    • info

      removed from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status