List Earning Rules

GET/v1/loyalties/{campaignId}/earning-rules

Use it in a workflow

Add a step and choose the Voucherify connector.
Pick the List Earning Rules action (under Loyalties).
Fill in the fields below, then reference the result from later steps as {{listEarningRules.response.data}}.

Request

Path parameters

campaignIdstringrequired

The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.

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.

pageinteger

Which page of results to return. The lowest value is `1`.

orderstring

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

One ofcreated_at-created_atupdated_at-updated_at

Response

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

objectstring

The type of the object represented by JSON. This object stores information about earning rules in a dictionary.

One oflistDefault "list"

data_refstring

Identifies the name of the attribute that contains the array of earning rule objects.

Default "data"

dataarray<any>

Contains array of earning rule objects.

totalinteger

Total number of earning rule objects.

json

{
  "object": "list",
  "data_ref": "data",
  "data": [
    null
  ],
  "total": 0
}

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

Was this page helpful?