v18

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01934981.1 MB

Earning Rules

List earning rules

<Badge color="yellow">BETA endpoint</Badge>

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

</Warning>

Returns a cursor-paginated list of earning rules. The same field cannot be used in both ascending and descending order at once (e.g. order=name&order=-name is rejected). Default order is -created_at; id is always appended as a tie-breaker.

get/v2/loyalties/earning-rules

Query parameters

limitinteger

Number of items to return. Between 1 and 100, defaults to 10.

'-created_at' | 'created_at' | 'name' | '-name'

string[]

Sort order. A single value or repeated parameter with multiple values. Prefix with - for descending. Allowed values: -created_at, created_at, name, -name. Defaults to -created_at.

cursorstring

Pagination cursor returned in cursor.next of a previous response. Must match the pattern ^lcrsern_[a-f0-9]+$.

junction'AND' | 'OR' nullable

How multiple field filters are combined. Defaults to AND behaviour. Nullable.

Filters as a deep object, e.g. filters[status][conditions][$is]=ACTIVE or filters[name][conditions][$contains]=welcome. See the schema for allowed fields and conditions.

Response

Paginated list of earning rules

object'list'

Object type marker. Always list.