coss.comdocs

Retrieve an out of office entry

GET
/v1/scheduling/out_of_office/{id}

One entry.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.

Path Parameters

id*string

The entry's id.

Header Parameters

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.

Value in"2026-10-10"

Response Body

The entry.

application/json
  1. response
object*"scheduling.out_of_office"
Value in"scheduling.out_of_office"
id*string
host*string
start*string
end*string
all_day*|

How it was given, when it was as whole dates.

reason*string
notes*string|null
public_message*string|null
show_on_calendar*boolean
delegates*array<string>

Who can be booked in their place.

existing_bookings*string
Value in"leave""reassign"
external_id*string|null
group*|

Shared by the entries one request made for several hosts.

source*string
Value in"api""host""manager""dashboard""holiday"
created_at*string
updated_at*string
import { Coss } from "coss";const coss = new Coss({  apiKey: process.env.COSS_API_KEY,  baseUrl: "https://api.coss.com",});const { data, error } = await coss.scheduling.outOfOffice.get("ooo_01kd2m9a0b1c2d3e4f5g6h7j8m");
{  "object": "scheduling.out_of_office",  "id": "ooo_01kd2m9a0b1c2d3e4f5g6h7j8m",  "host": "host_01kd2m9a0b1c2d3e4f5g6h7j8m",  "start": "2027-08-02T04:00:00.000Z",  "end": "2027-08-14T04:00:00.000Z",  "all_day": {    "start_date": "2027-08-02",    "end_date": "2027-08-13",    "time_zone": "America/New_York"  },  "reason": "vacation",  "notes": null,  "public_message": "Back on the 16th.",  "show_on_calendar": true,  "delegates": [    "host_01kd2m9a0b1c2d3e4f5g6h7j8n"  ],  "existing_bookings": "leave",  "external_id": null,  "group": null,  "source": "api",  "created_at": "2027-01-01T10:00:00.000Z",  "updated_at": "2027-01-01T10:00:00.000Z"}