List colleagues by presence

GET

/users/{user}/dashboard/users

curl --request GET \
  --url https://work.optidata.cloud/api/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/dashboard/users \
  --header 'Authorization: Bearer <token>'

• Optiwork API

Every user of the tenant split into two buckets — those currently online and those shown as offline — each enriched with the status icon and message to render.

Authorizations

• bearerAuth

Parameters

Path Parameters

user

required

string format: uuid

UUID of the dashboard owner.

Responses

200

Users grouped by presence.

Media typeapplication/json

object

online

Array<object>

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

show_me_offline

Array<object>

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

Examplepresence

{
  "online": [
    {
      "id": 15,
      "uuid": "9c1f0e2a-4d31-4d8a-8c1a-1f0b6b1f9a10",
      "name": "Jane Doe",
      "email": "jane.doe@acme.example",
      "status_details": {
        "type": "online",
        "icon": "lu-circle",
        "message": null
      }
    }
  ],
  "show_me_offline": []
}

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"
}

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."
}