listAppointments

List appointments: org-wide for a team-admin key, the key owner's own otherwise (MEMBER keys always only their own, whatever the filters). Optional participants (listTeammates userIds, same-org), startDate/endDate, completed, searchTerm. Each row has times, location, linked contacts and participants. PAGING: this operation IS cursor-paginated, so "show me the rest" is answerable here. When canFetchNext is true, re-call with the SAME filters and cursor set to the LAST row's id to get the rows after it; repeat until canFetchNext is false. Forward only: there is no backwards page, so to revisit earlier rows restart from the top. Keep every filter identical between pages; changing one restarts the walk. total is the unpaged match count for the filters, so nothing is silently truncated. A LIST, not a conflict check: it sees only what Goliath recorded as an appointment; checkAvailability says whether a slot is actually free.

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

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.appointments.listAppointments({})

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: 'listAppointments',
    variables: {}
  }),
})
const { data, errors } = await res.json()

limit is clamped to 50.

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.

participants[String!]

startDateDateTime

endDateDateTime

completedBoolean

searchTermString

limitInt

Default 25.

cursorString

Response

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

response shape

{
  "data": {
    "users": {
      "getUserAppointments": {
        "tasks": [
          {
            "id": "<ID>",
            "title": "…",
            "startDate": "2026-01-01T00:00:00.000Z",
            "endDate": "2026-01-01T00:00:00.000Z",
            "timezone": "IDLW",
            "location": "…",
            "description": "…",
            "outcome": "…",
            "completedAt": "2026-01-01T00:00:00.000Z",
            "appointmentReminderWorkflowGroupId": "<ID>",
            "participants": [
              {
                "id": "<ID>",
                "firstName": "…",
                "lastName": "…"
              }
            ],
            "contacts": [
              {
                "id": "<ID>",
                "name": "…"
              }
            ]
          }
        ],
        "total": 0,
        "canFetchNext": true
      }
    }
  }
}

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