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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://connect.deskbird.com/users/?include' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK

application/json

Return of a single user

Body

Examples

Example of a single user responseExample of a single user with includes response

{
    "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

Lists company users

Bookings