---
title: "Get customer hierarchy in a user group"
method: GET
path: "/customers/bulk"
---

# Get customer hierarchy in a user group

`GET /customers/bulk`

Retrieves all child customers for a parent customer.

## Query parameters

- `source` string
- `associationEntityType` string, required
- `associationEntityIdentifierType` string, required
- `associationEntityIdentifierValue` string, required
- `limit` string
- `offset` string
- `sortOrder` 'ASC' | 'DESC'
- `includeCustomerAssociateDetail` boolean
- `includeNoOfChildren` boolean

## Response `200`

200

- object
  - `entity` object
    - `customers` object[]
      - `profiles` object[]
        - `firstName` string
        - `lastName` string
        - `fields` object
        - `identifiers` object[]
          - `type` string
          - `value` string
        - `commChannels` object[]
          - `type` string
          - `value` string
          - `primary` boolean
          - `verified` boolean
          - `meta` object
            - `residence` boolean
            - `office` boolean
          - `attributes` object
        - `source` string
        - `userId` integer
        - `accountId` string
        - `conflictingProfileList` unknown[]
          - unknown
        - `autoUpdateTime` string
        - `identifiersAll` object[]
          - `type` string
          - `value` string
      - `extendedFields` object
        - `dob` string
      - `roleCode` string
      - `createdDate` string
      - `noOfChildren` integer
      - `defaultChild` boolean
    - `count` integer
    - `errors` unknown[]
      - unknown
    - `warnings` unknown[]
      - unknown
  - `warnings` unknown[]
    - unknown
  - `errors` unknown[]
    - unknown
  - `success` boolean

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/versions/de241f2ed9b3/schema)