curl --request GET \
--url {protocol}://{host}/v2/loyalties/programs/{programId}/members \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"data": [
{
"id": "<string>",
"customer_id": "<string>",
"program_id": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"object": "<string>"
}
],
"cursor": {
"next": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}List program members
⚠️ BETA endpoint
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.
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.
A valid request URL is required to generate request examples{
"data": [
{
"id": "<string>",
"customer_id": "<string>",
"program_id": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"object": "<string>"
}
],
"cursor": {
"next": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Loyalty program ID (format lprg_[a-f0-9]+).
^lprg_[a-f0-9]+$Query Parameters
Maximum number of members to return. Must be between 1 and 100. Defaults to 10 when not provided.
1 <= x <= 100Field(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.
-created_at, created_at, status, -status, customer_id, -customer_id Pagination cursor returned in the cursor.next field of a previous response.
Must match the pattern ^lcrsmbr_[a-f0-9]+$.
^lcrsmbr_[a-f0-9]+$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.
Filters for the members list. Each field accepts a conditions object; multiple
field filters are combined with the junction (default AND).
Show child attributes
Show child attributes
Response
Cursor-paginated list of members.
Cursor-paginated list of members.
Was this page helpful?