Programs

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.
get/v2/loyalties/programs/{programId}/members

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.

Response

Cursor-paginated list of members.

object'list' required

Object type marker, always list.

Changes

Changed in 5 of the 62 revisions of this API.101431

    • the response property ///// became required for the status

      response-property-became-required

  • v245dab307cb4a11See the full diff
    • deleted the path request parameter programId

      request-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

  • v2703a0a42ea4311See the full diff
    • added to the response property oneOf list for the response status

      response-property-one-of-added

    • removed from the response property oneOf list for the response status

      response-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 status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

  • v2341403eb19e591320See the full diff
    • added the pattern ^lcrsmbr_[a-f0-9]+$ to the query request parameter cursor

      request-parameter-pattern-added

    • added the pattern ^lprg_[a-f0-9]+$ to the path request parameter programId

      request-parameter-pattern-added

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • added to the response property oneOf list for the response status

      response-property-one-of-added

    • deleted the query request parameter filters[created_at][conditions][$after]

      request-parameter-removed

    • deleted the query request parameter filters[created_at][conditions][$before]

      request-parameter-removed

    • deleted the query request parameter filters[customer_id][conditions][$in]

      request-parameter-removed

    • deleted the query request parameter filters[customer_id][conditions][$is]

      request-parameter-removed

    • deleted the query request parameter filters[id][conditions][$in]

      request-parameter-removed

    • deleted the query request parameter filters[id][conditions][$is]

      request-parameter-removed

    • deleted the query request parameter filters[junction]

      request-parameter-removed

    • deleted the query request parameter filters[status][conditions][$in]

      request-parameter-removed

    • deleted the query request parameter filters[status][conditions][$is]

      request-parameter-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • api operation id listMembers removed and replaced with listProgramMembers

      api-operation-id-removed

    • added the new optional query request parameter filters

      new-optional-request-parameter

    • query request parameter order list-of-types was widened by adding types null

      request-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 status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • removed from the response property oneOf list for the response status

      response-property-one-of-removed

    • the // response's property pattern ^cust_[a-zA-Z0-9]+ was added for the status

      response-property-pattern-added

    • the // response's property pattern ^lmbr_[a-f0-9]+$ was added for the status

      response-property-pattern-added

    • the // response's property pattern ^lprg_[a-f0-9]+$ was added for the status

      response-property-pattern-added

    This revision also has 292 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog