get
https://{host}/v1.1/customer/get
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Make sure you have the appropriate access control configured. For more information, see access group documentation.
Retrieve details of a specific loyalty customer such as loyalty information, subscription status, 10 recent transactions, active coupons, recent store interactions, custom fields, extended fields, and customer’s unique ID. To fetch the details for customers in bulk, add the identification details separated by a comma.
Note:Use V2 Get Customer Details (lookup) API to retrieve:
- Customer details across all the groups of the customer.
- Details of a specific user group.
- Account ID for sources with multiple accounts.
- Customer status details.
- Alternate currency details.
Example request
curl --location 'https://eu.api.capillarytech.com.capillarytech.com/v1.1/customer/get?format=json&email=sai.ishina9%40gmail.com%2Csai.ishina95%40gmail.com%2C9478341389%40pixar.com' \
--header 'X-CAP-CLIENT-COUNTRYCODE: 1' \
--header 'Authorization: Basic cHVuLjAxOjIwMNiOTYyYWM1OTA3NWI5NjRiMDcxNTJkMjM0Yjcw'curl --location 'https://eu.api.capillarytech.com/v1.1/customer/get?format=json&id=387020208%2C3879773' \
--header 'X-CAP-CLIENT-COUNTRYCODE: 1' \
--header 'Authorization: Basic cHVjAxOjIwMmNiOTYyYWM1OTA3NWI5NjRiMDcxNTJkMjM0Yjcw'Request Query Parameters
Any of the identifiers are mandatory.
| Parameter | Type | Description |
|---|---|---|
| id | int | Unique user ID of the customer whose details you want to fetch. |
| string | Email ID of the customer. | |
| external_id | string | External ID of the customer. |
| card_external_id | string | External ID of the card associated with the customer. |
| number | int | Unique transaction number that want to fetch. |
| store_code | string | Fetch the transactions of a specific store. Pass the store code. |
| till_code | string | Fetch the transactions of a specific TILL. Pass the respective TILL code. |
| amount | long | Filter transactions of a specific amount. |
| date | date | Filter transactions of a specific date. Pass the date in YYYY-MM-DD format. |
| type | string | Filter transactions of a specific type. Values: REGULAR, NOT_INTERESTED, RETURN, NOT_INTERESTED_RETURN, MIXED, NI_MIXED, ALL. By default, shows regular transaction details. |
| tenders | boolean | Pass true to retrieve transaction details. |
| credit_notes | boolean | Pass true to retrieve credit notes. |
| user_id | boolean | Pass true to retrieve unique ID of the customer in response. |
| coupon_limit | int | Limits the number of coupon interactions (issued, redeemed, and expired). |
| coupon_offset | int | Retrieves the next set of coupons according to the issuance sequence. |
| coupon_order_by | enum | Determines the basis for ordering the coupon history. Possible values: created_date (default), created_by, valid_till. |
| coupon_sort_order | enum | Orders coupons based on coupon_order_by. Values: asc, desc (default). |
| next_slab | Returns details of the customer's next loyalty tier. | |
| slab_history | boolean | Prerequisite: Set mlp=true. Returns loyalty tier change history. |
| registered_store | Returns the store where the customer registered. Returned by default. | |
| registered_till | Returns the specific store-TILL where the customer registered. Returned by default. | |
| fraud_details | Returns the customer's fraud details. Returned by default. | |
| ndnc_status | Returns the NDNC/DND status of the customer’s mobile number. | |
| optin_status | Returns the services (SMS/email) the customer has opted in or out of. | |
| expiry_schedule | Returns summary of points expiry details. | |
| expired_points | Returns details of expired points. | |
| points_summary | Returns issuance and redemption history. | |
| promotion_points | Returns promotional points history. Max 1000 results. | |
| membership_retention_criteria | Returns criteria set for membership or tier retention. | |
| tier_upgrade_criteria | Returns tier upgrade criteria if applicable. | |
| mlp | boolean | Retrieves loyalty info for brands with multiple loyalty programs (MLP). |
| gap_to_upgrade_for | int | Prerequisite: mlp=true. Indicates what is needed to upgrade after N days. |
| gap_to_renew_for | int | Prerequisite: mlp=true. Indicates what is needed to renew after N days. |
| user_group | Retrieves user group details if available. | |
| customer_image | Retrieves the customer’s profile image. | |
| transactions | Retrieves transaction details. | |
| subscriptions | Retrieves subscription details. | |
| segments | Retrieves customer’s segment details. | |
| member_care_access | For admin users, shows active customers near them. | |
| card_details | Retrieves all card details. | |
| delayed_accrual | ||
| coupon_active | ||
| basic | ||
| programId | int | Loyalty program ID |
| coupon_offer | int | Default value is 0. |
| coupon_org_entity_type | string | |
| coupon_org_entity_value | string | |
| coupon_status | string | |
| program_summary | boolean | If enabled, retrieves the programs the customer is part of. |
Note: You can retrieve details of a customer using customer ID, email or external_id.
If you attempt to retrieve data of any deleted customer after a successful PII deletion, you will receive the following response:
"message": "Customer is deleted after PII delete request"
Additional Header
| Parameter | Description |
|---|---|
| language | Specify the ISO language code to get transaction level extended field details in your preferred language (other than English). For example, zh for Chinese, id for Indonesian, ar for Arabic |
Response parameter
| Parameter | Description |
|---|---|
| status.success | Indicates the success of the operation |
| status.code | The code representing the status of the operation |
| status.message | The message describing the status of the operation |
| status.total | The total count in the response |
| status.success_count | The count of successful operations |
| customer.firstname | The first name of the customer |
| customer.lastname | The last name of the customer |
| customer.mobile | The mobile number of the customer |
| customer.email | The email address of the customer |
| customer.external_id | An external identifier for the customer |
| customer.lifetime_points | The total lifetime points accumulated by the customer. If the value is beyond the data type limit, the value is represeted in scientific notation. For example, the value 5,632,820,109 is represented as 5.632820109E9. |
| customer.lifetime_purchases | The total lifetime purchases made by the customer. If the value is beyond the data type limit, the value is represeted in scientific notation. For example, the value 5,632,820,109 is represented as 5.632820109E9. |
| customer.loyalty_points | The current loyalty points of the customer |
| customer.current_slab | The current slab of the customer in the loyalty program |
| customer.registered_on | The date and time when the customer registered |
| customer.updated_on | The date and time when the customer's information was last updated |
| customer.type | The type of customer |
| customer.source | The source through which the customer was acquired |
| customer.registered_by | The individual who registered the customer |
| registered_store.code | The code of the store where the customer was registered |
| registered_store.name | The name of the store where the customer was registered |
| registered_till.code | The code of the till used to register the customer |
| registered_till.name | The name of the till used to register the customer |
| fraud_details.status | The fraud status of the customer |
| extended_fields.field (gender) | The gender of the customer |
| extended_fields.field (city) | The city where the customer resides |
| extended_fields.field (dob) | The date of birth of the customer |
| item_status.success | Indicates the success of the customer item operation |
| item_status.code | The code representing the status of the customer item operation |
| item_status.message | The message describing the status of the customer item operation |
| programs_list | Includes the list of programs the customer is associated with. This will be available only if program_summary is set to true. |
| program | Includes the details of the program such as program ID, program name, program description and more. |
| slab_history | Includes details of tier/slab change events. Each object in the array represents a single instance of a slab (tier) upgrade or change, with the most recent change typically listed first. |
| -to | The slab to which the user got upgraded or downgraded. |
| -from | The slab from which the user got upgraded or downgraded. |
| -store | Associated store details. |
| Type of slab change. Downgrade or Upgrade. |
| -to_tier_expiry_date | Expiry date of the tier to which the customer has moved, in YYYY-MM-DD HH:MM:SS format. |
| -from_tier_expiry_date | Expiry date of the customer's previous tier, before the tier change occurred, in YYYY-MM-DD HH:MM:SS format. |
| -changed_on | The date on which slab was changed, in YYYY-MM-DD HH:MM:SS format. |
| -notes | Additional notes, if any. |
| -program_id | Associated loyalty program ID. |
| points_summaries | Array containing the details of the loyalty points. Note: You need to 'mlp=true' to retrieve 'points_summaries' in the API response |
| -points_summary | A list of individual points summaries. |
| --programId | Unique ID of the loyalty program associated with the points summary. |
| --redeemed | Number of points redeemed by the customer in the program. |
| --expired | Number of points that have expired in the program. |
| --returned | Number of points that were initially issued but later reversed or returned to the customer’s account due to specific actions, such as product returns. |
| --adjusted | Points that are either credited to or debited from the customer account in adjustments. The value will be negative if debited points are more than credited, and positive if credited points are more than debited. |
| --lifetimePoints | Total loyalty points earned by the customer to date. If the value is beyond the data type limit, the value is represeted in scientific notation. For example, the value 5,632,820,109 is represented as 5.632820109E9. |
| --loyaltyPoints | Current loyalty points available for use. If the value is beyond the data type limit, the value is represeted in scientific notation. For example, the value 5,632,820,109 is represented as 5.632820109E9. |
| --cumulativePurchases | Total purchase amount of the customer, associated with the current loyalty program. |
| --currentSlab | Current tier of the customer in the loyalty program. |
| --currentSlabDescription | Description of the current tier as saved in the loyalty program. |
| --nextSlab | Next slab or tier to which the customer can upgrade to. |
| --nextSlabSerialNumber | Serial number of the next tier. The lowest tier will have 1, succeeding tier will have 2 and so on. |
| --nextSlabDescription | Description of the next tier as saved in the loyalty program. |
| --slabSNo | Serial number of the current tier of the customer. The lowest tier will have 1, succeeding tier will have 2 and so on. |
| --slabExpiryDate | Expiry date of the current loyalty tier of the customer in ISO YYYY-MM-DD HH:MM:SS format. |
| --totalPoints | Total points earned by the customer in a loyalty program. If the value is beyond the data type limit, the value is represeted in scientific notation. For example, the value 5,632,820,109 is represented as 5.632820109E9. |
| --delayed_points | Points issued to customers at a later date from issual. For more information on delayed points, refer to the documentation. |
| --delayed_returned_points | Delayed points that were reversed or returned to the customer’s account due to specific actions, such as product returns. |
| --total_available_points | Total points available for redemption. If the value is beyond the data type limit, the value is represeted in scientific notation. For example, the value 5,632,820,109 is represented as 5.632820109E9. |
| --total_returned_points | Total points that were initially issued but later reversed or returned to the customer’s account due to specific actions, such as product returns. If the value is beyond the data type limit, the value is represeted in scientific notation. For example, the value 5,632,820,109 is represented as 5.632820109E9. |
| --program_title | Title of the loyalty program. |
| --program_description | Description of the loyalty program. |
| --program_points_to_currency_ratio | Ratio of points to currency. It indicates how many points are equivalent to one unit of currency. |
| --linked_partner_programs | Details of linked . |
| ---linked_partner_program | A list of linked partner programs, if any. |
| --gap_to_upgrade | Gap to upgrade to the next slab. It is the additional purchases, points, visits, or tracker value required for a customer to upgrade to the next tier. |
| ---custom_expression | Logical condition that defines the criteria for upgrade. Example: documentation. |
| ---expression_relation | Structured representation of the conditions in the custom_expression. Example: [[1, 2], [3]]Visible only if custom expression is set. |
| ---upgrade_strategy | Provides the set of rules or conditions that defines how a customer progresses to a higher tier in a loyalty program. |
| ----upgrade_based_on | Parameter using which the is determined. Example: |
| ----upgrade_entity_identifers | Array containing details of the tracker, if any. Visible in case of . |
| -----tracker_name | Name of the tracker. Example: amountTracker |
| -----tracker_type | Entity tracked, such as transaction amount, line-item count, or customer visits. Example: BILL_AMOUNT |
| -----tracker_mode | Method used to evaluate tracker values over time, Example: MOVING_WINDOW, CYCLIC_WINDOW, CALENDAR_BASED_CYCLIC_WINDOW, or TIER_CHANGE_WINDOW. |
| -----tracker_case_name | Name of the specific tracker case. Example: amtTrack. |
| -----tracker_case_period_type | Specifies the duration type for evaluating the tracker case, such as days, months, or calendar cycles. Example: DAYS |
| -----tracker_case_period_value | Value of the tracker case period. Example: 30 |
| ----upgrade_threshold | Threshold value required for an upgrade. Example: 10000 points. |
| ----customer_upgrade_entity_values | Array containing the current values related to the customer’s upgrade. |
| -----current_value | Current value attained by the customer. Example: 9786 points. |
| -----gap_to_upgrade | Additional value required for the upgrade. Example: 15214 points (threshold value minus current value) |
| -----value_valid_upto | Date until which the value is valid, in Note: For example, ff the tracker cycle runs from August 21, 2025, to August 21, 2026, the cycle's actual end date is August 21, 2026. A customer earns their first award in this cycle on October 30, 2025. The Due to this, the |
| --gap_to_renew | Set of rules or conditions required for tier renewal for the customer in a loyalty program. |
| ---tier_expiry_date | Expiry date of the customer’s current tier, in YYYY-MM-DD format. Example: 2024-12-31. |
| ---renew_confirmed | Indicates if the tier renewal is confirmed. Values: true or false. |
| ---custom_expression | Logical condition that defines the criteria for renewal. Example: documentation. |
| ---expression_relation | Structured representation of the conditions in the custom_expression. Example: [[1, 2], [3]]Visible only if custom expression is set. |
| ---renew_strategy | Array containing details of the rules or conditions for tier renewal. |
| ----renew_based_on | Specifies the . Example: |
| ----renew_entity_identifiers | Array containing details of the tracker. Visible in case of . |
| ----renew_threshold | Threshold value required by the customer to renew the tier. Example: 5.0 for store visits, 10 for purchases. |
| ----customer_renew_entity_value | Current value reached by the customer. Example: 1 store visit or 123 points |
| ----customer_gap_to_renew_value | Additional value required for the tier renewal. Example: 4 store visits, 10 purchases or 1877 points. |