---
title: "List a company's direct children"
method: GET
path: "/api/v1/ackdb/entities/{company}/relationships/children"
tags: ["ackDB"]
---

# List a company's direct children

`GET /api/v1/ackdb/entities/{company}/relationships/children`

## Request

- Base URL: `http://localhost:3009`
- URL: `http://localhost:3009/api/v1/ackdb/entities/{company}/relationships/children`
- Auth: HTTP bearer

## Path parameters

- `company` string, required

## Query parameters

- `asOf` string, date-time
- `relationshipType` string[]
- `limit` integer
- `cursor` string

## Response `200`

Keyset-paged relationship data

- object
  - `data` AckdbCompanyRelationship[], required
    - `relationshipId` string, required
    - `class` string, required
    - `childCompany` AckdbCompanyGraphCompany, required
      - `entityId` string, required
      - `name` string, nullable, required
      - `domain` string, nullable, required
      - `status` string, required
      - `graphOnly` boolean, required
    - `parentCompany` AckdbCompanyGraphCompany, required
      - `entityId` string, required
      - `name` string, nullable, required
      - `domain` string, nullable, required
      - `status` string, required
      - `graphOnly` boolean, required
    - `relationshipType` string, required
    - `childToParentLabel` string, required
    - `parentToChildLabel` string, required
    - `state` 'active' | 'ended' | 'retracted', required
    - `effectiveFrom` string, date-time, required
    - `effectiveTo` string, date-time, nullable, required
    - `retractedAt` string, date-time, nullable, required
    - `provenance` AckdbCompanyRelationshipProvenance, required
      - `source` string, required
      - `workflow` string
      - `externalRecordId` string
      - `evidenceUrl` string, uri
      - `observedAt` string, date-time
      - `metadata` object
    - `createdBy` string, nullable, required
    - `endedBy` string, nullable, required
    - `endedReason` string, nullable, required
    - `retractedBy` string, nullable, required
    - `retractedReason` string, nullable, required
    - `createdEventId` string, nullable, required
    - `endedEventId` string, nullable, required
    - `retractedEventId` string, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `nextCursor` string, nullable, required

---

[API](https://skmtc.dev/floqer/apis/floqer-public-api.md) - [All operations](https://skmtc.dev/floqer/apis/floqer-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/floqer/apis/floqer-public-api/revisions/fce50dc07b20?raw)