Public API

Lists company users

GET

/users

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

offset

number

optional

The offset to start from

Default:

Example:

limit

number

optional

The limit of items to return

Default:

100

Example:

100

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

List of company users

Body

optional

Example:

{"data":[{"id":"7f1bc237-3a9b-4f9d-a09f-6ae1ad1553a4","firstName":"John","lastName":"Doe","email":"johnDoe@mycompany.com","companyId":"1","role":"user","primaryOfficeId":"1"},{"id":"9ab83795-6230-442a-b1ff-81304f45f687","firstName":"Marie","lastName":"Curie","email":"mariecurie@mycompany.com","companyId":"1","role":"admin","primaryOfficeId":"1"}],"offset":0,"limit":2,"total":1441}

Example

{
    "data": [
        {
            "id": "7f1bc237-3a9b-4f9d-a09f-6ae1ad1553a4",
            "firstName": "John",
            "lastName": "Doe",
            "email": "johnDoe@mycompany.com",
            "companyId": "1",
            "role": "user",
            "primaryOfficeId": "1"
        },
        {
            "id": "9ab83795-6230-442a-b1ff-81304f45f687",
            "firstName": "Marie",
            "lastName": "Curie",
            "email": "mariecurie@mycompany.com",
            "companyId": "1",
            "role": "admin",
            "primaryOfficeId": "1"
        }
    ],
    "offset": 0,
    "limit": 2,
    "total": 1441
}

🟠401Unauthorized

🟠403Forbidden

Users

Lists single company user