Skip to main content
GET
Retrieve a schedule

Authorizations

Authorization
string
header
required

Enter your API key in the format: Bearer {key}

Path Parameters

scheduleId
string<uuid>
required

The unique identifier (UUID) for the schedule.

Example:

"9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"

Response

The schedule object.

Represents a schedule object that defines when a policy or configuration is active.

id
string<uuid>

The unique identifier for the schedule.

Example:

"9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"

name
string

A human-readable name for the schedule.

Example:

"Business Hours Policy"

timezone
string

The IANA timezone identifier that this schedule operates in. All start and end times are relative to this timezone.

Example:

"Australia/Sydney"

active
boolean

A read-only flag indicating whether the schedule is currently within an active time slot. This is calculated by the system.

Example:

true

updated_at
string<date-time>

The timestamp of when the schedule was last updated.

Example:

"2025-10-29T01:43:31Z"

created_at
string<date-time>

The timestamp of when the schedule was created.

Example:

"2025-10-29T01:43:31Z"

hours
object[]

A list of time slots that define the active periods for this schedule.

metadata
object[]

A list of key-value pairs that can be used to store additional information about the schedule.