Public API
  1. Resources
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. Resources

Lists company resources

GET
/resources
Retrieves a paginated list of all resources available in the company. Supports comprehensive filtering by office ID, resource type (flexDesk, parking, other), zone ID, resource IDs (comma-separated), and name (exact match or case-insensitive pattern matching using 'exact:' or 'ilike:' prefixes). Returns resource details including access information (shared or dedicated), capacity, status, and location details. 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/resources?offset&limit&officeId&ids&type&zoneId&name' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK
application/json
List of resources matching the provided filters
Body

Example
{
    "total": 100,
    "limit": 10,
    "offset": 0,
    "data": [
        {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "flexDesk",
            "capacity": 1,
            "name": "Flex Desk 1",
            "description": "Flex Desk 1 - Near window, adjustable height",
            "status": "active",
            "zoneId": "12",
            "officeId": "ca99dd78-2efb-49eb-a254-be0e3d56ca15",
            "accessInfo": {
                "type": "SHARED"
            },
            "createdAt": "2021-01-01T00:00:00.000Z",
            "updatedAt": "2021-01-01T00:00:00.000Z"
        }
    ]
}
🟠401Unauthorized
🟠403Forbidden
Previous
Gets a resource by ID
Next
Lists company offices
Built with