List program members
Returns a cursor-paginated list of members of the program. Results can be filtered by ID, status, customer ID and creation date. Results can be ordered by creation date, 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 following endpoints to retrieve cards for a given member:
- Get customer memberships,
- Get program member,
- Get program membership.
Query parameters
Maximum number of members to return. Must be between 1 and 100. Defaults to 10 when not provided.
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.
Pagination cursor returned in the cursor.next field of a previous response. Must match the pattern ^lcrsmbr_[a-f0-9]+$.
Field-specific filter conditions, passed as a deep object, e.g. filters[status][conditions][$is]=ACTIVE.
Response
Cursor-paginated list of members.
Changes
Changed in 5 of the 62 revisions of this API.101431
- ○
the response property
/////became required for the statusresponse-property-became-required
- ○
- ●
deleted the
pathrequest parameterprogramIdrequest-parameter-removed
- ○
removed the non-success response with the status
response-non-success-status-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ▲
added to the
response propertyoneOflist for the response statusresponse-property-one-of-added
- ○
removed from the
response propertyoneOflist for the response statusresponse-property-one-of-removed
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
- ▲
added the pattern
^lcrsmbr_[a-f0-9]+$to thequeryrequest parametercursorrequest-parameter-pattern-added
- ▲
added the pattern
^lprg_[a-f0-9]+$to thepathrequest parameterprogramIdrequest-parameter-pattern-added
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
the response property
became optional for the statusresponse-property-became-optional
- ▲
added to the
response propertyoneOflist for the response statusresponse-property-one-of-added
- ●
deleted the
queryrequest parameterfilters[created_at][conditions][$after]request-parameter-removed
- ●
deleted the
queryrequest parameterfilters[created_at][conditions][$before]request-parameter-removed
- ●
deleted the
queryrequest parameterfilters[customer_id][conditions][$in]request-parameter-removed
- ●
deleted the
queryrequest parameterfilters[customer_id][conditions][$is]request-parameter-removed
- ●
deleted the
queryrequest parameterfilters[id][conditions][$in]request-parameter-removed
- ●
deleted the
queryrequest parameterfilters[id][conditions][$is]request-parameter-removed
- ●
deleted the
queryrequest parameterfilters[junction]request-parameter-removed
- ●
deleted the
queryrequest parameterfilters[status][conditions][$in]request-parameter-removed
- ●
deleted the
queryrequest parameterfilters[status][conditions][$is]request-parameter-removed
- ●
removed the optional property
from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
from the response with the statusresponse-optional-property-removed
- ○
api operation id
listMembersremoved and replaced withlistProgramMembersapi-operation-id-removed
- ○
added the new optional
queryrequest parameterfiltersnew-optional-request-parameter
- ○
queryrequest parameterorderlist-of-types was widened by adding typesnullrequest-parameter-list-of-types-widened
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the non-success response with the status
response-non-success-status-added
- ○
the response property
became required for the statusresponse-property-became-required
- ○
the response property
became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
became required for the statusresponse-property-became-required
- ○
removed from the
response propertyoneOflist for the response statusresponse-property-one-of-removed
- ○
the
//response's property pattern^cust_[a-zA-Z0-9]+was added for the statusresponse-property-pattern-added
- ○
the
//response's property pattern^lmbr_[a-f0-9]+$was added for the statusresponse-property-pattern-added
- ○
the
//response's property pattern^lprg_[a-f0-9]+$was added for the statusresponse-property-pattern-added
This revision also has 292 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲