get https://{host}/v1.1/customer/get
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.
API endpoint
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 (to retrieve any transaction type, for mixed or NI mixed, it retrieves both transaction and return details). By default it shows the details of regular transaction. |
| 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). For example, setting it to 5 retrieves the five most recent coupon interactions. |
| coupon_offset | int | Retrieves the next set of coupons according to the issuance sequence. For instance, if a customer has received 10 coupons to date, setting this parameter to 6 will return details of the 7th to 10th coupons, ignoring the first 6. |
| 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 in ascending or descending order based on the coupon_order_by value. Possible values: asc, desc (default). |
| next_slab | - | Returns details of the customer's next loyalty tier, including next slab, next slab serial number, next slab description, trackers value (for tracker-based strategies), and current NPS status. |
| slab_history | boolean | Returns the customer's loyalty tier change history with the following information: - From the slab/tier to which the user is upgraded or downgraded - Associated store details - Type of change. Upgrade or Downgrade - The expiry date of the slab/tier - The date on which the tier/slab got changed - Associated program id |
| registered_store | - | Returns the store where the customer registered. This is returned by default. |
| registered_till | - | Returns the specific store-TILL where the customer registered. This is returned by default. |
| fraud_details | - | Returns the customer's fraud details. This is returned by default. |
| ndnc_status | - | Returns the NDNC/DND status of the customer’s registered mobile number. |
| optin_status | - | Returns the services (SMS/email) the customer has opted in or out of. |
| expiry_schedule | - | Returns a summary of the customer's points expiry details, including the number of points set to expire, the program ID, and the date and time of expiry. |
| expired_points | - | Returns details of the customer's expired points. |
| points_summary | - | Returns the customer's points issuance and redemption history. |
| promotion_points | - | Returns the customer's promotional points issuance and redemption history, including the issuing store and expiry dates for each set of issued points. Up to 1000 results can be retrieved (maximum limit). |
| membership_retention_criteria | - | Returns the criteria set for membership or tier retention, typically for membership-based loyalty programs. |
| tier_upgrade_criteria | - | Returns the tier upgrade criteria configured in the tier_update_criteria object of the response payload. This is supported only for tier upgrade strategies based on Lifetime Points, Lifetime Purchases, or Current Points, but not for tracker-based strategies. It is not available if the customer is in the highest tier. |
| mlp | boolean | Retrieves the customer's loyalty information for each loyalty program, including details on the gaps to upgrade and renew. This is applicable only for brands with multiple loyalty programs (MLP). |
| gap_to_upgrade_for | int | Prerequisite: Make sure that you set the mlp=true query parameter to retrieve the details.This parameter indicates the additional purchases, points, visits, or tracker value required for a customer to upgrade to the next tier. It calculates this based on a specified number of days from the current date. Use the parameter as follows: - Set it to 0 to determine the gap for the current day. - Set it to 1 to forecast the next day. - Set it to 30 for a projection 30 days from the current day. Negative values are not supported. |
| gap_to_renew_for | int | Prerequisite: Make sure that you set the mlp=true query parameter to retrieve the details.This parameter indicates the additional purchases, visits, points, or tracker value required for a customer to renew their tier after a specified number of days from the current date. Use the parameter as follows: -Set it to 0 to determine the renewal value for the current day. -Set it to 1 to forecast the next day. -Set it to 30 for a projection 30 days from the current day. Negative values are not supported. |
| user_group | - | Retrieves details of the user group associated with the user, if available. |
| customer_image | - | Retrieves the customer’s profile image. |
| transactions | - | Retrieves the customer's transaction details. |
| subscriptions | - | Retrieves the customer's subscription details. |
| segments | - | Retrieves details of the customer's segments, if applicable. Segments are logical groupings of customers based on one or more parameters. |
| member_care_access | - | For admin users, shows customers that are active within the vicinity of that user. |
| card_details | - | Retrieves details of all the customer's cards. |
| tracker_info | - | |
| delayed_accrual | - | |
| coupon_active | - | |
| basic | - | |
| program_id | int | |
| 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, retrieve the details of the programs the customer is associated with. |
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 |
| customer.lifetime_purchases | The total lifetime purchases made by the customer |
| 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 | Type of slab change. Downgrade or Upgrade |
| -tier_expiry_date | The slab expiry date |
| -changed_on | The date on which slab was changed |
| -note | Additional notes, if any |
| program_id | Associated loyalty program ID |