Retrieve a schedule
One of the host's schedules.
bearerAuthAuthorizationBearer <token>A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.
host*stringThe host's id or uid.
schedule_id*stringThe schedule's id.
Coss-Version?"2026-10-10"The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.
"2026-10-10"The schedule.
application/json- response
- response
- …
object*"scheduling.schedule""scheduling.schedule"id*stringhost*stringThe id of the host this schedule belongs to.
name*stringA label for the schedule. Default when none was given.
time_zone*stringThe IANA time zone its rules and overrides are local to.
is_default*booleanWhether this is the host's default schedule, used by event types that don't name one. A host's first schedule always is.
rules*array<>Weekly hours in local time, unchanged across daylight saving.
overrides*array<>Dates whose hours replace the weekly rules.
created_at*stringupdated_at*stringimport { Coss } from "coss";const coss = new Coss({ apiKey: process.env.COSS_API_KEY, baseUrl: "https://api.coss.com",});const { data, error } = await coss.scheduling.schedules.get({ value: "host_01kd2m9a0b1c2d3e4f5g6h7j8m",}, { value: "sched_01kd2m9a0b1c2d3e4f5g6h7j8m",});{ "object": "scheduling.schedule", "id": "sched_01kd2m9a0b1c2d3e4f5g6h7j8m", "host": "host_01kd2m9a0b1c2d3e4f5g6h7j8m", "name": "Clinic hours", "time_zone": "America/New_York", "is_default": true, "rules": [ { "days": [ 1, 2, 3, 4, 5 ], "start": "09:00", "end": "17:00" } ], "overrides": [ { "date": "2027-12-24", "ranges": [] } ], "created_at": "2027-01-01T10:00:00.000Z", "updated_at": "2027-01-01T10:00:00.000Z"}