Lists company users - Public API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

offset

number

optional

The offset to start from

Default:

0

Example:

0

limit

number

optional

The limit of items to return

Default:

100

Example:

100

providers

enum<string>

optional

Comma separated list of user providers

Allowed values:

InternalAzureGoogleOktaOneLoginSAMLHRISSCIM

statuses

enum<string>

optional

Comma separated list of user statuses

Allowed values:

activeinactiveprovisioned

userGroupIds

array[string]

optional

Comma separated list of user groups uuids

primaryOfficeIds

array[number]

optional

Comma separated list of primary office ids

Example:

12,14

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

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

List of company users

Body

object {0}

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",
            "companyId": "1",
            "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",
            "companyId": "1",
            "role": "admin",
            "primaryOfficeId": "1",
            "status": "provisioned",
            "profileImage": "https://sample.url.com/deskbird-app/sample/avatars/2321"
        }
    ],
    "offset": 0,
    "limit": 2,
    "total": 1441
}

🟠401Unauthorized

🟠403Forbidden