GoliathDevelopersGet an API key
Reference/Appointmentsgenerated from the gateway manifest

listAppointmentReminders

The organization's appointment reminders.

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

The organization's appointment reminders: each with its steps (one SMS each, its message and amountBefore + unitBefore lead time, longest lead first) and isGlobal (true on the flagged default). The org DEFAULT reminder ("Run for every appointment") is attached automatically to booking-page and AI-employee bookings and preselected in the app's appointment form; NOT to appointments created through this API (pass its id as appointmentReminderWorkflowGroupId on createAppointment) nor to existing ones (updateAppointment attaches it). With none flagged and exactly ONE reminder, that one is the default anyway. Attach one by passing its id as appointmentReminderWorkflowGroupId to createAppointment/updateAppointment (the responses echo it under that name).

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "listAppointmentReminders",
    "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.listAppointmentReminders()
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: 'listAppointmentReminders',
    variables: {}
  }),
})
const { data, errors } = await res.json()

Variables

None. Send "variables": {}.

Response

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

response shape
{
  "data": {
    "appointmentReminderQuery": {
      "listAppointmentReminders": [
        {
          "id": "<ID>",
          "steps": [
            {
              "message": "…",
              "amountBefore": 0,
              "unitBefore": "MINUTES"
            }
          ],
          "isGlobal": true,
          "createdAt": "2026-01-01T00:00:00.000Z"
        }
      ]
    }
  }
}

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.

READlistAppointmentsREADcheckAvailabilityREADgetMyAvailabilityScheduleWRITEcreateAppointmentWRITEupdateAppointmentWRITEdeleteAppointment