1. Users
Public API
  • Welcome to the deskbird developer docs
  • Public API
    • Overview
    • Users
      • Lists company users
        GET
      • Retrieves a single company user
        GET
    • 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
      • 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
      • 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
    • Lists company visits
    • Gets a single company visit
  • Tickets
    • Lists company tickets
    • Gets a single company ticket
    • Lists ticket categories
  • Service requests
    • Lists company service requests
    • Lists service categories of an office
    • Gets a single company service request
  • 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
    • TicketCategoryReferenceResponse
    • VisitTypeResponse
    • TicketUserResponse
    • EnvelopedVisitTypeResponse
    • TicketCustomFieldResponse
    • TicketAttachmentResponse
    • TicketResponse
    • PaginatedTicketResponse
    • TicketCommentResponse
    • TicketDetailsResponse
    • TicketCategoryCustomFieldResponse
    • TicketCategoryResponse
    • EnvelopedTicketCategoryResponse
    • RequestedItemResponse
    • RequestedCategoryResponse
    • VisitTypeReferenceResponse
    • ServiceRequestResponse
    • VisitHostResponse
    • PaginatedServiceRequestResponse
    • ServiceItemResponse
    • ServiceCategoryResponse
    • PaginatedVisitResponse
    • EnvelopedServiceCategoryResponse
    • VisitorResponse
    • VisitResponse
  1. Users

Retrieves a single company user

GET
/users/{userId}
Returns a single company user by user ID (path parameter, numeric or UUID). Optionally accepts an include query parameter to return additional user data (externalId, provider, settings, userGroups, officeRoles). Returns user details including user ID, name, email, role, primary office ID, status, and profile image URL.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

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/users/?include=undefined' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK
application/json
Return of a single user
Bodyapplication/json

Examples
{
    "id": "7f1bc237-3a9b-4f9d-a09f-6ae1ad1553a4",
    "firstName": "John",
    "lastName": "Doe",
    "email": "johnDoe@mycompany.com",
    "role": "user",
    "primaryOfficeId": "1",
    "status": "provisioned",
    "profileImage": "https://sample.url.com/deskbird-app/sample/avatars/2321"
}
🟠401Unauthorized
🟠403Forbidden
Previous
Lists company users
Next
Bookings
Built with