List Voucher Transactions

GET/v1/vouchers/{code}/transactions

Use it in a workflow

Add a step and choose the Voucherify connector.
Pick the List Voucher Transactions action (under Vouchers).
Fill in the fields below, then reference the result from later steps as {{listVoucherTransactions.response.data}}.

Request

Path parameters

codestringrequired

A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. `v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u`.

Query parameters

limitinteger

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

orderstring

Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

One ofid-id

starting_after_idstring

A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID.

Response

Returns 200 with an object. Read it in later steps with {{listVoucherTransactions.response.data.<field>}}.

objectstring

The type of the object represented by JSON.

One oflistDefault "list"

data_refstring

Identifies the name of the attribute that contains the array of transaction objects.

One ofdataDefault "data"

dataarray<any>

A dictionary that contains an array of transactions. Each entry in the array is a separate transaction object.

has_moreboolean

As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request (with a different paging or a different start date filter) to get more records returned in the results.

more_starting_afterstring

Returns an ID that can be used to return another page of results. Use the transaction ID in the `starting_after_id` query parameter to display another page of the results starting after the transaction with that ID.

json

{
  "object": "list",
  "data_ref": "data",
  "data": [
    null
  ],
  "has_more": false,
  "more_starting_after": "string"
}

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.

Was this page helpful?