Programs

Get program membership

Changed on

Returns the membership for one customer in the program: the member, the program, and the member's loyalty cards. A card includes tier_progress when its card definition has a tier structure and the member has a tier on that card. Otherwise tier_progress is omitted.

identification_type chooses how customerId is read. It defaults to customer_id.

get/v2/loyalties/programs/{programId}/memberships/{customerId}

Request

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

Query parameters

identification_type'customer_id' | 'customer_source_id' | 'member_id'

Selects how customerId is read. customer_id is the Voucherify customer ID and the default. customer_source_id is the customer's source_id. member_id is the loyalty member ID.

Response

The membership in the program.

object'membership' required

Object type marker, always membership.

Changes

  • v24134cde57cdaRevision 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

    • breaking

      removed the required property ///////////////// from 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

    • info

      added the required property //////////////////// to the response with the status

    • info

      added the required property //////////////////// to the response with the status

  • v20d886da710c9Revision 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

    • breaking

      removed the required property //////////////////// from 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

    • info

      added the required property ///////////////// to the response with the status

    • info

      added the required property ///////////////// to the response with the status