> ## Documentation Index
> Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List all schedules

> Retrieves a list of all schedule objects belonging to your workspace. The schedules are returned sorted by creation date, with the most recently created schedules appearing first.



## OpenAPI

````yaml /api/en/schedules.yaml get /chrono/schedules
openapi: 3.0.3
info:
  title: Altostrat Schedules API
  version: 1.0.0
  description: >-
    The Altostrat Schedules API provides a time-based scheduling engine to
    control when automation policies and network configurations are active.


    It is a key component of the Altostrat SDX platform, enabling developers to
    implement time-of-day routing, enforce bandwidth limits during business
    hours, or activate specific security policies on a recurring basis for their
    MikroTik networks.


    This API allows you to programmatically manage:

    - **Schedules:** The top-level containers for a set of time-based rules,
    each with a specific timezone.

    - **Time Slots:** The recurring weekly time ranges (e.g., Monday
    09:00-17:00) during which a schedule is considered 'active'.

    - **Metadata:** Custom key-value pairs that can be attached to a schedule to
    integrate with other automation systems.


    Developers use this API to create and manage the temporal logic that governs
    how and when their network automation and AI-driven policies are applied.
servers:
  - url: https://v1.api.altostrat.io
security:
  - BearerAuth: []
tags:
  - name: Schedules
    description: Manage schedules, their time slots, and associated metadata.
paths:
  /chrono/schedules:
    get:
      tags:
        - Schedules
      summary: List all schedules
      description: >-
        Retrieves a list of all schedule objects belonging to your workspace.
        The schedules are returned sorted by creation date, with the most
        recently created schedules appearing first.
      operationId: listSchedules
      responses:
        '200':
          description: A list of schedule objects.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Schedule'
        '401':
          description: Unauthorized - Authentication information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error - An unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    Schedule:
      type: object
      description: >-
        Represents a schedule object that defines when a policy or configuration
        is active.
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier for the schedule.
          example: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
        name:
          type: string
          description: A human-readable name for the schedule.
          example: Business Hours Policy
        timezone:
          type: string
          description: >-
            The IANA timezone identifier that this schedule operates in. All
            `start` and `end` times are relative to this timezone.
          example: Australia/Sydney
        active:
          type: boolean
          description: >-
            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:
          type: string
          format: date-time
          description: The timestamp of when the schedule was last updated.
          example: '2025-10-29T01:43:31Z'
        created_at:
          type: string
          format: date-time
          description: The timestamp of when the schedule was created.
          example: '2025-10-29T01:43:31Z'
        hours:
          type: array
          description: >-
            A list of time slots that define the active periods for this
            schedule.
          items:
            $ref: '#/components/schemas/Slot'
        metadata:
          type: array
          description: >-
            A list of key-value pairs that can be used to store additional
            information about the schedule.
          items:
            $ref: '#/components/schemas/Metadata'
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: A broad category for the error (e.g., 'invalid_request_error').
          example: invalid_request_error
        code:
          type: string
          description: A short, unique string identifying the specific error.
          example: parameter_invalid
        message:
          type: string
          description: A human-readable description of what went wrong.
          example: The 'timezone' parameter must be a valid IANA Time Zone.
        doc_url:
          type: string
          description: >-
            A direct link to the documentation page for this specific error
            code.
          example: https://docs.altostrat.io/errors/parameter_invalid
    Slot:
      type: object
      description: A specific time range on a given day of the week.
      properties:
        day:
          type: string
          description: The day of the week for this time slot.
          enum:
            - sunday
            - monday
            - tuesday
            - wednesday
            - thursday
            - friday
            - saturday
          example: monday
        start:
          type: string
          description: The start time of the slot in `HH:mm` format (24-hour clock).
          example: '09:00'
        end:
          type: string
          description: The end time of the slot in `HH:mm` format (24-hour clock).
          example: '17:00'
    Metadata:
      type: object
      description: A key-value pair for storing custom data.
      properties:
        key:
          type: string
          description: The metadata key. Maximum 50 characters.
          example: policy_id
        value:
          type: string
          description: The metadata value. Maximum 200 characters.
          example: pol_12345
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Enter your API key in the format: Bearer {key}'

````