---
title: Schedules
description: "### GET Methods #### Get All Schedules Description Loads all schedules. Route /Schedules/ Authentication This service is secure and requires authentication headers Example Response `{ \"schedules\": [ { \"daysVisible\": 5, \"id\": 123, \"isDefault\": true, \"name\": \"schedule name\", \"timezone\": \"timezone_name\", \"weekdayStart\":…"
url: "https://www.bookedscheduler.com/help/api/api-schedules/"
updated: "2023-01-21"
category: API
---

# Schedules

### GET Methods

#### Get All Schedules

 Description Loads all schedules. Route /Schedules/ Authentication This service is secure and requires authentication headers Example Response `{
    "schedules": [
        {
            "daysVisible": 5,
            "id": 123,
            "isDefault": true,
            "name": "schedule name",
            "timezone": "timezone_name",
            "weekdayStart": 0,
            "availabilityBegin": "2023-01-18T21:09:54-0500",
            "availabilityEnd": "2023-02-07T21:09:54-0500",
            "maxResourcesPerReservation": 10,
            "totalConcurrentReservationsAllowed": 0,
            "links": [],
            "message": null
        }
    ],
    "links": [],
    "message": null
}`

#### Get Schedule

 Description Loads a specific schedule by id. Route /Schedules/:scheduleId Authentication This service is secure and requires authentication headers Example Response `{
    "daysVisible": 5,
    "id": 123,
    "isDefault": true,
    "name": "schedule name",
    "timezone": "timezone_name",
    "weekdayStart": 0,
    "icsUrl": "webcal://url/to/calendar",
    "availabilityStart": "2023-01-18T21:09:54-0500",
    "availabilityEnd": "2023-01-18T21:09:54-0500",
    "maxResourcesPerReservation": 10,
    "totalConcurrentReservationsAllowed": 0,
    "periods": [
        [
            {
                "start": "2023-01-18T21:09:54-0500",
                "end": "2023-01-18T21:09:54-0500",
                "label": "label",
                "startTime": "21:09:54",
                "endTime": "21:09:54",
                "isReservable": true
            }
        ],
        [
            {
                "start": "2023-01-18T21:09:54-0500",
                "end": "2023-01-18T21:09:54-0500",
                "label": "label",
                "startTime": "21:09:54",
                "endTime": "21:09:54",
                "isReservable": true
            }
        ],
        [
            {
                "start": "2023-01-18T21:09:54-0500",
                "end": "2023-01-18T21:09:54-0500",
                "label": "label",
                "startTime": "21:09:54",
                "endTime": "21:09:54",
                "isReservable": true
            }
        ],
        [
            {
                "start": "2023-01-18T21:09:54-0500",
                "end": "2023-01-18T21:09:54-0500",
                "label": "label",
                "startTime": "21:09:54",
                "endTime": "21:09:54",
                "isReservable": true
            }
        ],
        [
            {
                "start": "2023-01-18T21:09:54-0500",
                "end": "2023-01-18T21:09:54-0500",
                "label": "label",
                "startTime": "21:09:54",
                "endTime": "21:09:54",
                "isReservable": true
            }
        ],
        [
            {
                "start": "2023-01-18T21:09:54-0500",
                "end": "2023-01-18T21:09:54-0500",
                "label": "label",
                "startTime": "21:09:54",
                "endTime": "21:09:54",
                "isReservable": true
            }
        ],
        [
            {
                "start": "2023-01-18T21:09:54-0500",
                "end": "2023-01-18T21:09:54-0500",
                "label": "label",
                "startTime": "21:09:54",
                "endTime": "21:09:54",
                "isReservable": true
            }
        ]
    ],
    "links": [],
    "message": null
}`

#### Get Schedule Layout Slots

 Description Loads layout slots for a specific schedule. This is similar to the data shown on the Schedule within Booked.

| Name | Description | Example |
| --- | --- | --- |
| startDateTime | Starting datetime (inclusive) to get slots for. If not set, the default schedule settings will be used. | 2023-01-18T12:00:00-0500 |
| endDateTime | Ending datetime (inclusive) to get slots for. If not set, the default schedule settings will be used. | 2023-01-22T12:00:00-0500 |
| resourceId | Resource to get slots for. If not set, all resources on the schedule will be returned. | 1 |

 Route /Schedules/:scheduleId/Slots Authentication This service is secure and requires authentication headers Example Response `{
    "dates": [
        {
            "date": "2023-01-18T21:09:54-0500",
            "resources": [
                {
                    "slots": [
                        {
                            "slotSpan": 4,
                            "isReserved": true,
                            "label": "username",
                            "isReservable": false,
                            "color": "#ffffff",
                            "startDateTime": "2023-01-18T21:09:54-0500",
                            "endDateTime": "2023-01-18T21:09:54-0500",
                            "reservation": {
                                "referenceNumber": "refnum",
                                "startDate": "2023-01-18T21:09:54-0500",
                                "endDate": "2023-01-18T21:09:54-0500",
                                "firstName": "first",
                                "lastName": "last",
                                "resourceName": "resourcename",
                                "title": "reservation title",
                                "description": "reservation description",
                                "requiresApproval": true,
                                "isRecurring": true,
                                "scheduleId": 22,
                                "userId": 11,
                                "resourceId": 123,
                                "duration": "1 hours 45 minutes",
                                "bufferTime": "1 minutes",
                                "bufferedStartDate": "2023-01-18T21:09:54-0500",
                                "bufferedEndDate": "2023-01-18T21:09:54-0500",
                                "participants": [
                                    "participant name"
                                ],
                                "invitees": [
                                    "invitee name"
                                ],
                                "participatingGuests": [
                                    "guest@email.com"
                                ],
                                "invitedGuests": [
                                    "guest@email.com"
                                ],
                                "coOwners": [
                                    "co owner name"
                                ],
                                "startReminder": 10,
                                "endReminder": 10,
                                "color": "#FFFFFF",
                                "textColor": "#000000",
                                "checkInDate": "2023-01-18T21:09:54-0500",
                                "checkOutDate": "2023-01-18T21:09:54-0500",
                                "originalEndDate": "2023-01-18T21:09:54-0500",
                                "isCheckInEnabled": true,
                                "autoReleaseMinutes": 1,
                                "resourceStatusId": null,
                                "creditsConsumed": 15,
                                "customAttributes": [
                                    {
                                        "id": 123,
                                        "label": "label",
                                        "value": "value",
                                        "links": [],
                                        "message": null
                                    }
                                ],
                                "links": [],
                                "message": null
                            },
                            "links": [],
                            "message": null
                        }
                    ],
                    "resourceId": 1,
                    "resourceName": "resourcename",
                    "links": [],
                    "message": null
                }
            ],
            "links": [],
            "message": null
        }
    ],
    "links": [],
    "message": null
}`