Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Loyalties

List Loyalty Campaign Transactions

Retrieves all transactions for the campaign with the given campaign ID or campaign name.

get/v1/loyalties/{campaignId}/transactions

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.

order'id' | '-id'

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

starting_after_idstring

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

junction'and' | 'or'

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.

Filters for listing responses. The id filter denotes the unique transaction identifier.

Response

Returns a dictionary with a data property that contains an array of transactions. The maximum number of transactions returned is determined by the limit query parameter. Each entry in the array is a separate transaction object. If more results are available, the has_more flag has value true and the value of the more_starting_after property can be used to retrieve another page of results.

object'list' required

The type of the object represented by JSON.

data_ref'data' required

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

has_moreboolean required

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.