v18

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

List program members

<Warning>

<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 members of the program. Results can be filtered by id, status, customer_id and created_at, and ordered by created_at, status or customer_id (ascending or descending). The same field cannot be ordered both ascending and descending at the same time. Returns 404 when the program does not exist.

List items do not include the cards array - use the get-member endpoint to retrieve a member with cards.

get/v2/loyalties/programs/{programId}/members

Path parameters

programIdstring required

Loyalty program ID (format lprg_[a-f0-9]+).

Query parameters

limitinteger nullable

Maximum number of members to return. Must be between 1 and 100. Defaults to 10 when not provided.

string[]
OR
'-created_at' | 'created_at' | 'status' | '-status' | 'customer_id' | '-customer_id'

Field(s) to order results by. Prefix with - for descending order. Accepts a single value or an array of values. Defaults to -created_at. Ordering by the same field in both directions simultaneously is rejected.

cursorstring nullable

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

junction'AND' | 'OR' nullable

How multiple field filters are combined. Defaults to AND.

Field-specific filter conditions, passed as a deep object, e.g. filters[status][conditions][$is]=ACTIVE. See the MemberListFilters schema for available fields and conditions.

Response

Cursor-paginated list of members.

object'list' required

Object type marker, always list.