Rewards

List rewards v2

Changed on
<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. Results can be filtered by id, name, type and created_at, and ordered by created_at or name (ascending or descending). The same field cannot be ordered both ascending and descending at the same time.

get/v2/loyalties/rewards

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/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' | 'name' | '-name'

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 lcrsrew_[a-f0-9]+. The cursor matches the filters and order of that response.

junction'AND' | 'OR' nullable

Joins the field filters. Allowed values are AND and OR. Defaults to AND.

Filters the results. Pass a deep object, for example filters[name][conditions][$contains]=gift. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.

Response

Cursor-paginated list of rewards.

object'list' required

Object type marker; always list.

Example response

{
  "data": [
    {
      "validity_hours": {
        "daily": [
          {
            "start_time": "09:00",
            "end_time": "17:00"
          }
        ]
      }
    }
  ]
}

Changes

  • v2ec801ade260dRevision changes
    • breaking

      for the query request parameter limit, the type changed from integer null to number string null

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required 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

  • v2f95b50556c93Revision changes
    • breaking

      for the query request parameter limit, the type changed from number string null to integer null

    • info

      removed from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status