Get Customers Bulk

post

https://{host}/v2/bulk/getCustomers

Retrieve customer profiles in bulk

This is an internal Capillary API that fetches multiple customer profiles in one request by providing a list of customer IDs. It uses the POST method, and the user IDs of the customers are included in an array in the request body.

Example request

curl --location 'https://eu.api.capillarytech.com/v2/bulk/getCustomers?source=INSTORE' \
--header 'Authorization: Basic *******' \
--header 'Content-Type: application/json' \
--header 'Cookie: _cfuvid=pG2dUTv9AmZsbCWt8RQ1DqWpR2Clfbg.S4lVYFcivvI-1726479424405-0.0.1.1-604800000; _cfuvid=TsciSMonFzukHfHftQcO_JuWhgCktLLqX53atcboO64-1749190644325-0.0.1.1-604800000; _cfuvid=7E2nHmtQ1Wf4YPId8dKF4zUgMUwj5lS5xFEvh1lLZwY-1757926160974-0.0.1.1-604800000' \
--data '[564332013,565338404, 566135941]'

Prerequisites

Authentication: Basic or OAuth credentials
Default access group

Resource information


Pagination support	No
Rate limit	Demo and testing clusters: 1000 requests per minute per API key. Other organizations: Rate limit is brand-specific.
Batch support	Yes

Query parameters

Field	Type	Required	Description
source	string	Yes	Source where the customer was created. Example: INSTORE, WECHAT

Body parameters

An array containing the user or customer IDs of the customers whose details are fetched. The values are comma-separated, and the field name is not required. Usage: [564332013,565338404, 566135941].

Example response

{
    "data": [
        {
            "entity": {
                "id": 564332013,
                "profiles": [],
                "loyaltyInfo": {
                    "loyaltyType": "loyalty"
                },
                "segments": {},
                "extendedFields": {}
            },
            "warnings": [],
            "errors": [
                {
                    "status": false,
                    "code": 8109,
                    "message": "Customer is deleted after PII delete request"
                }
            ],
            "success": false
        },
        {
            "entity": {
                "id": 565338404,
                "profiles": [
                    {
                        "firstName": "Muhammad",
                        "lastName": "Johns",
                        "fields": {},
                        "allFields": {},
                        "identifiers": [
                            {
                                "type": "mobile",
                                "value": "912726093529"
                            },
                            {
                                "type": "email",
                                "value": "[email protected]"
                            },
                            {
                                "type": "externalId",
                                "value": "00008572"
                            }
                        ],
                        "commChannels": [
                            {
                                "type": "mobile",
                                "value": "912726093529",
                                "primary": true,
                                "verified": false,
                                "meta": {
                                    "residence": false,
                                    "office": false
                                },
                                "attributes": {}
                            },
                            {
                                "type": "email",
                                "value": "[email protected]",
                                "primary": true,
                                "verified": false,
                                "meta": {
                                    "residence": false,
                                    "office": false
                                },
                                "attributes": {}
                            }
                        ],
                        "source": "INSTORE",
                        "userId": 565338404,
                        "accountId": "",
                        "conflictingProfileList": [],
                        "autoUpdateTime": "2025-09-15T09:29:33Z",
                        "identifiersAll": [
                            {
                                "type": "mobile",
                                "value": "912726093529"
                            },
                            {
                                "type": "email",
                                "value": "[email protected]"
                            },
                            {
                                "type": "externalId",
                                "value": "00008572"
                            }
                        ]
                    }
                ],
                "loyaltyInfo": {
                    "loyaltyType": "loyalty",
                    "lifetimePurchases": 0.000
                },
                "segments": {},
                "associatedWith": "tj_capillary",
                "extendedFields": {},
                "cardDetails": []
            },
            "warnings": [],
            "errors": [],
            "success": true
        },
        {
            "entity": {
                "id": 566135941,
                "profiles": [
                    {
                        "firstName": "John",
                        "lastName": "Pork",
                        "fields": {},
                        "allFields": {},
                        "identifiers": [
                            {
                                "type": "externalId",
                                "value": "696969"
                            },
                            {
                                "type": "mobile",
                                "value": "918088369835"
                            }
                        ],
                        "commChannels": [
                            {
                                "type": "mobile",
                                "value": "918088369835",
                                "primary": true,
                                "verified": false,
                                "meta": {
                                    "residence": false,
                                    "office": false
                                },
                                "attributes": {}
                            }
                        ],
                        "source": "INSTORE",
                        "userId": 566135941,
                        "accountId": "",
                        "conflictingProfileList": [],
                        "autoUpdateTime": "2025-09-15T09:29:33Z",
                        "identifiersAll": [
                            {
                                "type": "externalId",
                                "value": "696969"
                            },
                            {
                                "type": "mobile",
                                "value": "918088369835"
                            }
                        ]
                    }
                ],
                "loyaltyInfo": {
                    "loyaltyType": "loyalty",
                    "lifetimePurchases": 201000.000,
                    "score": 0
                },
                "segments": {},
                "associatedWith": "naman_doc",
                "extendedFields": {},
                "cardDetails": []
            },
            "warnings": [],
            "errors": [],
            "success": true
        }
    ],
    "warnings": [],
    "errors": []
}

Response parameters

Parameter	Data Type	Description
.data	Array	Array of customer entities with details.
..entity	Object	Entity object containing customer details.
...id	integer	Unique customer ID whose details are fetched.
...profiles	Array	Array of customer profiles.
....firstName	string	Customer’s first name.
....lastName	string	Customer’s last name.
....fields	Object	Custom profile fields.
.....allFields	Object	All available profile fields.
....identifiers	Array	List of identifiers linked to the customer.
.....type	string	Identifier type (e.g., mobile, email, externalId).
.....value	string	Identifier value.
....commChannels	Array	Customer’s communication channels.
.....type	string	Communication type (e.g., mobile, email).
.....value	string	Communication value (e.g., phone number, email).
.....primary	boolean	Indicates if the channel is primary.
.....verified	boolean	Indicates if the channel is verified.
.....meta	Object	Metadata for the communication channel.
......residence	boolean	Indicates if linked to residence.
......office	boolean	Indicates if linked to office.
......attributes	object	Additional attributes for the channel.
....source	string	Source of the profile (e.g., INSTORE).
....userId	integer	User ID of the profile.
....accountId	string	Account ID associated with the profile.
....conflictingProfileList	Array	List of conflicting profiles, if any.
....autoUpdateTime	string	Last auto-update timestamp in ISO 8601 format.
....identifiersAll	Array	All identifiers for the profile.
.....type	string	Type of identifier.
.....value	string	Value of identifier.
...loyaltyInfo	Object	Loyalty-related information.
....loyaltyType	string	Type of loyalty program.
....lifetimePurchases	integer	Lifetime purchase value.
....score	integer	Loyalty score (if available).
...segments	Object	Segment information.
...associatedWith	string	Associated brand or system.
...extendedFields	object	Extended customer fields.
...cardDetails	Array	List of associated card details.
..warnings	Array	Entity-level warnings.
..errors	Array	Entity-level errors.
...status	boolean	Error status flag.
...code	integer	Error code.
...message	string	Error message.
..success	boolean	Indicates if the operation was successful.
.warnings	Array	List of warnings at the top level.
.errors	Array	List of errors at the top level.

Error codes

Code	Description
400	Invalid Request
404	Resource not found
500	UNEXPECTED_ERROR
405	Method not allowed. Request body missing.

Language

Credentials

Basic

base64

URL

Click Try It! to start a request and see the response here!