Skip to main content

Schedule

idinteger

Unique identifier for the schedule

namestring

Name of the schedule

organization_idinteger

ID of the organization this schedule belongs to

security_group_idinteger

ID of the security group this schedule belongs to (if any)

created_atdate-time

Timestamp when the schedule was created

updated_atdate-time

Timestamp when the schedule was last updated

regular_schedules object[]

List of regular schedules associated with this schedule

  • Array [
  • idinteger

    Unique identifier for the regular schedule

    schedule_idinteger

    ID of the parent schedule

    days object

    Days of the week when this schedule is active

    monboolean
    tueboolean
    wedboolean
    thuboolean
    friboolean
    satboolean
    sunboolean
    start_timetime

    Start time for this schedule

    end_timetime

    End time for this schedule

  • ]
  • special_schedules object[]

    List of special schedules associated with this schedule

  • Array [
  • idinteger

    Unique identifier for the special schedule

    schedule_idinteger

    ID of the parent schedule

    datedate

    Date for this special schedule

    start_timetime

    Start time for this schedule

    end_timetime

    End time for this schedule

    closed_all_dayboolean

    Whether the schedule is closed all day

  • ]
  • openboolean

    Whether the schedule is currently open

    next_open_timedate-time

    The next time the schedule will be open

    Schedule
    {
    "id": 0,
    "name": "string",
    "organization_id": 0,
    "security_group_id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "regular_schedules": [
    {
    "id": 0,
    "schedule_id": 0,
    "days": {
    "mon": true,
    "tue": true,
    "wed": true,
    "thu": true,
    "fri": true,
    "sat": true,
    "sun": true
    },
    "start_time": "string",
    "end_time": "string"
    }
    ],
    "special_schedules": [
    {
    "id": 0,
    "schedule_id": 0,
    "date": "2024-07-29",
    "start_time": "string",
    "end_time": "string",
    "closed_all_day": true
    }
    ],
    "open": true,
    "next_open_time": "2024-07-29T15:51:28.071Z"
    }