Public API
Copy Page
Public API
Welcome to the deskbird Public API
Users
Lists company users
Lists 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
Lists single company user group
Resources
Gets a resource by ID
Lists company resources
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
Lists room bookings
Creates a room booking
Gets a single room booking
Updates a room booking
Checks in to a room booking
Cancels a room booking
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
CheckUserIntoOfficeBody
Copy Page
{
"userId"
:
"12345 or 123e4567-e89b-12d3-a456-426614174000"
}