Lists company users

GET

/users

Returns company users

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

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?offset&limit&providers&statuses&userGroupIds&primaryOfficeIds&emails&include' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK

application/json

List of company users

Body

Examples

Example of users responseExample of users with includes response

{
    "data": [
        {
            "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"
        },
        {
            "id": "9ab83795-6230-442a-b1ff-81304f45f687",
            "firstName": "Marie",
            "lastName": "Curie",
            "email": "mariecurie@mycompany.com",
            "role": "admin",
            "primaryOfficeId": "1",
            "status": "provisioned",
            "profileImage": "https://sample.url.com/deskbird-app/sample/avatars/2321"
        }
    ],
    "offset": 0,
    "limit": 2,
    "total": 1441
}

🟠401Unauthorized

🟠403Forbidden

Users

Lists single company user