Public API
  1. Rooms
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
    • 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
    • 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. 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 --request POST '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
Body

Example
{
    "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",
    "title": "Team Meeting",
    "type": "occurrence",
    "userId": "user-123",
    "description": "Weekly team standup meeting"
}
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
🟠409Conflict
Previous
Lists room bookings
Next
Gets a single room booking
Built with