coss.comdocs

Preview a recurring series

POST
/v1/scheduling/series/preview

Which occurrences would be free, without booking anything.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

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"

Request Body

application/json
  1. body
event_type*string

The event type's id or uid.

start*string

An ISO 8601 instant with an offset.

host?string

A specific host (id or uid). Default: chosen fairly from those free.

attributes?

Only choose among pool hosts matching all of these.

duration_minutes?integer

One of the event type's duration_options.

Range5 <= value <= 1440
attendee*

Name and email are only needed if coss.com notifies this attendee.

answers?

Answers to the event type's questions. Stored encrypted, and returned only by retrieving the booking.

location?||||

One of the event type's locations, with your link filled in if it has none.

metadata?

Your own key-value pairs. Don't put sensitive data here.

recurrence*
on_conflict?string

If an occurrence isn't free: book nothing, or book the rest and report it.

Default"reject"
Value in"reject""skip"

Response Body

Each occurrence.

application/json
  1. response
object*"list"
Value in"list"
data*array<>
has_more*false
Value infalse
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.series.preview({  event_type: "evtype_01kd2m9a0b1c2d3e4f5g6h7j8m",  start: "2027-01-04T15:00:00.000Z",  attendee: {    uid: "patient_77",    time_zone: "America/New_York",  },  recurrence: {    frequency: "weekly",    interval: 1,    count: 12,  },});
{  "object": "list",  "data": [    {      "start": "2027-01-04T15:00:00.000Z",      "available": true,      "reason": null,      "hosts": [        "host_01kd2m9a0b1c2d3e4f5g6h7j8m"      ]    }  ],  "has_more": false}