Skip to content

Overview

Accounts, groups, notifications and multi-factor authentication for the Optiwork suite.

The Optiwork API covers the account layer shared by every application of the Optiwork suite: the users and groups of a tenant, the notification centre and its per-channel preferences, multi-factor authentication, cross-app quick search, and the aggregated cards of a user’s home screen.

Files, folders and sharing live in the Optiwork Drive reference, on the same host and behind the same authentication key.

Base URL

All endpoints are served under the fixed Optiwork host: https://work.optidata.cloud/api.

Authentication

Every endpoint (except GET /ping) requires a Bearer JWT passport. Your personal passport is available in Optiwork at https://work.optidata.cloud/user/settings/security (My account > Profile > Security), where it is shown as the authentication key. Send it on every request:

Authorization: Bearer opk_xxxxxxxxxxxxxxxxxxxxxxxx
Accept: application/json

Passports are short-lived; when a request returns 401, get a fresh authentication key from the same settings page and retry.

Conventions

  • A user is addressed by their UUID, not by a numeric id.
  • Timestamps are ISO-8601 UTC strings (e.g. 2026-03-10T17:09:05.000000Z).
  • Validation failures return 422 with a per-field errors map.
  • List endpoints are paginated with Laravel’s paginator envelope.
  • Requests are rate limited per authenticated user; exceeding the limit returns 429.

The authentication key (JWT passport) from My account > Profile > Security at work.optidata.cloud/user/settings/security.

Security scheme type: http

Bearer format: JWT