# Fetch the activity details

By using this method, all activity details for a member can be retrieved.

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

## Path parameters:

  - `memberId` (string, required)
    Enter the unique member ID.
    Example: "John.j45@gmail.com"

## Response 200 fields (application/json):

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

  - `activityDetail` (object)
    Displays the following parameters.

  - `activityDetail.rewardCode` (string)
    Displays the unique reward code shared with the member. If there is a coupon code associated with the action, it will be displayed here.
    Example: "$30-OFF"

  - `activityDetail.actionId` (integer)
    Displays the unique action ID for the action performed by the member. For example, the action ID for manual credit/debit is 100, while the action ID for purchase is 109.
    Example: 109

  - `activityDetail.activityId` (string)
    Displays the unique identifier for a specific activity associated with the given memberID. This activityId is used to track and reference individual user activities, enabling the retrieval of detailed activity information.
    Example: "550e8400-e29b-41d4-a716-446655440000"

  - `activityDetail.activity` (string)
    Displays the name of the action performed by the member. It can be credit or debit.
    Example: "Credit"

  - `activityDetail.credit` (integer)
    Displays the number of points credited to the member’s account for taking the action.
    Example: 100

  - `activityDetail.pointType` (string)
    Displays the value for the point type parameter, which specifies the transaction type for credit and debit activities. The point type returns four types of values- Standard, Promotional, Reversal Standard, and Reversal Promotion. If the user has explicitly passed a value for the point type using the Point API, that value is overwritten by the Activity API response. If the user sets the point type value to “Regular”, it should display as “Regular” in Point API response and overwrite the existing point value in the activity API response. If the point type parameter is included in the Point API payload but no value is provided, the system will throw an error indicating that the point type should not be blank. If the point type is not included, the current behavior is that the point response will not display the point type parameter and it’s value.
    Example: "Standard or Promotional"

  - `activityDetail.pointStatus` (string)
    Displays the point status as hold, redeemed, or released. The point status may show as hold if you have elected to hold points from members for a defined number of days after the action is completed when configuring your program. Otherwise, the point status will show as released or redeemed.
    Example: "Released"

  - `activityDetail.rewardAttribute` (string)
    Displays the name of the extended reward attribute. Note - These attributes should be displayed in every reward ID of the configuration. Note - The data type can be INT, DECEIMAL, VARCHAR, DATE, or DATETIME.
    Example: "Vat"

  - `activityDetail.actionAttribute` (object)
    Action attributes allow you to capture additional metadata about an action. It displays the following data. Note - This information will only be displayed if the Validate Extended Attribute Values flag is enabled in the action rules.

  - `activityDetail.actionAttribute.attributeValue` (string)
    Displays the attribute name which is added to the action. This is nested in the action attribute object, where the parameter specifies an attribute name, while the parameter value displays the shared metadata.
    Example: "Mobile"

  - `activityDetail.displayText` (string)
    Displays a brief description of the action performed by the member. It can be customized by the administrator while creating an action.
    Example: "Debit"

  - `activityDetail.campaignId` (integer)
    Displays the campaign ID of the campaign associated with the activity.
    Example: 105

  - `activityDetail.campaignName` (string)
    Displays the campaign name associated with the activity. The campaign name is added while creating a campaign.
    Example: "Big sales"

  - `activityDetail.campaignPoints` (integer)
    Displays the number of points awarded to the member once they achieve the campaign benefits.
    Example: 120

  - `activityDetail.reason` (string)
    Displays the reason for performing the actions by the member.
    Example: "Bonus/Debit/Product is returned"

  - `activityDetail.orderId` (string)
    Displays the order ID for the activity performed by the member.
    Example: "ORDERID-TEST123"

  - `activityDetail.source` (string)
    Displays the source of the transaction. For example, website, application, or in-store. Actions can also be performed in-store at check-out. Note - This is not an auto-generated value. The value should be passed to the source parameter at the time of performing the action.
    Example: "website"

  - `activityDetail.createDate` (string)
    Displays the date when the transaction occurred in YYYY-MM-DD'T'HH:mm:ssZ format.
    Example: "2021-02-09T18:27:35+0000"

  - `activityDetail.expireDate` (string)
    Displays the date on which the points awarded for the actions will expire in YYYY-MM-DD'T'HH:mm:ssZ format.
    Example: "2021-02-09T18:27:35+0000"

  - `activityDetail.storeDetails` (object)
    Displays the following store details associated with the store. Note - If a store ID is provided with any action and it exists in the metadata, all associated attributes of that store will be displayed. If the store ID does not exist in the metadata, it will simply display the store ID itself.

  - `activityDetail.storeDetails.storeId` (string)
    Displays an identifier for the specific store. It is a unique code assigned to each store.
    Example: "IN12369"

  - `activityDetail.storeDetails.storeName` (string)
    Displays the name associated with the specific store.
    Example: "SHELL"

  - `activityDetail.storeDetails.storeExtendedAttribute` (string)
    Displays all the store extended attributes.
    Example: "Store Location"

  - `activityDetail.senderData` (object)
    Displays the following details regarding the Sender.

  - `activityDetail.senderData.senderId` (string)
    Displays the unique identifier of the member who is sending the points upon the execution of action ID 176 or custom action ID.
    Example: "r00.00@annexcloud.com"

  - `activityDetail.senderData.senderName` (string)
    Displays the unique name of the member who is sending the points upon the execution of action ID 176 or a custom action ID.
    Example: "Rabindra Nath"

  - `activityDetail.receiverData` (object)
    Displays the following details regarding the Receiver.

  - `activityDetail.receiverData.receiverId` (string)
    Displays the unique identifier of the member who is receiving the points upon the execution of action ID 176 or custom action ID.
    Example: "r00.00@annexcloud.com"

  - `activityDetail.receiverData.receiverName` (string)
    Displays the unique name of the member who is receiving the points upon the execution of action ID 176 or a custom action ID.
    Example: "Rabindra Nath"

  - `activityDetail.groupCredit` (integer)
    Displays the total number of points credited to the group that the recipient belongs to as part of an activity. Note - The response for this parameter is dynamic and depends on whether the activity being fetched is for the sender or the recipient.
    Example: 5

  - `activityDetail.groupDebit` (integer)
    Displays the total number of points deducted from the group’s balance due to the sender’s activity. Note - The response for this parameter is dynamic and depends on whether the activity being fetched is for the sender or the recipient.

  - `activityDetail.rewardId` (integer)
    Displays the unique reward ID associated with the activity.
    Example: 123

  - `activityDetail.customId` (string)
    Displays the customID limit set at the site level. This is a secondary form of a limit on top of the action limitations to verify those members who participate in the same actions repeatedly in order to acquire points. This functionality will only be visible when both the Enable Site Level CustomId Limit flag on the general settings page within the additional loyalty settings and the Include custom parameter flag on the additional settings page within the action rules are enabled. When the customId flag is enabled, the system checks for the custom limit instead of the action limit while awarding points to any member. As an example, you wish to award points to loyalty members for linking their devices to the loyalty program via email, SMS or an application. You set the action interval limit to be greater than 1. However, you would like to prevent members from getting points more than once for linking the same device several times. By using customIds and setting the custom limit to 1, you will ensure that no members will be awarded points more than once for linking the same device.
    Example: 3

  - `activityDetail.purchasePointType` (string)
    Displays the purchase point type as Both, Only Bonus or Only Ratio when the Purchase Point Type flag for the order or activity API is enabled.
    Example: "Only Bonus"

  - `activityDetail.campaignReleaseDate` (string)
    Displays the date on which the campaign points are released inYYYY-MM-DD'T'HH:mm:ssZ format.
    Example: "2021-02-09T18:27:35+0000"

  - `activityDetail.holdPointsReleaseDate` (string)
    Displays the date on which the points on hold will be released in YYYY-MM-DD'T'HH:mm:ssZ format.
    Example: "2021-02-09T18:27:35+0000"

  - `activityDetail.holdPointsCancelDate` (string)
    Displays the date on which the points on hold were cancelled in YYYY-MM-DD'T'HH:mm:ssZ format. The points on hold might be cancelled if the member returns a product.
    Example: "2021-02-09T18:27:35+0000"

  - `activityDetail.blockedStatus` (string)
    Displays the blocked status of the member. (If the Show Blocked User Details functionality is enabled.). If the member is blocked, then it shows YES otherwise it shows NO.
    Example: "YES"

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

  - `activityDetail.blockedDate` (string)
    Displays the date on which the 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: "2021-02-09T18:27:35+0000"

  - `orderDetails` (object)
    Displays the following details-

  - `orderDetails.activity` (string)
    Displays the order activity name such as credit or debit.
    Example: "Credit/Debit"

  - `orderDetails.credit/debit` (integer)
    Displays the number of points credited to the member’s account or debited from the member’s account.
    Example: 10

  - `orderDetails.pointStatus` (string)
    Displays the point status as Hold, Redeemed, or Released. The point status may show as Hold if you have elected to hold points from members for a defined number of days after the action is completed when configuring your program. Otherwise, the point status will show as Released or Redeemed.
    Example: "Released"

  - `orderDetails.displayText` (string)
    Displays brief information related to the order activity.
    Example: "Manual Credit/Debit"

  - `orderDetails.sectionId` (string)
    Displays the unique section ID. (A survey includes multiple questions for loyalty members to answer, and the questions are split into various sections to help them comprehend the context of the survey.)
    Example: 654

  - `orderDetails.sectionName` (string)
    Displays the section name as specified by the Administrator. (If the member just completes one section of the survey, the name of the survey and the section are both displayed.)
    Example: "main section"

  - `orderDetails.surveyId` (string)
    Displays the unique Survey ID. This survey ID is auto generated by the system. (This identifier helps in tracking and organizing survey responses, ensuring that each response is linked to the correct survey and participant.
    Example: 123

  - `orderDetails.surveyName` (string)
    Displays the survey name as specified by the Administrator. (The surveys for loyalty members have names based on their criteria to differentiate and outline the contents of the survey in brief. If the member takes the survey, the name of the survey in which the member participated is displayed.)
    Example: "General Survey"

  - `orderDetails.updateDate` (string)
    Displays the last date and time, the transaction was updated in YYYY-MM-DD'T'HH:mm:ssZ format.
    Example: "2021-02-09T18:27:35+0000"

  - `multibucketsData` (object)
    Displays the following fields when the multi point bucket flag is enabled-

  - `multibucketsData.action[bucketName]` (object)
    Displays the following details of the point bucket being affected by a loyalty action-

  - `multibucketsData.action[bucketName].credit/debit` (integer)
    Displays the number of points credited to the point bucket or debited from the point bucket for the action.
    Example: 10

  - `multibucketsData.action[bucketName].expireDate` (string)
    Displays the date on which the points in the bucket will expire in YYYY-MM-DD'T'HH:mm:ssZ format.
    Example: "2021-02-09T18:27:35+0000"

  - `multibucketsData.tier[bucketName]` (object)
    Displays the following details of the point bucket affected by tier activity-

  - `multibucketsData.tier[bucketName].credit/debit` (integer)
    Displays the number of points credited to the point bucket or debited from the point bucket based on the member’s tier status.
    Example: 100

  - `groupActivity` (object)
    Displays the following activity details for the group when the hierarchy status flag is enabled.

  - `groupActivity.HierarchyGroupUserCreditActivity` (object)
    Displays the following details-

  - `groupActivity.HierarchyGroupUserCreditActivity.action_id` (integer)
    Displays the unique action ID for which the points are credited to the group.
    Example: 160

  - `groupActivity.HierarchyGroupUserCreditActivity.credit` (integer)
    Displays the number of points credited to the group account.
    Example: 10

  - `groupActivity.HierarchyGroupUserCreditActivity.create_date` (string)
    Displays the date on which the group was created in YYYY-MM-DD'T'HH:mm:ssZ format.
    Example: "2021-02-09T18:27:35+0000"

  - `groupActivity.HierarchyGroupUserCreditActivity.uid` (string)
    Displays the unique ID of the group.
    Example: "user@domain.com"

  - `groupActivity.HierarchyGroupUserCreditActivity.first_name` (string)
    Displays the first name of the member.
    Example: "John"

  - `groupActivity.HierarchyGroupUserCreditActivity.group_name` (string)
    Displays the name of the group that participated in the activity.
    Example: "sweet- member"

  - `groupActivity.HierarchyGroupUserDebitActivity` (object)
    Displays the following details-

  - `groupActivity.HierarchyGroupUserDebitActivity.action_id` (integer)
    Displays the unique action ID for which the points are debited from the group.
    Example: 160

  - `groupActivity.HierarchyGroupUserDebitActivity.debit` (integer)
    Displays the number of points debited from the group account.
    Example: 10

  - `groupActivity.HierarchyUserCreditActivity` (object)
    Displays the following details-

  - `groupActivity.HierarchyUserCreditActivity.action_id` (integer)
    Displays the unique action ID through which the points are credited to the member’s account.
    Example: 160

  - `groupActivity.HierarchyUserCreditActivity.credit` (integer)
    Displays the number of points credited to the member’s account.
    Example: 10

  - `groupActivity.HierarchyUserCreditActivity.create_date` (string)
    Displays the date on which the member was added to the group in YYYY-MM-DD'T'HH:mm:ssZ format.
    Example: "2021-02-09T18:27:35+0000"

  - `groupActivity.HierarchyUserCreditActivity.uid` (string)
    Displays the unique ID of the group member.
    Example: "user@domain.com"

  - `groupActivity.HierarchyUserCreditActivity.group_id` (integer)
    Displays the unique ID of the group.
    Example: 123

  - `groupActivity.HierarchyUserCreditActivity.credited_by` (string)
    Displays the unique ID of the member who has credited points to the group account.
    Example: "member1@domain.com"

  - `groupActivity.HierarchyUserDebitActivity` (object)
    Displays the following details-

  - `groupActivity.HierarchyUserDebitActivity.action_id` (integer)
    Displays the unique action ID through which the points are debited from the member’s account.
    Example: 160

  - `groupActivity.HierarchyUserDebitActivity.debit` (integer)
    Displays the number of points debited from the member’s account.
    Example: 10

  - `groupActivity.HierarchyUserDebitActivity.debited_by` (string)
    Displays the unique ID of the member who has debited points from the group account.
    Example: "member2@domain.com"

  - `pages` (integer)
    Displays the total number of pages associated with the activities.
    Example: 40

  - `currentpage` (integer)
    Displays the current page number.
    Example: 11

  - `totalActivityCount` (integer)
    Displays the total number of activities performed by the member.
    Example: 2

  - `campaignDetails` (object)
    Displays the following information once the campaign milestone benefit activity flag is enabled in the super admin.

  - `campaignDetails.campaignGroupId` (integer)
    Displays the group ID associated with the campaign.
    Example: 1654

  - `campaignDetails.campaignId` (integer)
    Displays the campaign ID.
    Example: 3692

  - `campaignDetails.campaignName` (string)
    Displays the name of the campaign.
    Example: "Back to School Savings"

  - `campaignDetails.campaignPoints` (integer)
    Displays the campaign points awarded to the member once they achieve the campaign milestones.
    Example: 200

  - `campaignDetails.rewardId` (integer)
    Displays the unique ID for the reward configured in the loyalty program.
    Example: 2345

  - `campaignDetails.rewardName` (string)
    Displays the name of the reward used by the member.
    Example: "Jockey $15.00 off purchase"

  - `campaignDetails.rewardCode` (string)
    Displays the reward code used by the member.
    Example: "AP232"


## Response 403 fields

## Response 404 fields

## Response 405 fields