Public API
  1. Scheduling
Public API
  • Welcome to the deskbird Public API
  • Users
    • Lists company users
      GET
    • Lists single company user
      GET
  • Bookings
    • Lists company bookings
      GET
    • Creates a new resource booking
      POST
    • Gets a single company booking
      GET
    • Updates an existing booking
      PATCH
    • Cancels a booking
      PATCH
    • Checks in to a booking
      PATCH
    • Releases a booking early
      PATCH
  • Groups
    • Lists company user groups
      GET
    • Lists single company user group
      GET
  • Resources
    • Gets a resource by ID
      GET
    • Lists company resources
      GET
  • Offices
    • Lists company offices
      GET
    • Checks a user into an office
      POST
  • Scheduling
    • Lists company scheduling statuses
      GET
    • Deletes scheduling statuses by IDs
      DELETE
    • Adds new scheduling statuses for a user
      POST
  • Scheduling Options
    • Lists company scheduling options
      GET
  • Rooms
    • Lists company rooms
      GET
    • Gets a single room
      GET
    • Lists room bookings
      GET
    • Creates a room booking
      POST
    • Gets a single room booking
      GET
    • Updates a room booking
      PATCH
    • Checks in to a room booking
      PATCH
    • Cancels a room booking
      PATCH
  • Schemas
    • BookingStatus
    • Provider
    • ResourceType
    • GuestEmbeddedResponse
    • UserStatus
    • ResourceEmbeddedResponse
    • UserIncludeOptions
    • UserEmbeddedResponse
    • BookingResponse
    • PaginatedBookingResponse
    • AddressResponse
    • OfficeResponse
    • BookingHistoryResponse
    • ResourceResponse
    • EnvelopedOfficeResponse
    • PaginatedResourceResponse
    • CheckUserIntoOfficeBody
    • CreateBookingGuestDto
    • CreateBookingDto
    • UpdateBookingDto
    • CheckInDto
    • OpeningHourResponse
    • OpeningHoursResponse
    • SharedResourceAccessInfoResponse
    • DedicatedResourceAccessInfoResponse
    • SchedulingOutput
    • UserStatusInput
    • AddUserStatusesInput
    • SchedulingOptionOutput
    • AttendeeResponse
    • RoomBookingResponse
    • PaginatedRoomBookingResponse
    • RoomBookingDetailedResponse
    • AttendeeDto
    • RoomResponse
    • PaginatedRoomResponse
    • CreateRoomBookingDto
    • UpdateRoomBookingDto
  1. Scheduling

Lists company scheduling statuses

GET
/scheduling
Retrieves a paginated list of scheduling statuses for the company within a specified date range. Supports filtering by user IDs (comma-separated), office IDs (comma-separated), and scheduling option IDs (comma-separated). Returns scheduling entries with user information (if not anonymized), office details, scheduling option details, duration (full_day, morning, afternoon), external status information, and calendar sync data. Results are paginated using limit and offset parameters. Date format is YYYY-MM-DD.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://connect.deskbird.com/scheduling?offset&limit&startDate&endDate&userIds&optionIds&officeIds' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK
application/json
List of company scheduling statuses
Body

Example
{
    "id": "84cc5919-f9c4-4c39-9138-fdec194500e7",
    "day": "2025-01-01",
    "userId": "d6d04c0a-345d-4502-83f1-de8100248770",
    "officeId": "123",
    "optionId": "d76e6b2a-a9ce-41b9-9cc6-f297a92e9c8d",
    "externalStatus": false,
    "externalStatusId": "60266b80-9288-47c9-a673-a9acd3c017a4",
    "externalCalendarEventId": "630fde47-dbaa-44ff-91ad-e523e5b7dc3d",
    "duration": "full_day",
    "anonymized": false,
    "user": {},
    "option": {
        "id": "46e51f33-2b6e-43d2-b4d8-d1e79ba34458",
        "name": "Mobile work",
        "type": "mobile_work",
        "color": "#916BFF",
        "order": 1,
        "isPrimary": false,
        "isActive": true,
        "policyRule": "remote"
    },
    "office": {
        "id": "1234",
        "name": "Office 1",
        "address": {
            "street": "123 Main St",
            "streetNo": "123",
            "extra": "Apt 1",
            "postalCode": "12345",
            "city": "Anytown",
            "state": "CA",
            "country": "USA",
            "countryCode": "US",
            "latitude": 48.858157,
            "longitude": 2.2922362,
            "radius": 100,
            "timeZone": "America/New_York"
        },
        "openingHours": {
            "mon": {
                "openingTime": "09:00",
                "closingTime": "18:00",
                "midday": "12:00",
                "isOpen24Hours": false,
                "isOpen": true
            },
            "tue": {
                "openingTime": "09:00",
                "closingTime": "18:00",
                "midday": "12:00",
                "isOpen24Hours": false,
                "isOpen": true
            },
            "wed": {
                "openingTime": "09:00",
                "closingTime": "18:00",
                "midday": "12:00",
                "isOpen24Hours": false,
                "isOpen": true
            },
            "thu": {
                "openingTime": "09:00",
                "closingTime": "18:00",
                "midday": "12:00",
                "isOpen24Hours": false,
                "isOpen": true
            },
            "fri": {
                "openingTime": "09:00",
                "closingTime": "18:00",
                "midday": "12:00",
                "isOpen24Hours": false,
                "isOpen": true
            },
            "sat": {
                "openingTime": "09:00",
                "closingTime": "18:00",
                "midday": "12:00",
                "isOpen24Hours": false,
                "isOpen": true
            },
            "sun": {
                "openingTime": "09:00",
                "closingTime": "18:00",
                "midday": "12:00",
                "isOpen24Hours": false,
                "isOpen": true
            }
        }
    }
}
Previous
Checks a user into an office
Next
Deletes scheduling statuses by IDs
Built with