VOvoucherifyio
Loyalties

List Earning Rules

Returns a list of all earning rules within a given campaign.

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

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/loyalties/{campaignId}/earning-rules
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, loyalties

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.

order'created_at' | '-created_at' | 'updated_at' | '-updated_at'

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

Response

Returns a list of earning rules.

object'list'

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

data_refstring

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

totalinteger

Total number of earning rule objects.

Changes

No recorded changes to this operation across all 1 revision of this API.