Skip to main content
GET
/
chrono
/
schedules
/
{scheduleId}
Retrieve a schedule
curl --request GET \
  --url https://api.altostrat.io/chrono/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "name": "Business Hours Policy",
  "timezone": "Australia/Sydney",
  "active": true,
  "updated_at": "2025-10-29T01:43:31Z",
  "created_at": "2025-10-29T01:43:31Z",
  "hours": [
    {
      "day": "monday",
      "start": "09:00",
      "end": "17:00"
    }
  ],
  "metadata": [
    {
      "key": "policy_id",
      "value": "pol_12345"
    }
  ]
}

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.