Programs

List member benefit transactions

Changed on

Lists benefit transactions (benefit fulfillments) for a given program member, with cursor-based pagination.

Supports filtering by benefit ID and creation date.

get/v2/loyalties/programs/{programId}/members/{memberId}/benefits/transactions

Request

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

Query parameters

limitinteger nullable

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
'id' | '-id'

Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -id. Newest first. The same field cannot be used in both directions.

cursorstring nullable

Continues pagination. Pass the cursor.next value from a previous response. Format lcrsbtx_[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[benefit_id][conditions][$is]=lben_.... Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.

Response

Paginated list of benefit transactions.

object'list' required

Object type marker. Always list.

Changes

  • v2d29b33490051Revision changes
    • breaking

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

    • 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

    • 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

    • 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

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • info

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

  • v2be14b3318eb3Revision changes
    • breaking

      the ///// response's property type changed from no type to object for 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

    • 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

    • 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

    • info

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

    • info

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

    • info

      removed subschema #2 from the ///// response property allOf list for the response status