Skip to main content
GET
Get a schedule
Beta: this endpoint may change or be removed without notice while in beta. There is no compatibility promise until it reaches general availability.

Authorizations

Authorization
string
header
required

API tokens are passed as Bearer tokens.

Path Parameters

scheduleId
string
required

a schedule ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:sch_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Example:

"sch_a1b2c3d4e5f64789a1b2c3d4e5f64789"

Response

Success

id
string
required

Canonical schedule ID (sch_ followed by 32 lowercase hexadecimal UUID characters).

Pattern: ^sch_[0-9a-f]{32}$
Example:

"sch_a1b2c3d4e5f64789a1b2c3d4e5f64789"

application
object
required
status
enum<string>
required
Available options:
SCHEDULED,
PARTIALLY_DECLINED,
CANCELED
start_at
string<date-time>
required

ISO 8601 timestamp.

end_at
string<date-time>
required

ISO 8601 timestamp.

timezone
string
required
interviews
object[]
required
task
object | null
required
created_at
string<date-time>
required

ISO 8601 timestamp.

updated_at
string<date-time>
required

ISO 8601 timestamp.

app_url
string<uri>
required