Skip to content

Classic REST API

The classic API is the older HTTP interface of the workspace. It is still supported and is the only place some operations exist, but it predates the workspace API and uses its own conventions.

Base URL

{host}/api/1.0/{workspace}/

Every resource mounts under it, and the resource name is the first segment of the path: /api/1.0/starter/cases, /api/1.0/starter/home/inbox.

Authentication

The classic API uses OAuth2. Register a client in OAuth clients, obtain a token from the workspace endpoint (/oauth2/token) and send it on every call:

Authorization: Bearer <access_token>

Without a token, the API answers 401 with code 2 and The access token is invalid. An expired or unauthorised caller gets the same shape.

Requests and responses

  • The body is JSON; send Content-Type: application/json.
  • Path parameters use a colon in the documentation (:app_uid), as in the endpoint reference.
  • Responses return the legacy field names — APP_UID, APP_NUMBER, DEL_INDEX, TAS_UID — not the camelCase shapes of the workspace API.
  • Errors carry error.code and error.message; 401 is authentication, 403 permission, 404 unknown id.

What this reference covers

The endpoints documented here cover the resources an integration actually needs:

Area What it does
Cases List, read, act on and derive a case; notes, documents, variables
Workspace lists The inbox, draft, participated and paused lists, and their counts
Saved case lists The list definitions a user created and their export
Actions by email The configured link actions and their templates
Process permissions Who may start a process
Starting tasks per user Which tasks a user can start

The rest of the classic API is deliberately left out: the deprecated mobile and analytics resources, the administration resources the new Admin screens replace, and the designer endpoints that edit a process's own objects. The endpoint reference states the count and the reason.