1. Resources
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
        GET
      • Lists company resources
        GET
    • 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
      • Gets a single room
      • Creates a room booking
      • Lists room bookings
      • Gets a single room booking
      • Updates a room booking
      • Checks in to a room booking
      • Cancels a room booking
      • Lists company room bookings
    • 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
  • 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
    • VisitTypeResponse
    • EnvelopedVisitTypeResponse
  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 'https://connect.deskbird.com/resources?offset=undefined&limit=undefined&officeId=undefined&ids=undefined&type=undefined&zoneId=undefined&name=undefined' \
--header 'Authorization: Bearer <token>'

Responses

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

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": "4835f29c-3f6e-4c5d-8a4c-33045c489f30",
            "officeId": "ca99dd78-2efb-49eb-a254-be0e3d56ca15",
            "accessInfo": {
                "type": "SHARED"
            },
            "equipment": [
                {
                    "id": "1",
                    "name": "Monitor"
                },
                {
                    "id": "2",
                    "name": "Keyboard"
                }
            ],
            "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