Public API

Lists single company user

GET

/users/{userId}

Users

Returns a single company user by userId

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

userId

string

required

Query Params

include

enum<string>

optional

Comma separated list of user include options

Allowed values:

externalIdprovidersettingsuserGroupIdsofficeRoles

Header Params

Authorization

string

required

Public API key for the company

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Return of a single user

Body

object {0}

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",
    "companyId": "1",
    "role": "user",
    "primaryOfficeId": "1",
    "status": "provisioned",
    "profileImage": "https://sample.url.com/deskbird-app/sample/avatars/2321"
}

🟠401Unauthorized

🟠403Forbidden

Lists company users

Bookings