Skip to main content
GET
List program earning rule assignments

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required

Path Parameters

​
programId
string
required

Identifies the loyalty program. Format lprg_[a-f0-9]+.

Pattern: ^lprg_[a-f0-9]+$

Query Parameters

​
limit
default:10

Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.

Required range: 1 <= x <= 100
​
order

Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.

Available options:
-created_at,
created_at
​
cursor
string | null

Continues pagination. Pass the cursor.next value from a previous response. Format lcrserna_[a-f0-9]+. The cursor matches the filters and order of that response.

Pattern: ^lcrserna_[a-f0-9]+$

Response

Paginated list of earning rule assignments.

Response body schema for GET /v2/loyalties/programs/{programId}/earning-rules.

​
object
string
required

Object type marker. Always list.

Allowed value: "list"
​
data
object[]
required

Earning rule assignments on the current page.

​
cursor
object | null
required

Pagination cursor. null when there are no more results.