Programs

List program members

Changed on

Returns a cursor-paginated list of members of the program. Deleted members are omitted. 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

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/programs/{programId}/members
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or HTTP bearer

Query parameters

limitinteger nullable

Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.

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

Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.

cursorstring nullable

Continues pagination. Pass the cursor.next value from a previous response. Format lcrsmbr_[a-f0-9]+. The cursor matches the filters and order of that response.

junction'AND' | 'OR' nullable

Joins the field filters. Allowed values are AND and OR. Defaults to AND.

Filters the results. Pass a deep object, for example filters[status][conditions][$is]=ACTIVE. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.

Response

Cursor-paginated list of members.

object'list' required

Object type marker, always list.

Changes

  • v26a418ac8b7b1Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added to the response body allOf list for the response status

  • v2f95b50556c93Revision changes
    • info

      removed from the response body allOf list for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status