v1
latestOpenAPI 3.0.12026-07-24501176.6 MBGet customer hierarchy in a user group
Retrieves all child customers for a parent customer.
get/customers/bulk
Query parameters
sourcestring
Indicates the origin of the data.
associationEntityTypestring required
Type of entity associated.
associationEntityIdentifierTypestring required
The type of identifier used for the associated entity.
associationEntityIdentifierValuestring required
The actual identifier value for the associated entity.
limitstring
The maximum number of records to return per page.
offsetstring
The starting point in the list of records.
sortOrder'ASC' | 'DESC'
The order in which the results should be sorted, e.g., DESC.
includeCustomerAssociateDetailboolean
Indicates whether to include customer associate details in the response.
includeNoOfChildrenboolean
Indicates whether to include the count of associated children in the response.
Response
200
Example response
{
"entity": {
"customers": [
{
"profiles": [
{
"firstName": "Rohan",
"lastName": "Mahadar",
"identifiers": [
{
"type": "email",
"value": "tom.sawyer@capillarytech.com"
}
],
"commChannels": [
{
"type": "email",
"value": "tom.swayer@capillarytech.com",
"primary": true
}
],
"source": "INSTORE",
"userId": 134094571,
"autoUpdateTime": "2023-07-21T05:54:37Z",
"identifiersAll": [
{
"type": "email",
"value": "tom.sawyer@capillarytech.com"
}
]
}
],
"extendedFields": {
"dob": "1980-05-08T00:00:00Z"
},
"roleCode": "Senior_Manager",
"createdDate": "2023-04-14T03:29:31Z",
"noOfChildren": 1
}
],
"count": 2
},
"success": true
}