Read Schedule
Read the description, time zone, and team owner of a specific schedule.
Read schedule is accessible by Team-specific API keys if the team owns the specified schedule.
Options
| Field | Definition | Type | Required |
|---|---|---|---|
| Schedule Identifier |
Specifies how you identify the schedule. Choose one of the following options:
|
Dropdown |
TRUE |
Input
These fields are dynamically generated based on the fields selected in Options.
| Field | Definition | Type | Required |
|---|---|---|---|
| Schedule ID |
Unique ID of the schedule. Displays when Schedule ID is selected from the Schedule Identifier Options. |
Text |
TRUE |
| Schedule Name |
Name of the schedule. Displays when Schedule Name is selected from the Schedule Identifier Option. |
Text |
TRUE |
Output
| Field | Definition | Type |
|---|---|---|
| Schedule Info | ||
| ID | Unique ID of the schedule. |
Object |
| Name | Name of the schedule. |
Text |
| Description | Description for the schedule. |
Text |
| Time Zone | Timezone of the schedule. |
Dropdown |
| Enabled | Enable/disable state of the schedule. True if enabled; otherwise, False. |
True/False |
| Owner Team ID | Unique ID of the team that is assigned to the schedule. |
Text |
| Owner Team Name | Name of the team that is assigned to the schedule. |
Text |
| Rotations | List of schedule rotations for the schedule. |
List of Objects |