Skip to main content
GET
Get Resolved Schedule

Headers

auth
string
required
Example:

"auth"

time-zone
string

IANA timezone for the returned ISO timestamps. Defaults to Asia/Kolkata.

Example:

"Asia/Kolkata"

Query Parameters

entity_id
string
required

Comma-separated entity ids to resolve. Deduplicated; max 20 values.

Example:

"doc_12345,doc_67890"

location_id
string
required

Location/clinic id to resolve against.

Example:

"c-98765"

bookable_by
enum<string>

Which schedules: patient (patients book by themselves), front_desk (anyone booking from the clinic side: your reception, front desk, doctor, clinic staff, or your own EMR) or ipd (admitted patients). Defaults to front_desk.

Available options:
patient,
front_desk,
ipd
product_id
enum<string>

Deprecated, will be removed soon. Use bookable_by: product-widget = patient, product-emr = front_desk, product-ipd = ipd. Sending both returns 400.

Available options:
product-emr,
product-widget,
product-ipd
startTime
string
required

Range start, ISO datetime. Must be before endTime; range capped at 400 days.

Example:

"2026-09-22T00:00:00.000Z"

endTime
string
required

Range end, ISO datetime.

Example:

"2026-09-29T00:00:00.000Z"

applyBlock
enum<string>

Whether to apply blackout blocks when resolving bounds.

Available options:
true,
false
include_rules
enum<string>

When true, includes rules and config per schedule alongside the resolved bounds.

Available options:
true,
false

Response

OK

success
boolean
Example:

true

status
integer
Example:

200

data
object

Keyed by entity_id. Each value is a list, because one doctor can have many schedules (e.g. morning and evening).