GoliathDevelopersGet an API key
Reference/Employeesgenerated from the gateway manifest

getContactEmployees

The AI employees on one contact, as the contact page's card shows them. aiEmployees[].id is the attachment id setEmployeeSchedule and clearEmployeeSchedule take.

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

The AI employees on one contact, as the contact page's card shows them. aiEmployees[].id is the attachment id setEmployeeSchedule and clearEmployeeSchedule take (agentId is the employee); status PAUSED means it stopped working this contact (REMOVED, with includeRemoved, means it was taken off); isWorkingNow means it is mid-conversation. upcomingAgentRuns is what they will do next, soonest first, AT MOST 25 with no total (when 25 come back more may be booked, so after acting on these read again before saying none are left): a CRON row is a schedule's next run, a FOLLOW_UP row a follow-up the employee booked itself, whose id cancelEmployeeFollowUp takes.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getContactEmployees",
    "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.employees.getContactEmployees({
  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: 'getContactEmployees',
    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
includeRemovedBoolean

Default false.

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>",
        "aiEmployees": [
          {
            "id": "<ID>",
            "agentId": "<ID>",
            "name": "…",
            "status": "ACTIVE",
            "isWorkingNow": true,
            "schedule": {
              "cronExpression": "…",
              "timezone": "…",
              "status": "ACTIVE",
              "nextFireAt": "2026-01-01T00:00:00.000Z",
              "lastFiredAt": "2026-01-01T00:00:00.000Z",
              "maxRuns": 0,
              "runCount": 0
            }
          }
        ],
        "upcomingAgentRuns": [
          {
            "id": "<ID>",
            "agentId": "<ID>",
            "agentName": "…",
            "kind": "CRON",
            "fireAt": "2026-01-01T00:00:00.000Z",
            "cronExpression": "…",
            "timezone": "…",
            "runsRemaining": 0
          }
        ]
      }
    }
  }
}

Errors

Behaviour

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