Programs

Get program member

<Info>

<Badge color="gray">Documentation in progress</Badge>

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

</Info>

Returns a single member of the program together with all its loyalty cards. Each card includes the current balance, lifetime bucket counters, and next expiration/activation info.

Card code may be null shortly after member creation because card code generation is asynchronous.

Returns 404 when the program or member does not exist.

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

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

Changed in 4 of the 62 revisions of this API.10613

    • deleted the path request parameter memberId

      request-parameter-removed

    • deleted the path request parameter programId

      request-parameter-removed

    • removed the non-success response with the status

      response-non-success-status-removed

    • removed the non-success response with the status

      response-non-success-status-removed

    • 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

    • response property allOf[subschema #2]/cards list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • removed the required property //// from the response with the status

      response-required-property-removed

  • v2341403eb19e5946See the full diff
    • added the pattern ^lmbr_[a-f0-9]+$ to the path request parameter memberId

      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

    • response property allOf[subschema #2]/cards list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • 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 getMember removed and replaced with getProgramMember

      api-operation-id-removed

    • added to the response body allOf list for the response status

      response-body-all-of-added

    • removed from the response body allOf list for the response status

      response-body-all-of-removed

    • 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

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