AckdbContactGraphResult

Properties

entityIdstringrequired
rootContactall ofrequired
contactsarray ofrequired
all of
Option 2
depthintegerrequiredmin 0
contactRelationshipsarray ofrequired
AckdbContactRelationship
countsobjectrequired
contactsintegerrequiredmin 0
relationshipsintegerrequiredmin 0
maxDepthintegerrequiredmin 0
queryobjectrequired
scopestringrequired
"managers""directReports""connected"
relationshipTypesarray ofrequired
string
maxDepthinteger (nullable)required
asOfstring <date-time>required
includeRootbooleanrequired

Example

AckdbContactGraphResult example
{
  "entityId": "string",
  "rootContact": {
    "contactId": "string",
    "entityId": "string",
    "personId": "string",
    "name": "string",
    "email": "string",
    "title": "string",
    "department": "string",
    "avatarUrl": "https://example.com",
    "isExternal": false,
    "status": "active",
    "startedAt": "1970-01-01T00:00:00.000Z",
    "endedAt": "1970-01-01T00:00:00.000Z"
  },
  "contacts": [
    {
      "$ref": "See AckdbContactGraphContact",
      "depth": 0
    }
  ],
  "contactRelationships": [
    {
      "relationshipId": "string",
      "class": "string",
      "entityId": "string",
      "reportContact": {
        "$ref": "See AckdbContactGraphContact"
      },
      "managerContact": {
        "$ref": "See AckdbContactGraphContact"
      },
      "relationshipType": "string",
      "reportToManagerLabel": "string",
      "managerToReportLabel": "string",
      "state": "active",
      "effectiveFrom": "1970-01-01T00:00:00.000Z",
      "effectiveTo": "1970-01-01T00:00:00.000Z",
      "retractedAt": "1970-01-01T00:00:00.000Z",
      "provenance": {
        "source": "string",
        "workflow": "string",
        "externalRecordId": "string",
        "evidenceUrl": "https://example.com",
        "observedAt": "1970-01-01T00:00:00.000Z",
        "metadata": {}
      },
      "createdBy": "string",
      "endedBy": "string",
      "endedReason": "string",
      "retractedBy": "string",
      "retractedReason": "string",
      "createdEventId": "string",
      "endedEventId": "string",
      "retractedEventId": "string",
      "createdAt": "1970-01-01T00:00:00.000Z",
      "updatedAt": "1970-01-01T00:00:00.000Z"
    }
  ],
  "counts": {
    "contacts": 0,
    "relationships": 0,
    "maxDepth": 0
  },
  "query": {
    "scope": "managers",
    "relationshipTypes": [
      "string"
    ],
    "maxDepth": 0,
    "asOf": "1970-01-01T00:00:00.000Z",
    "includeRoot": false
  }
}