Programs

Get customer memberships

Changed on

Returns loyalty memberships for a customer, including the resolved customer and each membership's member, program, and cards. identification_type chooses how customerId is read. It defaults to customer_id.

customer_id and customer_source_id return every membership for that customer. member_id returns the customer linked to that member and only the membership for that member's program.

Cards omit tier_progress. See Get program membership when you need tier progress.

Returns an empty memberships array when the customer exists and has no memberships. Returns 404 when the customer or member cannot be resolved.

get/v2/loyalties/memberships/{customerId}

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/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

Customer memberships across programs.

object'memberships_result' required

Object type marker. Always memberships_result.

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