Programs

Get program member

Changed on

Returns one member of the program together with that member's loyalty cards. Each card includes balance, lifetime_bucket, next_expiration, and next_activation. tier_progress is not included. Use Get program membership when you need tier progress.

card.code can be null shortly after member creation, while code generation is still running.

Returns 404 when the program doesn't exist, or when the member doesn't exist in that program. The program is checked first.

get/v2/loyalties/programs/{programId}/members/{memberId}

Request

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

Response

The member with its cards.

idstring required

Identifies the member.

customer_idstring required

Identifies the enrolled customer.

program_idstring required

Identifies the loyalty program.

status'ACTIVE' | 'INACTIVE' | 'DELETED' required

Current member status. Allowed values: ACTIVE, INACTIVE, DELETED. INACTIVE members cannot earn points or redeem rewards.

metadataobject required

Stores custom member metadata. Empty object when none is set.

created_atstring date-time required

Records when the member was created (ISO 8601).

updated_atstring date-time nullable required

Records the last update (ISO 8601). null if the member has never been updated.

object'member' required

Object type. Always member.

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