Programs

List program activities

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 activities recorded for a program (created, updated, deleted, activated, deactivated and assignment changes). Supports filtering by activity id, type and created_at.

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

Request

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

Query parameters

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[type][conditions][$is]=vl.program.created. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.

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

Response

Paginated list of program activities.

object'list'

Object type marker.

Changes

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

  • v2f95b50556c93Revision changes
    • breaking

      added the new path request parameter programId

    • info

      removed from the response body allOf list for the response 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