API Reference

v2025-04-21

July 27th, 2026

Added

  • PUT /tenants/{tenantId}/documents/{documentId}/documents/{subDocumentId} now accepts an optional unbox property. When set to true, the sub-module is attached and immediately unboxed: its steps are flattened into the parent document at position and the module itself is detached.

July 13th, 2026

Fixed

  • POST /tenants/{tenantId}/groups/{groupId}/user no longer fails with a 500 error when attachUserIds or removeUserIds contain duplicate or otherwise invalid ids. It now returns a 400 validation error and only accepts unique, positive integer ids.

June 29th, 2026

Added

  • GET /tenants/{tenantId}/reports/{reportId}/export now includes table cell interaction values alongside the other interactions of a process step.
  • Added a cellData property to interaction response objects. For table cell interactions returned by GET /tenants/{tenantId}/reports/{reportId}/export it contains the cell's columnId, columnName, columnPosition, rowId and rowPosition; for all other interactions it is null.
  • POST /tenants/{tenantId}/documents now supports creating table interactions inside document steps. Each table column requires a type (textfield, confirm, check, number, or description) and an optional name. All column types accept an optional unitId; it is semantically meaningful only for number columns. Rows are defined as a 2D array of cells, each with an optional name.
  • POST /tenants/{tenantId}/documents now accepts an optional unitId on number interactions.

Fixed

  • GET /tenants/{tenantId}/reports/{reportId}/export now resolves $$variableId$$ variable placeholders in interaction names to their order-specific values, matching the CSV export. Placeholders without a matching order variable are left unchanged and no interactions or rows are removed.

June 15th, 2026

Added

  • Added documentBaseId property to the report response payload of GET /tenants/{tenantId}/reports, GET /tenants/{tenantId}/reports/{reportId}, POST /tenants/{tenantId}/reports, PATCH /tenants/{tenantId}/reports/{reportId} and POST /tenants/{tenantId}/orders/{orderId}/reports/detach. It contains the id of the underlying base document and can be used to access the most recent published version of the document. It is null for legacy reports whose underlying document no longer exists.
  • Added new endpoint POST /tenants/{tenantId}/base-documents/{baseDocumentId}/latest-published-document/resolve to fetch the latest published document version for a base document and resolve dirty active or trash versions before returning the document.

Fixed

  • PATCH /tenants/{tenantId}/users/USERID no longer fails with a 500 error when updating a non-active (archived) user. It now returns a 422 response with the USER_NOT_ACTIVE error code.
  • POST /tenants/{tenantId}/documents no longer fails with a 502 error for large documents that take longer than 30 seconds to create. The request body remains limited to a maximum size of 1 MB.
  • Removed unsupported object with imageFeedbackIds, videoFeedbackIds, pdfFeedbackIds from the accepted value types of PUT /tenants/{tenantId}/interaction-values/{interactionValueId}. Media feedback was never supported on this endpoint.

May 18th, 2026

Added

  • Added new endpoint PATCH /tenants/{tenantId}/class-characteristics/{classCharacteristicId} to update a class characteristic's data or archived state.
  • Added new endpoint POST /tenants/{tenantId}/class-characteristics/graph/refresh to trigger a refresh of the class characteristics graph after changes to class characteristics or their relations.
  • Added new endpoint PATCH /tenants/{tenantId}/class-characteristics/assignments to batch attach or detach class characteristics on documents, reports, orders, tasks, global materials, and other supported entities.
  • Added new endpoint GET /tenants/{tenantId}/tasks/{taskId} to fetch a single task by id (same response shape as list items, including optional classCharacteristicIds when external classifiers are present).
  • Added new endpoint GET /tenants/{tenantId}/tasks/{taskId}/media to list task media metadata with ID filtering and pagination.
  • Added new endpoint GET /tenants/{tenantId}/tasks/media/{taskMediaId}/video-file to download converted task media video files (supports range requests when available).
  • Added new endpoint GET /tenants/{tenantId}/tasks/media/{taskMediaId}/pdf-file to download task media PDF files.
  • Added new endpoint GET /tenants/{tenantId}/interaction-values/{interactionValueId}/history to retrieve interaction value history.

Deprecated

  • Deprecated response property archived from GET /tenants/{tenantId}/users, GET /tenants/{tenantId}/users/USERID and POST /tenants/{tenantId}/users. Use the status property instead.
  • Deprecated query parameter archived from GET /tenants/{tenantId}/users. Use the status query parameter instead.
  • Deprecated request property archived from PATCH /tenants/{tenantId}/users/USERID. Use the status property instead.

May 4th, 2026

Fix

  • Return 400 Bad Request instead of 500 Internal Server Error when PUT /tenants/{tenantId}/global-materials/{globalMaterialId}/image is called with an image smaller than 1kb.

April 24th, 2026

Added

  • Added optional search query parameter to GET /tenants/{tenantId}/reports endpoint for search on report name (minimum 3 characters).

April 20th, 2026

Added

  • Added new endpoint POST /tenants/{tenantId}/variables to create a variable.
  • Added new endpoint GET /tenants/{tenantId}/variables to list variables with pagination, search and archived filtering.
  • Added status property to the response payload of GET /tenants/{tenantId}/users, GET /tenants/{tenantId}/users/USERID and POST /tenants/{tenantId}/users endpoints. Possible values are active, archived and anonymized.
  • Added optional status filter query parameter to GET /tenants/{tenantId}/users endpoint. Accepts an array of values: active, archived, anonymized.
  • Added optional status property to the request payload of PATCH /tenants/{tenantId}/users/USERID endpoint. Possible values are active, archived and anonymized.

Fix

  • Return 400 Bad Request instead of 500 Internal Server Error when POST /tenants/{tenantId}/documents is called with rows that have empty interactions arrays.

Deprecated

  • Response property archived for GET /tenants/{tenantId}/users, GET /tenants/{tenantId}/users/USERID and POST /tenants/{tenantId}/users is deprecated. Use status instead.
  • Query parameter archived for GET /tenants/{tenantId}/users is deprecated. Use status instead.
  • Request property archived for PATCH /tenants/{tenantId}/users/USERID is deprecated. Use status instead.

April 6th, 2026

Deprecated

  • Response properties orderDocumentAssignments[].subAssigneeId and orderDocumentAssignments[].subAssigneeUserName are deprecated. Use orderDocumentAssignments[].assignedUsers and orderDocumentAssignments[].assignedGroups instead.
  • Request property subAssigneeId for POST /tenants/{tenantId}/orders/{orderId}/order-document-assignments and nested orderDocumentAssignments in POST /tenants/{tenantId}/orders is deprecated. Use assignedUserIds and assignedGroupIds instead.
  • For GET /tenants/{tenantId}/orders, nested response properties orderDocumentAssignments[].assignedUsers and orderDocumentAssignments[].assignedGroups are deprecated. Use top-level order assignedUsers and assignedGroups or dedicated order-document-assignment endpoints for assignment-level assignees.

Fix

  • Return 400 Bad Request instead of 500 Internal Server Error when adding a document as a sub-document of itself via PUT /tenants/{tenantId}/documents/{documentId}/documents/{subDocumentId}.

March 23rd, 2026

Added

  • Added new endpoint POST /tenants/{tenantId}/users/USERID/push-report-into-view to push a report into a user's view.

Fix

  • Return 400 Bad Request instead of 500 Internal Server Error when updating PATCH /tenants/{tenantId}/order-document-assignments/{orderDocumentAssignmentId} after a report has already been generated for the order document assignment.

March 9th, 2026

Fix

  • Return 400 Bad Request instead of 500 Internal Server Error when assigning a role to an archived user via PUT /tenants/{tenantId}/users/USERID/roles/{roleId}.

February 23rd, 2026

Added

  • Extended assigned user and assigned group response payloads for orders, reports and tasks with optional displayName. The properties id and name can now also be null.

February 9th, 2026

Added

  • Extended access control response payloads for base-documents, orders and tasks with displayName.

January 26th, 2026

Added

  • Extended GET /tenants/{tenantId}/interactions/{interactionId} endpoint to support interaction type table.
  • Extended document and report response payloads to support interaction type table.

January 12th, 2026

Added

  • Extended GET /tenants/{tenantId}/tasks endpoint with task template fields
  • Extended POST /tenants/{tenantId}/tasks endpoint to support optional payload templateFieldsValues
  • Extended PATCH /tenants/{tenantId}/tasks/{taskId} endpoint to support optional payload templateFieldsValues

December 19th, 2025

Added

  • Extended POST /tenants/{tenantId}/documents endpoint to support optional payload reportCompletionPreventionMode
  • Extended PATCH /tenants/{tenantId}/documents/{documentId} endpoint to support optional payload reportCompletionPreventionMode

November 25th, 2025

Added

  • Extended GET /tenants/{tenantId}/documents endpoint with a new optional filter baseIds.

November 17th, 2025

Fix

  • Return proper error message for POST /tenants/{tenantId}/base-documents/access-controls if baseDocumentIds are not found

November 3th, 2025

Added

  • Increased limit for document step name from 255 to 2000 and for interaction name from 2000 to 10_000.
  • Extended POST /tenants/{tenantId}/documents endpoint with optional interaction tag assignment for interactions.

October 20th, 2025

Fix

  • Fixed an issue with the PATCH /tenants/{tenantId}/reports/{reportId} endpoint that incorrectly allowed setting the report state to 'not-started', which is not a valid state and was causing 500 server errors.

October 6th, 2025

Added

  • Extended GET /tenants/{tenantId}/reports and GET /tenants/{tenantId}/reports/{reportId} endpoint to retrieves order document assignment

  • Extended GET /tenants/{tenantId}/reports/{reportId}/export endpoint to retrieves order document assignment

  • Added new endpoint PATCH /tenants/{tenantId}/orders/{orderId}/reports to be able to update user and group assignments for a given report

  • Added three new document languages: Albanian (sq), Bosnian (bs), Serbian (sr)

September 22nd, 2025

Added

  • Extended POST /tenants/{tenantId}/connectors/ops1-order-connectors/{connectorId}/execute endpoint to support group assignment via array of strings in the payload.

Fix

  • Endpoints POST /tenants/{tenantId}/orders/{orderId}/duplicate and POST /tenants/{tenantId}/orders/{orderId}/instantiate did return the order model from version 2024-05-20 now the responses are aligned with all other order endpoints.

September 8th, 2025

Added

  • Added new endpoint GET /tenants/{tenantId}/groups to get user-groups list.
  • Added new endpoint PATCH /tenants/{tenantId}/groups/{groupId} to update a user-group.
  • Added new endpoint DELETE /tenants/{tenantId}/groups to delete user-groups.
  • Added new endpoint POST /tenants/{tenantId}/groups/{groupId}/user to add or remove a user to a user-group.
  • Added new endpoint GET /tenants/{tenantId}/groups/{groupId} to get user-group by id.
  • Added new endpoint PATCH /tenants/{tenantId}/groups to archive and unarchive a user-group.
  • Added new endpoint POST /tenants/{tenantId}/groups to create a user-group.
  • Extended response payload of GET /tenants/{tenantId}/reports/{reportId}/export include updatedAt, updatedBy and updatedByUserName properties for reportSteps.
  • For interaction of type number the properties failValueMore and failValueLess are now included in the response payload.
  • Extended response payload of GET /tenants/{tenantId}/reports/{reportId}/export with document.qualificationsRequired for unique, flattened parent and nested documents qualifications. Previously used property document.qualifications is deprecated to clearly distinguish between granted and required qualifications.
  • Extended GET /tenants/{tenantId}/orders endpoint with new query parameter ruleId.

August 25th, 2025

Added

  • Added new endpoint DELETE /tenants/{tenantId}/orders/access-controls/{acEntityId} to delete the assigned access of an order.
  • Added new endpoint POST /tenants/{tenantId}/orders/{orderId}/access-controls to assign access to an order.
  • Added new endpoint PATCH /tenants/{tenantId}/order-document-assignments/{orderDocumentAssignmentId} to update an order document assignment (supports quantity, position, assignedUserIds, assignedGroupIds, useLatestDocument, reportName).
  • Added new parameters assignedUserIds, assignedGroupIds to POST /tenants/{tenantId}/orders/{orderId}/order-document-assigments endpoint for the order document assignment create data
  • Added new parameters assignedUserIds, assignedGroupIds to POST /tenants/{tenantId}/order endpoint for the order document assignment create data
  • Added optional locales payload support for endpoint POST /tenants/{tenantId}/document steps, processSteps and interactions.

August 11th, 2025

Added

  • Added new endpoint POST /tenants/{tenantId}/connectors/ops1-order-connectors/{connectorId}/execute. To create an order using the operations1 order connector. See our document how to set up an order connector.
  • Added link and key-value interactions and individualReport processStep creation support POST /tenants/{tenantId}/documents endpoint.

Fix

  • No longer throw a 500 error when duplicated class characteristic ids are sent to PUT /tenants/{tenantId}/orders/{orderId}/class-characteristics endpoint.

July 14th, 2025

Added

  • Added showOrderInformation query option for GET /tenants/{tenantId}/reports/{reportId}/pdfs endpoint to include order information in PDF.

June 30th, 2025

Fix

  • Return proper unit property in the response payload of the GET /tenants/{tenantId}/reports/{reportId}/export endpoint for number interactions. Before it was always null.
  • Return 409 Conflict error when trying to attach a document with variables to a document without variables via the PUT /tenants/{tenantId}/documents/{documentId}/documents/{subDocumentId} endpoint.

Added

  • Added qualifications properties to the response payload of the GET /tenants/{tenantId}/users/\{userId} endpoint.
  • Added qualificationIds request payload for POST /tenants/{tenantId}/users endpoint to create user with assigned qualifications.
  • Added new endpoint GET /tenants/{tenantId}/qualifications to get qualifications list
  • Added new endpoint DELETE /tenants/{tenantId}/qualification/{qualificationId} to delete user qualification

June 16th, 2025

Added

  • Added new endpoint POST /tenants/{tenantId}/users/\{userId}/qualifications to upsert user qualifications
  • Added classCharacteristics and orderPosition properties to the response payload of the GET /tenants/{tenantId}/reports endpoint.
  • Added query parameters classCharacteristicIds and orderIds to the GET /tenants/{tenantId}/reports endpoint to filter reports by class characteristics or order ids

June 2nd, 2025

Added

  • Added possibility to update executionMode via PATCH /tenants/{tenantId}/orders/{orderId} endpoint
  • Added new property orderPosition to the response payload of the GET /tenants/{tenantId}/reports/{reportId} endpoint to indicate the position of the report within an order

May 5th, 2025

Added

  • Added new endpoint POST /tenants/{tenantId}/documents/translations to upload translations
  • Added new endpoint POST /tenants/{tenantId}/documents/{documentId}/qualifications-required to add required qualification to document
  • Added new endpoint POST /tenants/{tenantId}/documents/{documentId}/qualifications-granted to add granted qualification to document

April 23rd, 2025

Fix

  • Fixed the problem that for endpoint POST /tenants/{tenantId}/orders/ the value of useLatestDocument was ignored and instead the default value true was always used

Changed

  • Endpoints POST /tenants/{tenantId}/documents, PATCH /tenants/{tenantId}/documents/{documentId}, GET /tenants/{tenantId}/documents/{documentId} now includes granted and required qualifications
  • Endpoint POST /tenants/{tenantId}/documents now supports document creation with granted and required qualifications.

April 21st, 2025

Release

New public api version 2025-04-21 is released. Previous version 2024-05-20 is now deprecated, please set accept-version header to 2025-04-21.

Changed

  • Property assigneeId has been removed from request payload for the POST /tenants/{tenantId}/tasks and PATCH /tenants/{tenantId}/tasks/{taskId} endpoints

  • Properties assigneeId and assigneeUserName have been removed from response payload for the GET /tenants/{tenantId}/tasks, POST /tenants/{tenantId}/tasks, and PATCH /tenants/{tenantId}/tasks/{taskId} endpoints

  • Properties classFilterAssistant and classFilterEditor have been removed from request payload for the POST /tenants/{tenantId}/users and PATCH /tenants/{tenantId}/users/\{userId} endpoints

  • Renamed endpoint GET /tenants/{tenantId}/images-feedback/{imageFeedbackId}/file to GET /tenants/{tenantId}/image-feedbacks/{imageFeedbackId}/file

  • Renamed endpoint GET /tenants/{tenantId}/videos-feedback/{videoFeedbackId}/file to GET /tenants/{tenantId}/video-feedbacks/{videoFeedbackId}/file

  • Endpoint GET /tenants/{tenantId}/pdfs-feedback/{pdfFeedbackId}/file.pdf was renamed to GET /tenants/{tenantId}/pdf-feedbacks/{pdfFeedbackId}/file to be consistent with other endpoints.

  • The following search query parameters now require at least 3 characters:

    • Query parameter name for endpoint GET /tenenats/{tenantId}/roles
    • Query parameter search for endpoint GET /tenants/{tenantId}/orders
    • Query parameters search, customId and location for endpoint GET /tenants/{tenantId}/global-materials

  • Property assignedUserIds and assignedGroupIds was added, assigneeId was removed from the request payload PATCH /tenants/{tenantId}/orders/{orderId}

  • Property assignedUsers and assignedGroups was added, assigneeId and assigneeUserName was removed from the response payload PATCH /tenants/{tenantId}/orders/{orderId}

  • Property assignedUsers and assignedGroups was added to the response payload GET /tenants/{tenantId}/orders

  • Property assignedUserIds and assignedGroupIds was added, assigneeId was removed from the request payload POST /tenants/{tenantId}/orders

Added

  • Added new endpoint GET /tenants/{tenantId}/documents/{documentId}/export to fetch a document with additional data like steps, process steps, interactions, and interaction choices

  • Added new properties assignedUserIds and assignedGroupsIds to the request payload for the POST /tenants/{tenantId}/tasks and PATCH /tenants/{tenantId}/tasks/{taskId} endpoints for assigning and updating multiple users or groups related to the task

  • Added new properties assignedUsers and assignedGroups to the response payload for the
    GET /tenants/{tenantId}/tasks, POST /tenants/{tenantId}/tasks, and PATCH /tenants/{tenantId}/tasks/{taskId} endpoints

  • Added new property classFilter to the request payload for the POST /tenants/{tenantId}/users and PATCH /tenants/{tenantId}/users/\{userId} endpoints for assigning and updating saved classifier filters for users

Removed

  • Removed endpoint POST /tenants/{tenantId}/reports/{reportId}/generate-pdf, GET /tenants/{tenantId}/report-pdfs/{reportPdfId} and GET /tenants/{tenantId}/report-pdfs/{reportPdfId}/file.pdf.
    Use the new PDF generation endpoints POST /tenants/{tenantId}/reports/{reportId}/pdfs, GET /tenants/{tenantId}/pdf-jobs/{pdfJobId} and GET /tenants/{tenantId}/pdf-jobs/{pdfJobId}/file instead.

  • Removed property pdfs from the response of the following endpoints:

    • POST /tenants/{tenantId}/orders/{orderId}/reports/detach
    • GET /tenants/{tenantId}/reports/{reportId}
    • PATCH /tenants/{tenantId}/reports/{reportId}

Updated 2 days ago

Did this page help you?

Updated 2 days ago

Did this page help you?