Public API
    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

    Resources

    The Resources API allows you to retrieve resource data from the Deskbird system. This endpoint supports pagination and filtering options based on office, zone, and resource type.

    Authentication#

    All resource-related endpoints require authentication via a valid API Key in the Authorization header. Ensure that you include a valid API key in your requests.

    Endpoints#

    Get Resources#

    Endpoint:
    GET /resources
    Description:
    Retrieves a list of resources with optional filters and pagination.
    Query Parameters:
    limit (integer, optional) – The maximum number of resources returned per request.
    officeId (string, optional) – The ID of the office where the resources are located.
    offset (integer, optional) – The starting point for retrieving resources (used for pagination).
    type (ResourceType, optional) – The type of resource to filter results.
    Allowed values:
    flexDesk
    meetingRoom
    other
    parking
    zoneId (string, optional) – The ID of the zone where the resources are located.
    Headers:
    Authorization: Bearer <your_api_key>
    Example Request:
    By using the Resources API, you can efficiently retrieve resources with filtering and pagination while ensuring secure access through token-based authentication.
    Previous
    Lists single company user group
    Next
    Gets a resource by ID
    Built with