getCallList

One call list with its progress, plus one page of its contacts in dial order: each slot's position, status (PENDING = still to call, IN_PROGRESS = being dialed, COMPLETED, SKIPPED with skipReason), the outcome (disposition), numbers tried and the contact. limit defaults to 50 (max 200); pass the returned nextFromPosition as fromPosition for the next page, and statuses to see only some slots. A list that is gone, or private to someone else, is refused with an error (NOT_FOUND or FORBIDDEN), not returned empty.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getCallList",
    "variables": {
      "callListId": "<callListId>"
    }
  }'

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.callLists.getCallList({
  callListId: '<callListId>'
})

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: 'getCallList',
    variables: {
      callListId: '<callListId>'
    }
  }),
})
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.

callListIdID!required

fromPositionInt

limitInt

Default 50.

statuses[String!]

Response

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

response shape

{
  "data": {
    "callListsQuery": {
      "callList": {
        "id": "<ID>",
        "name": "…",
        "status": "…",
        "visibilityScope": "…",
        "maxNumbersPerContact": 0,
        "includeRelatives": true,
        "overrideDnc": true,
        "overrideLitigator": true,
        "cursorPosition": 0,
        "startedAt": "2026-01-01T00:00:00.000Z",
        "endedAt": "2026-01-01T00:00:00.000Z",
        "dialPath": "…",
        "createdByUser": {
          "id": "<ID>",
          "firstName": "…",
          "lastName": "…"
        },
        "lockedByUser": {
          "id": "<ID>",
          "firstName": "…",
          "lastName": "…"
        },
        "reachedTag": {
          "id": "<ID>",
          "name": "…"
        },
        "counts": {
          "total": 0,
          "pending": 0,
          "completed": 0,
          "skipped": 0,
          "dials": 0,
          "byDisposition": [
            {
              "disposition": "…",
              "count": 0
            }
          ]
        }
      },
      "callListItems": {
        "items": [
          {
            "id": "<ID>",
            "position": 0,
            "status": "…",
            "skipReason": "…",
            "disposition": "…",
            "phonesTried": [
              "…"
            ],
            "completedAt": "2026-01-01T00:00:00.000Z",
            "contact": {
              "id": "<ID>",
              "name": "…"
            }
          }
        ],
        "total": 0,
        "nextFromPosition": 0
      }
    }
  }
}

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.

Variables

Response

Errors

Behaviour

Related