1. Rooms
Public API
  • Welcome to the deskbird developer docs
  • Public API
    • Overview
    • Users
      • Lists company users
      • Retrieves a single company user
    • Bookings
      • Lists company bookings
      • Creates a new resource booking
      • Gets a single company booking
      • Updates an existing booking
      • Cancels a booking
      • Checks in to a booking
      • Releases a booking early
    • Groups
      • Lists company user groups
      • Retrieves a single company user group
    • Resources
      • Gets a resource by ID
      • Lists company resources
    • Offices
      • Lists company offices
      • Checks a user into an office
    • Scheduling
      • Lists company scheduling statuses
      • Deletes scheduling statuses by IDs
      • Adds new scheduling statuses for a user
    • Scheduling Options
      • Lists company scheduling options
    • Rooms
      • Lists company rooms
        GET
      • Gets a single room
        GET
      • Creates a room booking
        POST
      • Lists room bookings
        GET
      • Gets a single room booking
        GET
      • Updates a room booking
        PATCH
      • Checks in to a room booking
        PATCH
      • Cancels a room booking
        PATCH
      • Lists company room bookings
        GET
    • Floors
      • Lists company floors
    • Zones
      • Lists company zones
    • Tickets
      • Updates a ticket
    • Sensors
      • Lists company monitors
  • MCP server
    • Overview
    • Authentication
    • Tools reference
  • Sensors
    • Lists company network configurations
  • Visitors
    • Lists company visit types
    • Lists company visits
    • Gets a single company visit
  • Tickets
    • Lists company tickets
    • Gets a single company ticket
    • Lists ticket categories
  • Service requests
    • Lists company service requests
    • Lists service categories of an office
    • Gets a single company service request
  • Schemas
    • Provider
    • UserStatus
    • UserIncludeOptions
    • BookingStatus
    • GuestEmbeddedResponse
    • UserEmbeddedResponse
    • ResourceEmbeddedResponse
    • BookingHistoryResponse
    • BookingResponse
    • PaginatedBookingResponse
    • CreateBookingGuestDto
    • CreateBookingDto
    • UpdateBookingDto
    • CheckInDto
    • AddressResponse
    • OpeningHourResponse
    • OpeningHoursResponse
    • OfficeResponse
    • EnvelopedOfficeResponse
    • CheckUserIntoOfficeBody
    • SharedResourceAccessInfoResponse
    • DedicatedResourceAccessInfoResponse
    • EquipmentResponse
    • ResourceResponse
    • ResourceType
    • PaginatedResourceResponse
    • SchedulingOutput
    • UserStatusInput
    • AddUserStatusesInput
    • SchedulingOptionOutput
    • AttendeeResponse
    • RoomBookingResponse
    • PaginatedRoomBookingResponse
    • RoomBookingDetailedResponse
    • AttendeeDto
    • RoomResponse
    • PaginatedRoomResponse
    • CreateRoomBookingDto
    • UpdateRoomBookingDto
    • FloorResponse
    • PaginatedFloorResponse
    • AssignedGroupResponse
    • ZoneResponse
    • PaginatedZoneResponse
    • UpdateTicketDto
    • MonitorState
    • MonitorOfficeResponse
    • MonitorFloorResponse
    • MonitorAreaResponse
    • MonitorDeskResponse
    • MonitorMappingResponse
    • MonitorResponse
    • PaginatedMonitorResponse
    • NetworkConflictSignal
    • NetworkConflictResponse
    • NetworkResponse
    • PaginatedNetworkResponse
    • TicketCategoryReferenceResponse
    • VisitTypeResponse
    • TicketUserResponse
    • EnvelopedVisitTypeResponse
    • TicketCustomFieldResponse
    • TicketAttachmentResponse
    • TicketResponse
    • PaginatedTicketResponse
    • TicketCommentResponse
    • TicketDetailsResponse
    • TicketCategoryCustomFieldResponse
    • TicketCategoryResponse
    • EnvelopedTicketCategoryResponse
    • RequestedItemResponse
    • RequestedCategoryResponse
    • VisitTypeReferenceResponse
    • ServiceRequestResponse
    • VisitHostResponse
    • PaginatedServiceRequestResponse
    • ServiceItemResponse
    • ServiceCategoryResponse
    • PaginatedVisitResponse
    • EnvelopedServiceCategoryResponse
    • VisitorResponse
    • VisitResponse
  1. Rooms

Creates a room booking

POST
/rooms/{roomId}/bookings
Creates a new booking for the specified room. Requires room ID, start time, duration (in seconds), title, description (optional), privacy flag, and optionally a user ID (null for anonymous bookings). Supports adding attendees with their email addresses. Returns the created booking with full details including all booking metadata.

Request

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

Header Params

Body Params application/jsonRequired

Example
{
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "startTime": "2024-01-01T10:00:00.000Z",
    "durationInSeconds": 3600,
    "title": "Team Meeting",
    "description": "Weekly team sync meeting to discuss project updates",
    "attendees": [
        {
            "email": "john.doe@example.com"
        }
    ],
    "isPrivate": false
}

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 'https://connect.deskbird.com/rooms//bookings' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "startTime": "2024-01-01T10:00:00.000Z",
    "durationInSeconds": 3600,
    "title": "Team Meeting",
    "description": "Weekly team sync meeting to discuss project updates",
    "attendees": [
        {
            "email": "john.doe@example.com"
        }
    ],
    "isPrivate": false
}'

Responses

🟢201Created
application/json
Room booking created successfully
Bodyapplication/json

Example
{
    "createdAt": "2024-01-01T09:00:00.000Z",
    "attendees": [
        {
            "email": "john.doe@example.com"
        }
    ],
    "durationInSeconds": 3600,
    "id": "booking-123",
    "isCheckedIn": false,
    "isPrivate": false,
    "officeId": "office-123",
    "roomId": "room-123",
    "startTime": "2024-01-01T10:00:00Z",
    "status": "accepted",
    "title": "Team Meeting",
    "type": "occurrence",
    "userId": "user-123",
    "updatedAt": "2024-01-01T09:30:00.000Z",
    "description": "Weekly team standup meeting"
}
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠409Conflict
Previous
Gets a single room
Next
Lists room bookings
Built with