GoliathDevelopersGet an API key
Reference/Appointmentsgenerated from the gateway manifest

getMyAvailabilitySchedule

The key owner's saved availability schedule.

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

The key owner's saved availability schedule: timezone, weeklyHours, dateOverrides; null if never saved: booking then uses Mon-Fri 9:00-17:00 in a fallback zone (America/New_York, or a booking form's creator's), so start a change from those hours and confirm the zone with them. Read it before setMyAvailabilitySchedule. "weeklyHours" and "dateOverrides" are raw JSON with a FIXED shape, and this text is their only documentation. "weeklyHours": one day rule per bookable weekday, { "day": 0-6 with Sunday = 0 through Saturday = 6, "intervals": [ { "start": "HH:MM", "end": "HH:MM" } ] }; a weekday with no entry is not bookable. "dateOverrides" (optional): exceptions that REPLACE that day's weekly hours, a single date { "date": "YYYY-MM-DD", "intervals": [...] } or a span { "startDate": "YYYY-MM-DD", "endDate": "YYYY-MM-DD", "intervals": [...] }; either may add "repeat": "monthly" (same day-of-month) or "repeat": "yearly" (same month/day); omit "repeat" for a one-off. "intervals": [] means UNAVAILABLE for that date or span (PTO, holidays, "block me off"). The write REJECTS the whole save (nothing stored) when: "weeklyHours" is empty (block a whole week with a "dateOverrides" span instead); a time is not strict 24-hour "HH:MM" ("9:00" and "5pm" are invalid); an interval's "end" is not after its "start"; intervals in one day or override overlap (touching, 09:00-12:00 then 12:00-17:00, is fine); a date is not a real calendar date; a span's "startDate" equals its "endDate" (write a single "date"); or a one-off span's "endDate" is an earlier calendar date than its "startDate". A one-off span may cross a month or year end with the dates in full ("2026-12-20" to "2027-01-02"): do NOT add "repeat" to make a one-time absence span the year end, that makes it recur every year. Only a RECURRING span may have an "endDate" that reads earlier than its "startDate" ("12-29" to "01-02" every year), which is how it wraps. Example of a complete valid payload: {"timezone":"America/Chicago","weeklyHours":[{"day":1,"intervals":[{"start":"09:00","end":"12:00"},{"start":"13:00","end":"17:00"}]},{"day":3,"intervals":[{"start":"09:00","end":"17:00"}]},{"day":5,"intervals":[{"start":"09:00","end":"15:00"}]}],"dateOverrides":[{"date":"2026-12-24","intervals":[{"start":"09:00","end":"12:00"}]},{"startDate":"2026-11-23","endDate":"2026-11-27","intervals":[],"repeat":"yearly"}]}

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getMyAvailabilitySchedule",
    "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.getMyAvailabilitySchedule()
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: 'getMyAvailabilitySchedule',
    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": {
    "availabilityScheduleQuery": {
      "mySchedule": {
        "id": "<ID>",
        "userId": "<ID>",
        "timezone": "…",
        "weeklyHours": "…",
        "dateOverrides": "…",
        "updatedAt": "2026-01-01T00:00:00.000Z"
      }
    }
  }
}

Errors

Behaviour

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