Lists company users - Public API

Retrieves a paginated list of company users. Supports filtering by providers, statuses, user group IDs, primary office IDs, and emails. Optional include parameter for 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. Pagination is supported through offset and limit parameters.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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