GoliathDevelopersGet an API key
Reference/Contactsgenerated from the gateway manifest

getContactConnections

A contact's Links card.

POST/api/v1/callREADreadruns as the key's owner
View as Markdown

A contact's Links card (externalLinks), related people (linkedRelationships, with linkedContactId), relatives not yet contacts (subContacts) and the AI pause in force (aiPause, null when AI is on: its mode, when and until, the reason given, and who paused it: pausedBy a person, pausedByAgentId an AI employee (getEmployee names it), pausedByWorkflowRunId a workflow step, pausedBySystem a named job). For WHICH contacts have AI paused, filter on aiPaused (filterContacts, countContacts) instead of reading contacts one by one. The ids the link and relationship ops take. Merged ids resolve to the survivor.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getContactConnections",
    "variables": {
      "contactId": "<contactId>"
    }
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.contacts.getContactConnections({
  contactId: '<contactId>'
})
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'getContactConnections',
    variables: {
      contactId: '<contactId>'
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

contactIdID!required

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "contactQuery": {
      "contact": {
        "id": "<ID>",
        "externalLinks": [
          {
            "id": "<ID>",
            "title": "…",
            "url": "…"
          }
        ],
        "linkedRelationships": [
          {
            "id": "<ID>",
            "relation": "…",
            "note": "…",
            "linkedContactId": "<ID>"
          }
        ],
        "subContacts": [
          {
            "id": "<ID>",
            "name": "…",
            "relation": "…"
          }
        ],
        "aiPause": {
          "mode": "ALL",
          "pausedAt": "2026-01-01T00:00:00.000Z",
          "pausedUntil": "2026-01-01T00:00:00.000Z",
          "reason": "…",
          "pausedBy": {
            "id": "<ID>",
            "firstName": "…",
            "lastName": "…"
          },
          "pausedByAgentId": "<ID>",
          "pausedByWorkflowRunId": "<ID>",
          "pausedBySystem": "…"
        }
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

READgetContactREADgetContactsPropertiesREADfindContactsByNoteREADsearchInteractionsREADcountContactsREADfindContacts