# Get member information

This API method is used to fetch all the information for a loyalty member by passing the unique ID of the member.

Endpoint: GET /users/{{memberId}}
Version: 3.0.0
Security: 

## Path parameters:

  - `memberId` (string, required)
    Enter the unique ID of the loyalty member.
    Example: "jacklee2023"

## Response 200 fields (application/json):

  - `Data` (object)
    Displays the following parameters-

  - `Data.siteId` (string)
    Displays Annex Cloud site ID for the loyalty program.
    Example: "29235480"

  - `Data.id` (string)
    Displays the unique ID of the loyalty member.
    Example: "jacklee2023"

  - `Data.email` (string)
    Displays the email address of the loyalty member.
    Example: "jacklee2023@gmail.com"

  - `Data.firstName` (string)
    Displays the first name of the loyalty member.
    Example: "John"

  - `Data.lastName` (string)
    Displays the last name of the loyalty member.
    Example: "Deo"

  - `Data.zipCode` (string)
    Displays the zip code of the loyalty member's residence.
    Example: 51750

  - `Data.optInStatus` (string)
    Displays the opt-in status as YES for opt-in or NO for opt-out. The default opt-in status is YES.
    Example: "YES"

  - `Data.optInDate` (string)
    Displays the opt-in date of the loyalty member in yyyy-MM-dd'T'HH:mm:ssZ format.
    Example: "2024-08-08T07:00:12+0000"

  - `Data.status` (string)
    If the activity-based membership status flag is OFF- Displays the loyalty member’s status as active or inactive. By default, the status is active and can be changed to inactive as per the client’s request. If the activity-based membership status flag is ON- Displays the current status of the member.
    Example: "ACTIVE"

  - `Data.activityBasedStatus` (object)
    When the activity-based membership flag is turned ON, it displays the following information regarding the member's upcoming status.

  - `Data.activityBasedStatus.milestone` (integer)
    Displays the upcoming milestone of the member based on their activities. The administrator can configure a maximum of five milestones.
    Example: 1

  - `Data.activityBasedStatus.nextStatus` (string)
    Displays the member's upcoming status, which can be Dormant or Lapsed. This status can be customized by the administrator.
    Example: "Dormant"

  - `Data.activityBasedStatus.statusDate` (string)
    Displays the date when the member's status will change in YYYY-MM-DD format.
    Example: "2024-02-02"

  - `Data.memberStatus` (string)
    Displays whether the member is an active member or not. This field can have one of two values. YES- The member is currently an active member. NO- The member is not an active member.
    Example: "YES"

  - `Data.phone` (string)
    Displays the phone number of the loyalty member.
    Example: "123-123-4567"

  - `Data.birthDate` (string)
    Displays the date of birth of the loyalty member in yyyy-MM-dd format.
    Example: "1989-12-11"

  - `Data.anniversaryDate` (string)
    Displays the loyalty member's anniversary date, which can be their birthdate, the date they joined the loyalty program or marriage date in yyyy-MM-dd format.
    Example: "2023-12-11"

  - `Data.userProfileImageUrl` (string)
    Displays the image URL for the loyalty member’s profile picture.
    Example: "https://www.socialannex.com/public/manageoptionsdesign16/images/product_landing/loyalty-hover.png"

  - `Data.source` (string)
    Displays the source of the loyalty member's profile creation, whether it was from a website, application, or in-store.
    Example: "website"

  - `Data.createDate` (string)
    Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on which the loyalty member profile was created.
    Example: "2024-08-08T07:00:12+0000"

  - `Data.updateDate` (string)
    Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on which the loyalty member was updated.
    Example: "2024-08-08T07:00:12+0000"

  - `Data.totalSpendCurrency` (integer)
    Displays the total currency spent by the loyalty member. NOTE - This amount represents the user's total lifetime spend within the loyalty program.
    Example: 134

  - `Data.extendedAttribute` (object)
    Displays the member attributes defined in your program configuration. This can be customized according to requirements. It accepts multiple parameters; however, these parameters must be defined under Products > Additional Loyalty Settings > Extended Attributes. Note - The extended attributes listed below are examples only. All extended attributes must be configured for the program as stated above.

  - `Data.extendedAttribute.userType` (string)
    Displays the employment status of the member as employed, unemployed, or student.
    Example: "Employed"

  - `Data.extendedAttribute.userStatus` (string)
    Displays the unique referrer code provided by the Refer-a-Friend program (if applicable), when creating a loyalty member profile.
    Example: "Enabled"

  - `Data.raf` (object)
    Displays the refer-a-friend object if the member was created with a referral code. This functionality is accessible to clients who have the Refer a Friend (RAF) module. Note1- This module is only displayed to new members who sign up using a referrer code and take advantage of the loyalty program. Note2- This functionality is also applicable to multi-template sites.

  - `Data.raf.personalLink` (string)
    Displays the unique refer a friend bitly link.
    Example: "https://bit.ly/3rShgt7\""

  - `Data.raf.inviteCode` (string)
    Displays the unique invite code shared by the loyalty member to invite others to the loyalty program.
    Example: "3rShgt7"

  - `Data.raf.referrerCode` (string)
    Displays the unique referral code from the referrer, used while creating a member (referee).
    Example: "3bhqc5k"

  - `Data.raf.referrerName` (string)
    Displays the name of the referrer whose referrer code was used while creating a member (referee).
    Example: "Adam"

  - `Data.hierarchyData` (object)
    Displays the following information about the group with which the member is associated.

  - `Data.hierarchyData.groupId` (string)
    Displays the ID of the group that the loyalty member belongs to.
    Example: "91"

  - `Data.hierarchyData.addedOn` (string)
    Displays the date on which the loyalty member was added to the group in yyyy-MM-dd'T'HH:mm:ssZ format.
    Example: "2020-10-12T00:00:00+0000"

  - `Data.hierarchyData.groupAvailablePoints` (string)
    Displays the total available points for the group. It is the cumulative points of the group members.
    Example: "500"

  - `Data.hierarchyData.groupName` (string)
    Displays the name of the group.
    Example: "Sweet Family 15"

  - `Data.hierarchyData.userRole` (string)
    Displays the role of the user within the group.
    Example: "Member"

  - `Data.topLevel/bottomLevel` (object)
    Displays the following details.

  - `Data.topLevel/bottomLevel.siteId` (string)
    Displays the Annex Cloud site ID for the loyalty program.
    Example: "29235480"

  - `Data.topLevel/bottomLevel.siteName` (string)
    Displays the name of the site.
    Example: "Socialannextestsite"

  - `Data.topLevel/bottomLevel.groupName` (string)
    Displays the name of the group to which the loyalty member is added.
    Example: "Sweet Family 15"

  - `Data.topLevel/bottomLevel.memberId` (string)
    Displays the member ID of the loyalty member associated with the group.
    Example: "user@domain.com"

  - `Data.topLevel/bottomLevel.blockedStatus` (string)
    Display the blocked status of the loyalty member. (If Show Blocked User Details functionality is enabled from the super admin.). If the member is blocked, then it shows YES otherwise it shows No.
    Example: "YES"

  - `Data.topLevel/bottomLevel.blockedBy` (string)
    Displays the email address of the individual who blocked the loyalty member. (If the Show Blocked User Details functionality is enabled from the super admin.)
    Example: "user@domain.com"

  - `Data.topLevel/bottomLevel.blockedDate` (string)
    Displays the date on which the loyalty member was blocked in yyyy-MM-dd'T'HH:mm:ssZ format. (If the Show Blocked User Details functionality is enabled from the super admin.)
    Example: "2020-10-12T00:00:00+0000"

  - `Data.topLevel/bottomLevel.lastPurchaseDate` (string)
    Displays the date on which the loyalty member made their last purchase in yyyy-mm-dd format.
    Example: "2023-12-11"

  - `Data.topLevel/bottomLevel.lastActivityDate` (string)
    Displays the date on which the loyalty member performed their last activity in yyyy-mm-dd format.
    Example: "2023-12-11"


## Response 400 fields

## Response 404 fields

## Response 405 fields