Zum Hauptinhalt springen
GET
/
customers
/
{customerId}
/
children
cURL
curl -X GET \
 /customers/{customerId}/children \
 --header "Authorization: Bearer <token>"
[
  {
    "id": "00000000-0000-0000-0000-000000000001",
    "customerNumber": "CUST-101",
    "name": "Radiologie Abteilung",
    "companyName": "Radiologie Abteilung",
    "email": "radio@klinik.de",
    "status": "STATUS_ACTIVE",
    "activeSubscriptionCount": 3
  }
]
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

FieldDescription
idThe child customer ID
customerNumberThe customer number
nameThe display name
companyNameThe company name
emailThe primary email address
statusThe customer status (STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED)
activeSubscriptionCountNumber of active subscriptions for this child customer

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

​
customerId
string<uuid>
erforderlich

The ID of the parent customer

Antwort

List of direct child customers

​
id
string<uuid>
Beispiel:

"00000000-0000-0000-0000-000000000001"

​
customerNumber
string
Beispiel:

"CUST-101"

​
name
string
Beispiel:

"Radiologie Abteilung"

​
companyName
string
Beispiel:

"Radiologie Abteilung"

​
email
string | null
Beispiel:

"radio@klinik.de"

​
status
enum<string>
Verfügbare Optionen:
STATUS_ACTIVE,
STATUS_ARCHIVED,
STATUS_SUSPENDED
Beispiel:

"STATUS_ACTIVE"

​
activeSubscriptionCount
integer

The number of active subscriptions for this child customer

Beispiel:

3