Skip to main content
GET
Read a complete operational schedule

Authorizations

Authorization
string
header
required

Existing Breezy API key. Grants all published reads and scheduling writes in its associated company. No app permission scopes.

Query Parameters

starts_from
string<date-time>
required
starts_before
string<date-time>
required
limit
integer
default:50
Required range: 1 <= x <= 100
cursor
string | null
Maximum string length: 4096
team_member_id
string<uuid> | null
business_unit_id
string<uuid> | null
job_type_id
string<uuid> | null
job_class
enum<string> | null
Available options:
SERVICE,
MAINTENANCE,
ESTIMATE_REPAIR,
ESTIMATE_REPLACE,
INSTALL,
WARRANTY,
CALLBACK,
SALES,
UNKNOWN,
null
canceled
boolean
default:false

Response

Successful read. Clients ignore unrecognized response fields.

data
object[]
required
pagination
object
required
meta
object
required

Generation time and company timezone. generated_at is not a snapshot or synchronization token.