List Campaign Transactions

GET/v1/campaigns/{campaignId}/transactions

Use it in a workflow

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

Request

Path parameters

campaignIdstringrequired

You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.

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.

filtersobject

Filters for listing responses.

junctionstring

Logical Operator Between Filters. Filter by conditions set on the `junction` parameter indicating how the `conditions` should be accounted for in the query. An `AND` is an all-inclusive logical operator, meaning the `AND` operator displays a record if **ALL** the conditions separated by AND are TRUE, while an `OR` operator displays a record if **ANY** of the conditions separated by OR is TRUE.

One ofandor

idobject1 fields

voucher_idobject1 fields

Response

Returns 200 with an object. Read it in later steps with {{listCampaignTransactions.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?