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

Lists company rooms

GET
/rooms
Retrieves a paginated list of all rooms available in the company. Supports optional filtering by office IDs using a comma-separated list of UUIDs. Returns room details including room ID, name, capacity, description, active status, office ID, and timezone. Results are paginated using limit and offset parameters.

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/rooms?offset&limit&officeIds' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK
application/json
List of rooms retrieved successfully
Body

Example
{
    "total": 100,
    "limit": 10,
    "offset": 0,
    "data": [
        {
            "capacity": 10,
            "description": "A large conference room with video conferencing equipment",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "isActive": true,
            "name": "Conference Room A",
            "officeId": "ca99dd78-2efb-49eb-a254-be0e3d56ca15",
            "timezone": "Europe/London"
        }
    ]
}
🟠401Unauthorized
🟠403Forbidden
Previous
Lists company scheduling options
Next
Gets a single room
Built with