Users LIST

GET 
/users

Required Permissions: User List or User Admin

Request

Query Parameters

sort string

The object key to sort the results by.

sort_asc boolean
page integer
items integer

Responses

200

A JSON Object containing an array of all users.

application/json

Schema

Schema

items integer
page integer

Possible values: >= 1

total integer
users object[]
Array [
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
]

Example (from schema)

{
  "items": 0,
  "page": 0,
  "total": 0,
  "users": [
    {
      "archived": false,
      "avatar": {},
      "avatar_file_upload_url": "/cropUrl/100x100/1.png",
      "created_at": "2024-12-02T14:38:57.881Z",
      "created_by_user_id": 0,
      "department": "Marketing",
      "email": "user@example.com"
    }
  ]
}

Loading...