---
title: "Get a company's complete current contact hierarchy"
method: POST
path: "/api/v1/ackdb/entities/{entityId}/contact-graph"
tags: ["ackDB"]
---

# Get a company's complete current contact hierarchy

`POST /api/v1/ackdb/entities/{entityId}/contact-graph`

## Request

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

Returns relationship-connected contact nodes only. Use the ordinary company contact list for unassigned contacts.

## Path parameters

- `entityId` string, required

## Request body

- object
  - `relationshipTypes` string[]
  - `asOf` string, date-time

## Response `200`

Contact reporting graph

- object
  - `data` AckdbContactGraphResult, required
    - `entityId` string, required
    - `rootContact` AckdbContactGraphContact, required: A contact affiliation projection used as an org-chart node.
      - `contactId` string, required
      - `entityId` string, required
      - `personId` string, required
      - `name` string, nullable, required
      - `email` string, nullable, required
      - `title` string, nullable, required
      - `department` string, nullable, required
      - `avatarUrl` string, uri, nullable, required
      - `isExternal` boolean, required
      - `status` 'active' | 'former' | 'disabled', required
      - `startedAt` string, date-time, nullable, required
      - `endedAt` string, date-time, nullable, required
    - `contacts` object[], required
      - `contactId` string, required
      - `entityId` string, required
      - `personId` string, required
      - `name` string, nullable, required
      - `email` string, nullable, required
      - `title` string, nullable, required
      - `department` string, nullable, required
      - `avatarUrl` string, uri, nullable, required
      - `isExternal` boolean, required
      - `status` 'active' | 'former' | 'disabled', required
      - `startedAt` string, date-time, nullable, required
      - `endedAt` string, date-time, nullable, required
      - `depth` integer, required
    - `contactRelationships` AckdbContactRelationship[], required
      - `relationshipId` string, required
      - `class` string, required
      - `entityId` string, required
      - `reportContact` AckdbContactGraphContact, required: A contact affiliation projection used as an org-chart node.
        - `contactId` string, required
        - `entityId` string, required
        - `personId` string, required
        - `name` string, nullable, required
        - `email` string, nullable, required
        - `title` string, nullable, required
        - `department` string, nullable, required
        - `avatarUrl` string, uri, nullable, required
        - `isExternal` boolean, required
        - `status` 'active' | 'former' | 'disabled', required
        - `startedAt` string, date-time, nullable, required
        - `endedAt` string, date-time, nullable, required
      - `managerContact` AckdbContactGraphContact, required: A contact affiliation projection used as an org-chart node.
        - `contactId` string, required
        - `entityId` string, required
        - `personId` string, required
        - `name` string, nullable, required
        - `email` string, nullable, required
        - `title` string, nullable, required
        - `department` string, nullable, required
        - `avatarUrl` string, uri, nullable, required
        - `isExternal` boolean, required
        - `status` 'active' | 'former' | 'disabled', required
        - `startedAt` string, date-time, nullable, required
        - `endedAt` string, date-time, nullable, required
      - `relationshipType` string, required
      - `reportToManagerLabel` string, required
      - `managerToReportLabel` 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` AckdbContactRelationshipProvenance, 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
      - `contacts` integer, required
      - `relationships` integer, required
      - `maxDepth` integer, required
    - `query` object, required
      - `scope` 'managers' | 'directReports' | 'connected', required
      - `relationshipTypes` string[], nullable, required
      - `maxDepth` integer, nullable, required
      - `asOf` string, date-time, required
      - `includeRoot` boolean, required

## Other responses

- `422`: Graph cap exceeded

---

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