v1

latestOpenAPI 3.0.02026-08-067074272.5 KB

Users

Retrieves all users.

get/users

Query parameters

external_user_idstring

External User Id to filter the results by. The External User Id is a custom value that can only be set from within the API. Multiple users can have the same external user id.

emailstring

User's email address to filter the results by. A user's email address cannot be changed. Only one user can exist in an account for an email address.

pageinteger

The page number. The first item returned will be page multiplied by page_size

page_sizeinteger

The number of items returned. The first item returned will be page multiplied by page_size

Response

All users for this account in a list.

Example response

{
  "meta": {
    "total_items": 172
  },
  "items": [
    {
      "id": 508,
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@wefixwindows.com",
      "external_user_id": "johndoe_1",
      "permissions": [
        {
          "dashboard_id": 121,
          "role": "manager"
        }
      ]
    }
  ]
}