> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fynn.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Get customer children

> Returns a list of direct child customers for the specified customer, including subscription metrics. When the `customer.hierarchy` feature is not enabled, an empty array is returned.

<sup>Required permissions: `customer:read`</sup>

Returns a list of direct child customers for the specified parent customer. Each child entry includes basic customer information and the count of active subscriptions (`activeSubscriptionCount`).

When the `customer.hierarchy` feature is not enabled, this endpoint returns an empty array.

## Response Fields

| Field                     | Description                                                                  |
| ------------------------- | ---------------------------------------------------------------------------- |
| `id`                      | The child customer ID                                                        |
| `customerNumber`          | The customer number                                                          |
| `name`                    | The display name                                                             |
| `companyName`             | The company name                                                             |
| `email`                   | The primary email address                                                    |
| `status`                  | The customer status (`STATUS_ACTIVE`, `STATUS_ARCHIVED`, `STATUS_SUSPENDED`) |
| `activeSubscriptionCount` | Number of active subscriptions for this child customer                       |


## OpenAPI

````yaml get /customers/{customerId}/children
openapi: 3.1.0
info:
  title: Fynn API
  description: ''
  termsOfService: https://www.fynn.eu/tos
  contact:
    name: Fynn UG (haftungsbeschränkt)
    url: https://www.fynn.eu
    email: hi@fynn.eu
  license:
    name: Proprietary
    url: https://www.fynn.eu/license
  version: 0.0.0
servers:
  - url: https://coreapi.io
    description: Production
  - url: https://preview.coreapi.io
    description: Sandbox
security:
  - JWT: []
tags: []
paths:
  /customers/{customerId}/children:
    parameters: []
    get:
      tags:
        - Customer
      summary: Get customer children
      description: >-
        Returns a list of direct child customers for the specified customer,
        including subscription metrics. When the `customer.hierarchy` feature is
        not enabled, an empty array is returned.


        <sup>Required permissions: `customer:read`</sup>
      operationId: getCustomerChildren
      parameters:
        - name: customerId
          in: path
          description: The ID of the parent customer
          required: true
          deprecated: false
          schema:
            type: string
            format: uuid
          style: simple
          explode: false
      responses:
        '200':
          description: List of direct child customers
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                      example: 00000000-0000-0000-0000-000000000001
                    customerNumber:
                      type: string
                      example: CUST-101
                    name:
                      type: string
                      example: Radiologie Abteilung
                    companyName:
                      type: string
                      example: Radiologie Abteilung
                    email:
                      type:
                        - string
                        - 'null'
                      example: radio@klinik.de
                    status:
                      type: string
                      enum:
                        - STATUS_ACTIVE
                        - STATUS_ARCHIVED
                        - STATUS_SUSPENDED
                      example: STATUS_ACTIVE
                    activeSubscriptionCount:
                      type: integer
                      description: >-
                        The number of active subscriptions for this child
                        customer
                      example: 3
        '404':
          description: Customer not found
      deprecated: false
      security:
        - JWT:
            - customer:read
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X GET \
             /customers/{customerId}/children \
             --header "Authorization: Bearer <token>"
components:
  securitySchemes:
    JWT:
      type: http
      scheme: bearer

````