HomeBook an Intro CallStartup Program
API Endpoints

Get availability

get
https://api-stage.onsched.com/v3/availability

Availability can be expensive. Narrow your search where possible.

  • If searching all resources, query only a single date
  • For multi-day searches, specify a resource via ResourceIds
  • Required: ServiceId, startDate, endDate (ISO 8601: e.g., 2016-10-30T09:00:00-05:00)
  • Optional: ResourceIds (recommended when known)

roundRobin:

  • RANDOM: when resource choice does not matter
  • BALANCED: pick resource with fewest appointments
  • NONE: return every resource that is available during a slot (no round-robin selection)
  • COMBINED: require all specified resources to be available for a single appointment

Use syncExternal to include events from external calendars (Google, Outlook). Use timezone (IANA name like America/New_York) to convert returned times from UTC.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date-time
required
date-time
required
uuid
uuid
required
ResourceIds
array of uuids

Create query param per resource, ex. ResourceIds=uuid1&ResourceIds=uuid2

ResourceIds
string
enum
Defaults to BALANCED
Allowed:
boolean
Defaults to false
string

IANA timezone name (e.g. 'America/New_York', 'Europe/London')

integer
≥ 1
integer
≥ 1
boolean
Defaults to false
boolean
Defaults to false
uuid

When true, slots ending at the operating-day close can extend padding past operating hours

Responses
200

Returns availability array for a company

Updated 22 days ago

Language
Credentials
Required Scopes
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago