Skip to content
Optiwork API Docs

List users of the tenant

GET
/users
curl --request GET \
  --url https://work.optidata.cloud/api/users \
  --header 'Authorization: Bearer <token>'

Every user of the tenant, keyed by UUID rather than returned as an array. Narrow the result with uuids[], and trim the payload with attributes[] to keep only the columns you need.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
uuids[]
Array<string>

Restrict the result to these user UUIDs.

attributes[]
Array<string>

Only return these attributes of each user. Names must be real columns of the user record; unknown names fail validation.

Responses

Section titled “ Responses ”

200

Section titled “200”

Users of the tenant, keyed by UUID.

Media typeapplication/json
object
key
additional properties

A user of the tenant.

object
id
integer format: int64
uuid
string format: uuid
cuid

Identifier of the company (tenant) the user belongs to.

string
username
string
email
string format: email
name
string
full_name
string
company_name
string
role

Role of the user inside the tenant.

string
status
string
Allowed values: active inactive blocked
avatar_url
string | null format: uri
created_at
string format: date-time
updated_at
string format: date-time
deleted_at
string | null format: date-time
profile

Profile extras (avatar, job title). Loaded only where noted.

object | null
groups

Groups the user belongs to. Loaded only where noted.

Array<object>

A group of users inside the tenant.

object
id
integer format: int64
guid

Tenant-wide identifier of the group; used in paths.

string format: uuid
name
string
description
string | null
email
string | null format: email
cuid
string
memberships

Members of the group, each with its embedded user.

Array<object>
object
key
additional properties
any
userStatus

Presence status of the user. Loaded only where noted.

object | null
status_details

Rendered presence details (type, icon, message). Present on dashboard listings.

object | null
Examples
Exampleusers
{
  "9c1f0e2a-4d31-4d8a-8c1a-1f0b6b1f9a10": {
    "id": 15,
    "uuid": "9c1f0e2a-4d31-4d8a-8c1a-1f0b6b1f9a10",
    "cuid": "a1b2c3d4-2226-46c1-91b2-a9e9ba4c2d5b",
    "username": "jane.doe@acme.example",
    "email": "jane.doe@acme.example",
    "name": "Jane Doe",
    "full_name": "Jane Doe",
    "company_name": "Acme",
    "role": "super-admin",
    "status": "active",
    "avatar_url": "https://work.optidata.cloud/vendor/opticloud/images/user-default.svg",
    "created_at": "2025-03-26T17:36:28.000000Z",
    "updated_at": "2026-08-11T18:56:16.000000Z",
    "deleted_at": null
  }
}

401

Section titled “401”

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

422

Section titled “422”

The request body or query string failed validation.

Media typeapplication/json
object
message
required

The first validation message.

string
errors
required

Validation messages keyed by field name.

object
key
additional properties
Array<string>
Examples
Exampleinvalid
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

429

Section titled “429”

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
  "message": "Too Many Attempts."
}