---
title: "Traverse a company relationship graph"
method: POST
path: "/api/v1/ackdb/entities/{company}/graph"
tags: ["ackDB"]
---

# Traverse a company relationship graph

`POST /api/v1/ackdb/entities/{company}/graph`

## Request

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

scope is parents, children, or connected. Omitted maxDepth means all reachable. Hard caps are 500 companies and 5000 relationships; cap errors never return partial data. includeRoot=false omits only the root company node and keeps incident relationships. One 8-second wall-clock deadline covers the complete read transaction.

## Path parameters

- `company` string, required

## Request body

- object
  - `scope` 'parents' | 'children' | 'connected', required
  - `relationshipTypes` string[]
  - `maxDepth` integer
  - `asOf` string, date-time
  - `includeRoot` boolean

## Response `200`

Bounded complete graph

- object
  - `data` AckdbCompanyGraphResult, required
    - `requestedCompany` AckdbCompanyGraphCompany, required
      - `entityId` string, required
      - `name` string, nullable, required
      - `domain` string, nullable, required
      - `status` string, required
      - `graphOnly` boolean, required
    - `canonicalCompany` AckdbCompanyGraphCompany, required
      - `entityId` string, required
      - `name` string, nullable, required
      - `domain` string, nullable, required
      - `status` string, required
      - `graphOnly` boolean, required
    - `identityRelationships` AckdbCompanyIdentityRelationship[], required
      - `class` string, required
      - `type` string, required
      - `company` AckdbCompanyGraphCompany, required
        - `entityId` string, required
        - `name` string, nullable, required
        - `domain` string, nullable, required
        - `status` string, required
        - `graphOnly` boolean, required
      - `canonicalCompany` AckdbCompanyGraphCompany, required
        - `entityId` string, required
        - `name` string, nullable, required
        - `domain` string, nullable, required
        - `status` string, required
        - `graphOnly` boolean, required
    - `companies` object[], required
      - `entityId` string, required
      - `name` string, nullable, required
      - `domain` string, nullable, required
      - `status` string, required
      - `graphOnly` boolean, required
      - `depth` integer, required
    - `companyRelationships` 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
    - `counts` object, required
      - `companies` integer, required
      - `relationships` integer, required
      - `maxDepth` integer, required
    - `query` object, required
      - `scope` 'parents' | 'children' | 'connected', required
      - `relationshipTypes` string[], nullable, required
      - `maxDepth` integer, nullable, required
      - `asOf` string, date-time, required
      - `includeRoot` boolean, required

## Other responses

- `422`: Graph cap exceeded
- `503`: Graph read exceeded its transaction deadline

---

[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)