List Calendars of a Service

Lists the available calendars for a service on a specific date.

This endpoint requires the Appointments Manager role.

URL

GET: .../{applicationId}/calendars/{serviceId}/{date}

Headers

Authorization: Bearer <accessToken>

Route Params

• serviceId: GUID, required.

• date: date in YYYY-MM-dd format; required.

Response

200 -> OK

The endpoint returns an array of calendars:

[
    {
        "serviceId": "28147a8f-1693-4d33-8768-abfc95b794ba",
        "date": "2023-07-14T00:00:00",
        "cuIndex": 0,
        "calendarTimestamp": "2023-07-14T10:24:42.897736Z",
        "serviceName": "Consulting",
        "serviceCategoryId": "831e30bd-408d-45be-8a82-c2995909ca10",
        "serviceCategoryName": "Consulting",
        "isCustomerRequired": false,
        "customersDataTableId": "8ab4307c-5f1c-4537-b0d5-718aeea9d2f4",
        "isPhoneNumberRequired": false,
        "phoneNumberFieldTypeId": "4848ba2d-a80a-4f3c-b170-578d19899e2f",
        "isEmailRequired": false,
        "emailFieldTypeId": "cd439a62-c78a-413f-bb42-cc4dd720375c",
        "workingHours": [
            {
                "start": 480,
                "end": 960
            }
        ],
        "user": null,
        "allowAnonymousAgentBooking": true,
        "inboxId": "23ae7d4e-941f-4976-81d9-4431a56c66fa",
        "inboxName": "Consulting",
        "isInAgentsBookingWindow": true,
        "agentsBookingActive": true,
        "isInSelfBookingWindow": true,
        "selfBookingActive": true,
        "stats": {
            "appointmentCount": 1,
            "capacityMinutes": 480,
            "minutesBooked": 15,
            "bookingRate": 0.03125,
            "compMinutesBooked": 12,
            "compBookingRate": 0.025,
            "isFullyBooked": false
        },
        "isPastDate": false,
        "issues": []
    }
]