/opper_work/areasGET /opper_work/areas
Responses
"string"
Example
curl -X GET "https://om.opperescala.com/api/opper_work/areas" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
Auto-generated OpenAPI definition for all enabled modules.
/opper_work/areas"string"
curl -X GET "https://om.opperescala.com/api/opper_work/areas" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/opper_work/areas"string"
curl -X POST "https://om.opperescala.com/api/opper_work/areas" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/opper_work/areasNo response body.
curl -X DELETE "https://om.opperescala.com/api/opper_work/areas" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/auth/admin/navReturns the backend chrome payload available to the authenticated administrator after applying scope, RBAC, role defaults, and personal sidebar preferences.
{
"brand": null,
"groups": [
{
"name": "string",
"items": [
{
"href": "string",
"title": "string"
}
]
}
],
"settingsSections": [
{
"id": "string",
"label": "string",
"items": [
{
"id": "string",
"label": "string",
"href": "string"
}
]
}
],
"settingsPathPrefixes": [
"string"
],
"profileSections": [
{
"id": "string",
"label": "string",
"items": [
{
"id": "string",
"label": "string",
"href": "string"
}
]
}
],
"profilePathPrefixes": [
"string"
],
"grantedFeatures": [
"string"
],
"roles": [
"string"
],
"currentOrganization": null
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/auth/admin/nav" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/auth/autologinWhen OM_AUTOLOGIN_EMAIL / OM_AUTOLOGIN_PASSWORD are configured, signs the visitor in with those credentials and redirects into the app. Intended for single-tenant demo instances only. Falls back to the login page when disabled or misconfigured.
"string"
string
curl -X GET "https://om.opperescala.com/api/auth/autologin" \ -H "Accept: application/json"
/auth/feature-checkEvaluates which of the requested features are available to the signed-in user within the active tenant / organization context.
{
"features": [
"string"
]
}{
"ok": true,
"granted": [
"string"
],
"userId": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/auth/feature-check" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"features\": [
\"string\"
]
}"/auth/featuresReturns all static features contributed by the enabled modules along with their module source.
{
"items": [
{
"id": "string",
"title": "string",
"module": "string"
}
],
"modules": [
{
"id": "string",
"title": "string"
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/auth/features" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/auth/localeStores the selected locale in a cookie and redirects to a safe local path.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| locale | query | Yes | any | A locale code this tenant serves — one of the `servable` entries returned by `GET /api/translations/locales`. Codes are canonicalized (`de-AT` → `de`). |
| redirect | query | No | any | — |
"string"
"string"
{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/auth/locale?locale=string" \ -H "Accept: application/json"
/auth/localeStores the selected locale in a cookie and returns a JSON success response.
{
"locale": "string"
}{
"ok": true
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/auth/locale" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"locale\": \"string\"
}"/auth/loginValidates the submitted credentials and issues a bearer token cookie for subsequent API calls.
email=user%40example.com&password=string
{
"ok": true,
"token": "string",
"redirect": null
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/auth/login" \ -H "Accept: application/json" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "email=user%40example.com&password=string"
/auth/logoutClears authentication cookies and redirects the browser to the login page.
"string"
string
curl -X POST "https://om.opperescala.com/api/auth/logout" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/auth/profileReturns the email address, display name, and roles for the signed-in user. The display name is null when unset.
{
"email": "user@example.com",
"name": null,
"roles": [
"string"
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/auth/profile" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/auth/profileUpdates the email address or password for the signed-in user.
{}{
"ok": true,
"email": "user@example.com"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/auth/profile" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/auth/resetRequests a password reset email for the given account. The endpoint always returns `ok: true` to avoid leaking account existence.
email=user%40example.com
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/auth/reset" \ -H "Accept: application/json" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "email=user%40example.com"
/auth/reset/confirmValidates the reset token and updates the user password. The returned `redirect` carries the resolved user's tenant as a navigation hint (`/login?tenant=...`) so a tenant-bound user lands on the tenant login entry; tenantless users get `/login`.
token=string&password=string
{
"ok": true,
"redirect": "string"
}{
"ok": false,
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/auth/reset/confirm" \ -H "Accept: application/json" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "token=string&password=string"
/auth/reset/validateReports whether a reset token exists, is unused, and has not expired, so the reset page can render a terminal state instead of a form the token can never submit. The token is never consumed and the response never distinguishes unknown, used, and expired tokens.
token=string
{
"ok": true,
"valid": true
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/auth/reset/validate" \ -H "Accept: application/json" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "token=string"
/auth/rolesReturns available roles within the current tenant. Super administrators receive visibility across tenants.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| tenantId | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"usersCount": 1,
"tenantId": null,
"tenantName": null,
"updatedAt": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/auth/roles?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/auth/rolesCreates a new role anchored to the caller's tenant. Non-superadmins cannot target another tenant; supplying a foreign `tenantId` is rejected.
{
"name": "string"
}{
"id": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/auth/roles" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"name\": \"string\"
}"/auth/rolesUpdates mutable fields on an existing role.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/auth/roles" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/auth/rolesDeletes a role by identifier. Fails when users remain assigned.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | Yes | any | Role identifier |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/auth/roles?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/auth/roles/aclReturns the feature and organization assignments associated with a role within the current tenant.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| roleId | query | Yes | any | — |
| tenantId | query | No | any | — |
{
"isSuperAdmin": true,
"features": [
"string"
],
"organizations": null,
"updatedAt": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/auth/roles/acl?roleId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/auth/roles/aclReplaces the feature list, super admin flag, and optional organization assignments for a role.
{
"roleId": "00000000-0000-4000-8000-000000000000",
"organizations": null
}{
"ok": true,
"sanitized": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/auth/roles/acl" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"roleId\": \"00000000-0000-4000-8000-000000000000\",
\"organizations\": null
}"/auth/session/refreshExchanges an existing `session_token` cookie for a fresh JWT auth cookie and redirects the browser.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| redirect | query | No | any | Absolute or relative URL to redirect after refresh |
"string"
string
curl -X GET "https://om.opperescala.com/api/auth/session/refresh" \ -H "Accept: application/json"
/directory/organizations/lookup"string"
curl -X GET "https://om.opperescala.com/api/directory/organizations/lookup" \ -H "Accept: application/json"
/directory/tenants/lookup"string"
curl -X GET "https://om.opperescala.com/api/directory/tenants/lookup" \ -H "Accept: application/json"
/customers/deals/bulk-update-ownerQueues a background job that reassigns the listed deals to a new owner (or clears the owner when null).
"string"
curl -X POST "https://om.opperescala.com/api/customers/deals/bulk-update-owner" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customers/deals/bulk-update-stageQueues a background job that moves the listed deals to the same pipeline stage. Returns a progress job id to poll for completion.
"string"
curl -X POST "https://om.opperescala.com/api/customers/deals/bulk-update-stage" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/audit_logs/audit-logs/accessFetches paginated access audit logs scoped to the authenticated user. Tenant administrators can optionally expand the search to other actors or organizations.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| organizationId | query | No | any | Limit results to a specific organization |
| actorUserId | query | No | any | Filter by actor user id (tenant administrators only) |
| resourceKind | query | No | any | Restrict to a resource kind such as `order` or `product` |
| accessType | query | No | any | Access type filter, e.g. `read` or `export` |
| page | query | No | any | Page number (default 1) |
| pageSize | query | No | any | Page size (default 50) |
| limit | query | No | any | Explicit maximum number of records when paginating manually |
| before | query | No | any | Return logs created before this ISO-8601 timestamp |
| after | query | No | any | Return logs created after this ISO-8601 timestamp |
{
"items": [
{
"id": "string",
"resourceKind": "string",
"resourceId": "string",
"accessType": "string",
"actorUserId": null,
"actorUserName": null,
"tenantId": null,
"tenantName": null,
"organizationId": null,
"organizationName": null,
"fields": [
"string"
],
"context": null,
"createdAt": "string"
}
],
"canViewTenant": true,
"page": 1,
"pageSize": 1,
"total": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/audit_logs/audit-logs/access" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/audit_logs/audit-logs/actionsReturns recent action audit log entries. Tenant administrators can widen the scope to other actors or organizations, and callers can optionally restrict results to undoable actions.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| organizationId | query | No | any | Limit results to a specific organization |
| actorUserId | query | No | any | Filter logs created by specific actor IDs (tenant administrators only). Accepts a single UUID or a comma-separated UUID list. |
| resourceKind | query | No | any | Filter by resource kind (e.g., "order", "product") |
| resourceId | query | No | any | Filter by resource ID (UUID of the specific record) |
| actionType | query | No | any | Filter by action type (`create`, `edit`, `delete`, `assign`). Accepts a single value or a comma-separated list. |
| fieldName | query | No | any | Filter to entries where the given field changed. Accepts a single field name or a comma-separated list. |
| includeRelated | query | No | any | When `true`, also returns changes to child entities linked via parentResourceKind/parentResourceId |
| includeTotal | query | No | any | When `true`, the response includes the filtered total count. |
| undoableOnly | query | No | any | When `true`, only undoable actions are returned |
| limit | query | No | any | Maximum number of records to return (default 50, max 1000) |
| offset | query | No | any | Zero-based record offset for pagination (legacy — prefer page/pageSize) |
| page | query | No | any | Page number (default 1) |
| pageSize | query | No | any | Page size (default 50, max 200) |
| sortField | query | No | any | Sort field: `createdAt`, `user`, `action`, `field`, or `source`. |
| sortDir | query | No | any | Sort direction: `asc` or `desc`. |
| before | query | No | any | Return actions created before this ISO-8601 timestamp |
| after | query | No | any | Return actions created after this ISO-8601 timestamp |
{
"items": [
{
"id": "string",
"commandId": "string",
"actionLabel": null,
"executionState": "done",
"actorUserId": null,
"actorUserName": null,
"tenantId": null,
"tenantName": null,
"organizationId": null,
"organizationName": null,
"resourceKind": null,
"resourceId": null,
"parentResourceKind": null,
"parentResourceId": null,
"undoToken": null,
"createdAt": "string",
"updatedAt": "string",
"snapshotBefore": null,
"snapshotAfter": null,
"changes": null,
"context": null
}
],
"canViewTenant": true,
"page": 1,
"pageSize": 1,
"total": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/audit_logs/audit-logs/actions?includeRelated=false&includeTotal=false&undoableOnly=false" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/audit_logs/audit-logs/actions/exportReturns a CSV attachment containing filtered action audit log entries. Tenant administrators can widen the scope to other actors or organizations.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| organizationId | query | No | any | Limit results to a specific organization |
| actorUserId | query | No | any | Filter logs created by specific actor IDs (tenant administrators only). Accepts a single UUID or a comma-separated UUID list. |
| resourceKind | query | No | any | Filter by resource kind (e.g., "order", "product") |
| resourceId | query | No | any | Filter by resource ID (UUID of the specific record) |
| actionType | query | No | any | Filter by action type (`create`, `edit`, `delete`, `assign`). Accepts a single value or a comma-separated list. |
| fieldName | query | No | any | Filter to entries where the given field changed. Accepts a single field name or a comma-separated list. |
| includeRelated | query | No | any | When `true`, also returns changes to child entities linked via parentResourceKind/parentResourceId |
| undoableOnly | query | No | any | When `true`, only undoable actions are returned |
| limit | query | No | any | Maximum number of records to export (default 1000, capped at 1000) |
| sortField | query | No | any | Sort field: `createdAt`, `user`, `action`, `field`, or `source`. |
| sortDir | query | No | any | Sort direction: `asc` or `desc`. |
| before | query | No | any | Return actions created before this ISO-8601 timestamp |
| after | query | No | any | Return actions created after this ISO-8601 timestamp |
{
"file": "csv"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/audit_logs/audit-logs/actions/export?includeRelated=false&undoableOnly=false" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/audit_logs/audit-logs/actions/redoRedoes the latest undone command owned by the caller. Requires the action to still be eligible for redo within tenant and organization scope.
{
"logId": "string"
}{
"ok": true,
"logId": null,
"undoToken": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/audit_logs/audit-logs/actions/redo" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"logId\": \"string\"
}"/audit_logs/audit-logs/actions/undoReplays the undo handler registered for a command. The provided undo token must match the latest undoable log entry accessible to the caller.
{
"undoToken": "string"
}{
"ok": true,
"logId": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/audit_logs/audit-logs/actions/undo" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"undoToken\": \"string\"
}"/attachmentsReturns uploaded attachments for the given entity record, ordered by newest first.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| entityId | query | Yes | any | Entity identifier that owns the attachments |
| recordId | query | Yes | any | Record identifier within the entity |
| page | query | No | any | — |
| pageSize | query | No | any | — |
{
"items": [
{
"id": "string",
"url": "string",
"fileName": "string",
"fileSize": 1,
"createdAt": "string",
"mimeType": null,
"content": null
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/attachments?entityId=string&recordId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/attachmentsUploads a new attachment using multipart form-data and stores metadata for later retrieval.
entityId=string recordId=string file=string
{
"ok": true,
"item": {
"id": "string",
"url": "string",
"fileName": "string",
"fileSize": 1,
"content": null
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/attachments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: multipart/form-data" \
-d "{
\"entityId\": \"string\",
\"recordId\": \"string\",
\"file\": \"string\"
}"/attachmentsRemoves an uploaded attachment and deletes the stored asset.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | Yes | any | — |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/attachments?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/attachments/file/{id}Returns the raw file content for an attachment. Path parameter: {id} - Attachment UUID. Query parameter: ?download=1 - Force file download with Content-Disposition header. Access control is enforced based on partition settings.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/attachments/file/:id" \ -H "Accept: application/json"
/attachments/image/{id}/{slug}Returns an image attachment with optional on-the-fly resizing and cropping. Resized images are cached for performance. Only works with image MIME types. Path parameter: {id} - Attachment UUID. Query parameters: ?width=N (1-4000 pixels), ?height=N (1-4000 pixels), ?cropType=cover|contain (resize behavior).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| slug | path | No | any | — |
"string"
{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/attachments/image/:id/:slug" \ -H "Accept: application/json"
/attachments/libraryReturns paginated list of attachments with optional filtering by search term, partition, and tags. Includes available tags and partitions.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | Page number for pagination |
| pageSize | query | No | any | Number of items per page (max 100) |
| search | query | No | any | Search by file name (case-insensitive) |
| partition | query | No | any | Filter by partition code |
| tags | query | No | any | Filter by tags (comma-separated) |
| sortField | query | No | any | Field to sort by |
| sortDir | query | No | any | Sort direction |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"fileName": "string",
"fileSize": 1,
"mimeType": "string",
"partitionCode": "string",
"partitionTitle": null,
"url": null,
"createdAt": "string",
"tags": [
"string"
],
"assignments": [],
"content": null
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1,
"availableTags": [
"string"
],
"partitions": [
{
"code": "string",
"title": "string",
"description": null,
"isPublic": true
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/attachments/library?page=1&pageSize=25" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/attachments/library/{id}Returns complete details of an attachment including metadata, tags, assignments, and custom fields.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"item": {
"id": "00000000-0000-4000-8000-000000000000",
"fileName": "string",
"fileSize": 1,
"mimeType": "string",
"partitionCode": "string",
"partitionTitle": null,
"tags": [
"string"
],
"assignments": [],
"content": null,
"customFields": null
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/attachments/library/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/attachments/library/{id}Updates attachment tags, assignments, and custom fields. Emits CRUD side effects for indexing and events.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PATCH "https://om.opperescala.com/api/attachments/library/:id" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/attachments/library/{id}Permanently deletes an attachment file from storage and database. Emits CRUD side effects.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/attachments/library/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/attachments/partitionsReturns all configured attachment partitions with storage settings, OCR configuration, and access control settings.
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"code": "string",
"title": "string",
"description": null,
"isPublic": true,
"requiresOcr": true,
"ocrModel": null,
"configJson": null,
"createdAt": null,
"updatedAt": null,
"envKey": "string"
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/attachments/partitionsCreates a new attachment partition with specified storage and OCR settings. Requires unique partition code.
{
"code": "string",
"title": "string",
"description": null,
"ocrModel": null,
"storageDriver": "local",
"configJson": null
}{
"item": {
"id": "00000000-0000-4000-8000-000000000000",
"code": "string",
"title": "string",
"description": null,
"isPublic": true,
"requiresOcr": true,
"ocrModel": null,
"configJson": null,
"createdAt": null,
"updatedAt": null,
"envKey": "string"
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/attachments/partitions" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"code\": \"string\",
\"title\": \"string\",
\"description\": null,
\"ocrModel\": null,
\"storageDriver\": \"local\",
\"configJson\": null
}"/attachments/partitionsUpdates an existing partition. Partition code cannot be changed. Title, description, OCR settings, and access control can be modified.
{
"code": "string",
"title": "string",
"description": null,
"ocrModel": null,
"storageDriver": "local",
"configJson": null,
"id": "00000000-0000-4000-8000-000000000000"
}{
"item": {
"id": "00000000-0000-4000-8000-000000000000",
"code": "string",
"title": "string",
"description": null,
"isPublic": true,
"requiresOcr": true,
"ocrModel": null,
"configJson": null,
"createdAt": null,
"updatedAt": null,
"envKey": "string"
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/attachments/partitions" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"code\": \"string\",
\"title\": \"string\",
\"description\": null,
\"ocrModel\": null,
\"storageDriver\": \"local\",
\"configJson\": null,
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/attachments/partitionsDeletes a partition. Default partitions cannot be deleted. Partitions with existing attachments cannot be deleted.
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/attachments/transferTransfers one or more attachments from one record to another within the same entity type. Updates attachment assignments and metadata to reflect the new record.
{
"entityId": "string",
"attachmentIds": [
"00000000-0000-4000-8000-000000000000"
],
"toRecordId": "string"
}{
"ok": true,
"updated": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/attachments/transfer" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityId\": \"string\",
\"attachmentIds\": [
\"00000000-0000-4000-8000-000000000000\"
],
\"toRecordId\": \"string\"
}"/catalog/bulk-delete"string"
curl -X POST "https://om.opperescala.com/api/catalog/bulk-delete" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/catalog/categories/bulk-create"string"
curl -X POST "https://om.opperescala.com/api/catalog/categories/bulk-create" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/catalog/products/bulk-create"string"
curl -X POST "https://om.opperescala.com/api/catalog/products/bulk-create" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/availability/checkAdmin/debug tool. Mirrors resolveAvailability() and includes the per-field policySourceId trace.
{
"productId": "string",
"variantId": null,
"quantity": 1,
"storeId": null
}{
"availability": null,
"policyTrace": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/availability/check" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"productId\": \"string\",
\"variantId\": null,
\"quantity\": 1,
\"storeId\": null
}"/availability/policiesReturns a paginated collection of availabilitypolicies scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| storeId | query | No | any | — |
| productId | query | No | any | — |
| variantId | query | No | any | — |
| isActive | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "string",
"organizationId": "string",
"tenantId": "string",
"storeId": null,
"productId": null,
"variantId": null,
"isStockManaged": null,
"allowBackorder": true,
"backorderLeadTimeDays": null,
"preorderReleaseAt": null,
"lowStockThreshold": null,
"minOrderQuantity": null,
"maxOrderQuantity": null,
"quantityIncrement": null,
"hideWhenOutOfStock": true,
"isActive": true,
"createdAt": null,
"updatedAt": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/availability/policies?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/availability/policiesCreates a new availability policy.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"storeId": null,
"productId": null,
"variantId": null,
"isStockManaged": null,
"backorderLeadTimeDays": null,
"preorderReleaseAt": null,
"lowStockThreshold": null,
"minOrderQuantity": null,
"maxOrderQuantity": null,
"quantityIncrement": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/availability/policies" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"storeId\": null,
\"productId\": null,
\"variantId\": null,
\"isStockManaged\": null,
\"backorderLeadTimeDays\": null,
\"preorderReleaseAt\": null,
\"lowStockThreshold\": null,
\"minOrderQuantity\": null,
\"maxOrderQuantity\": null,
\"quantityIncrement\": null
}"/availability/policiesUpdates an existing availability policy by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"storeId": null,
"productId": null,
"variantId": null,
"isStockManaged": null,
"backorderLeadTimeDays": null,
"preorderReleaseAt": null,
"lowStockThreshold": null,
"minOrderQuantity": null,
"maxOrderQuantity": null,
"quantityIncrement": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/availability/policies" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"storeId\": null,
\"productId\": null,
\"variantId\": null,
\"isStockManaged\": null,
\"backorderLeadTimeDays\": null,
\"preorderReleaseAt\": null,
\"lowStockThreshold\": null,
\"minOrderQuantity\": null,
\"maxOrderQuantity\": null,
\"quantityIncrement\": null
}"/availability/policiesDeletes an availability policy identified by the `id` query parameter.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | Yes | any | — |
{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/availability/policies?id=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/availability/policies/resolve-preview| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| productId | query | Yes | any | — |
| variantId | query | No | any | — |
| storeId | query | No | any | — |
{
"policyTrace": {}
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/availability/policies/resolve-preview?productId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/api_keys/keysReturns paginated API keys visible to the current user, including per-key role assignments and organization context.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
{
"items": [
{
"id": "string",
"name": "string",
"description": null,
"keyPrefix": "string",
"organizationId": null,
"organizationName": null,
"createdAt": "string",
"lastUsedAt": null,
"expiresAt": null,
"roles": [
{
"id": "string",
"name": null
}
]
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/api_keys/keys" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/api_keys/keysCreates a new API key, returning the one-time secret value together with the generated key prefix and scope details.
{
"name": "string",
"description": null,
"tenantId": null,
"organizationId": null,
"roles": [],
"expiresAt": null
}{
"id": "string",
"name": "string",
"keyPrefix": "string",
"tenantId": null,
"organizationId": null,
"roles": [
{
"id": "string",
"name": null
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/api_keys/keys" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"name\": \"string\",
\"description\": null,
\"tenantId\": null,
\"organizationId\": null,
\"roles\": [],
\"expiresAt\": null
}"/api_keys/keysRemoves an API key by identifier. The key must belong to the current tenant and fall within the requester organization scope.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | Yes | any | API key identifier to delete |
{
"success": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/api_keys/keys?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/devicesReturns the authenticated user's registered devices (admins may list across users). Response keys are camelCase. The snake_case keys (`user_id`, `device_id`, `last_seen_at`, …) are deprecated aliases of their camelCase counterparts, retained for one minor version and removed in the next; read `userId`, `deviceId`, `lastSeenAt`, … instead.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| platform | query | No | any | — |
| userId | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": null,
"userId": "00000000-0000-4000-8000-000000000000",
"deviceId": "string",
"platform": "ios",
"clientAppVersion": null,
"osVersion": null,
"locale": null,
"pushProvider": null,
"pushTokenUpdatedAt": null,
"lastSeenAt": null,
"createdAt": null,
"updatedAt": null,
"tenant_id": "00000000-0000-4000-8000-000000000000",
"organization_id": null,
"user_id": "00000000-0000-4000-8000-000000000000",
"device_id": "string",
"client_app_version": null,
"os_version": null,
"push_provider": null,
"push_token_updated_at": null,
"last_seen_at": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/devices?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/devicesRegisters (or idempotently upserts) the current user's device for the given deviceId. May include an initial push token.
{
"deviceId": "string",
"platform": "ios",
"clientAppVersion": null,
"osVersion": null,
"locale": null,
"pushToken": null,
"pushProvider": null
}{
"id": "00000000-0000-4000-8000-000000000000",
"deviceId": "string",
"revived": true
}curl -X POST "https://om.opperescala.com/api/devices" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"deviceId\": \"string\",
\"platform\": \"ios\",
\"clientAppVersion\": null,
\"osVersion\": null,
\"locale\": null,
\"pushToken\": null,
\"pushProvider\": null
}"/devices/{id}Updates last-seen, app/OS metadata, and push token for a device owned by the current user. Set pushToken to null to clear a revoked OS permission.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"clientAppVersion": null,
"osVersion": null,
"locale": null,
"pushToken": null,
"pushProvider": null
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/devices/:id" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"clientAppVersion\": null,
\"osVersion\": null,
\"locale\": null,
\"pushToken\": null,
\"pushProvider\": null
}"/devices/{id}Soft-deletes a device owned by the current user.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/devices/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/devices/admin/devicesReturns the authenticated user's registered devices (admin) (admins may list across users). Response keys are camelCase. The snake_case keys (`user_id`, `device_id`, `last_seen_at`, …) are deprecated aliases of their camelCase counterparts, retained for one minor version and removed in the next; read `userId`, `deviceId`, `lastSeenAt`, … instead.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| platform | query | No | any | — |
| userId | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": null,
"userId": "00000000-0000-4000-8000-000000000000",
"deviceId": "string",
"platform": "ios",
"clientAppVersion": null,
"osVersion": null,
"locale": null,
"pushProvider": null,
"pushTokenUpdatedAt": null,
"lastSeenAt": null,
"createdAt": null,
"updatedAt": null,
"tenant_id": "00000000-0000-4000-8000-000000000000",
"organization_id": null,
"user_id": "00000000-0000-4000-8000-000000000000",
"device_id": "string",
"client_app_version": null,
"os_version": null,
"push_provider": null,
"push_token_updated_at": null,
"last_seen_at": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/devices/admin/devices?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/devices/admin/devicesAdmin: register (idempotently upsert) a device on behalf of any user in the tenant.
{
"deviceId": "string",
"platform": "ios",
"clientAppVersion": null,
"osVersion": null,
"locale": null,
"pushToken": null,
"pushProvider": null,
"userId": "00000000-0000-4000-8000-000000000000"
}{
"id": "00000000-0000-4000-8000-000000000000",
"deviceId": "string",
"revived": true
}curl -X POST "https://om.opperescala.com/api/devices/admin/devices" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"deviceId\": \"string\",
\"platform\": \"ios\",
\"clientAppVersion\": null,
\"osVersion\": null,
\"locale\": null,
\"pushToken\": null,
\"pushProvider\": null,
\"userId\": \"00000000-0000-4000-8000-000000000000\"
}"/onboarding/onboarding"string"
curl -X POST "https://om.opperescala.com/api/onboarding/onboarding" \ -H "Accept: application/json"
/onboarding/onboarding/status"string"
curl -X GET "https://om.opperescala.com/api/onboarding/onboarding/status" \ -H "Accept: application/json"
/onboarding/onboarding/verify"string"
curl -X GET "https://om.opperescala.com/api/onboarding/onboarding/verify" \ -H "Accept: application/json"
/version"string"
curl -X GET "https://om.opperescala.com/api/version" \ -H "Accept: application/json"
/business_rules/executeManually executes applicable business rules for the specified entity type, event, and data. Supports dry-run mode to test rules without executing actions.
{
"entityType": "string",
"dryRun": false
}{
"allowed": true,
"executedRules": [
{
"ruleId": "string",
"ruleName": "string",
"conditionResult": true,
"executionTime": 1
}
],
"totalExecutionTime": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/business_rules/execute" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityType\": \"string\",
\"dryRun\": false
}"/business_rules/execute/{ruleId}Directly executes a specific business rule identified by its UUID, bypassing the normal entityType/eventType discovery mechanism. Useful for workflows and targeted rule execution.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| ruleId | path | Yes | any | The database UUID of the business rule to execute |
{
"dryRun": false
}{
"success": true,
"ruleId": "string",
"ruleName": "string",
"conditionResult": true,
"actionsExecuted": null,
"executionTime": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/business_rules/execute/00000000-0000-4000-8000-000000000000" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"dryRun\": false
}"/business_rules/logsReturns rule execution history for the current tenant and organization with filtering and pagination. Useful for audit trails and debugging.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| ruleId | query | No | any | — |
| entityId | query | No | any | — |
| entityType | query | No | any | — |
| executionResult | query | No | any | — |
| executedBy | query | No | any | — |
| executedAtFrom | query | No | any | — |
| executedAtTo | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": "string",
"ruleId": "string",
"ruleName": "string",
"ruleType": "string",
"entityId": "00000000-0000-4000-8000-000000000000",
"entityType": "string",
"executionResult": "SUCCESS",
"inputContext": null,
"outputContext": null,
"errorMessage": null,
"executionTimeMs": 1,
"executedAt": "string",
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": null,
"executedBy": null
}
],
"total": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/business_rules/logs?page=1&pageSize=50&sortDir=desc" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/business_rules/logs/{id}Returns detailed information about a specific rule execution, including full context and results.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "string",
"rule": {
"id": "00000000-0000-4000-8000-000000000000",
"ruleId": "string",
"ruleName": "string",
"ruleType": "string",
"entityType": "string"
},
"entityId": "00000000-0000-4000-8000-000000000000",
"entityType": "string",
"executionResult": "SUCCESS",
"inputContext": null,
"outputContext": null,
"errorMessage": null,
"executionTimeMs": 1,
"executedAt": "string",
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": null,
"executedBy": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/business_rules/logs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/business_rules/openmercato-call-optionsReturns executable Open Mercato API endpoint options and safe API key profile metadata for business-rule actions.
{
"endpoints": [
{
"id": "string",
"path": "string",
"method": "GET",
"label": "string",
"summary": null,
"operationId": null
}
],
"apiKeys": [
{
"id": "string",
"name": "string",
"keyPrefix": "string",
"organizationId": null,
"organizationName": null,
"roles": [
{
"id": "string",
"name": null
}
]
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/business_rules/openmercato-call-options" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/business_rules/rulesReturns business rules for the current tenant and organization with filtering and pagination.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| ruleId | query | No | any | — |
| ruleType | query | No | any | — |
| entityType | query | No | any | — |
| eventType | query | No | any | — |
| enabled | query | No | any | — |
| ruleCategory | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"ruleId": "string",
"ruleName": "string",
"description": null,
"ruleType": "GUARD",
"ruleCategory": null,
"entityType": "string",
"eventType": null,
"enabled": true,
"priority": 1,
"version": 1,
"effectiveFrom": null,
"effectiveTo": null,
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"createdAt": "string",
"updatedAt": "string"
}
],
"total": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/business_rules/rules?page=1&pageSize=50&sortDir=desc" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/business_rules/rulesCreates a new business rule for the current tenant and organization.
{
"ruleId": "string",
"ruleName": "string",
"description": null,
"ruleType": "GUARD",
"ruleCategory": null,
"entityType": "string",
"eventType": null,
"enabled": true,
"priority": 100,
"version": 1,
"effectiveFrom": null,
"effectiveTo": null,
"tenantId": "string",
"organizationId": "string",
"createdBy": null,
"conditionExpression": null,
"successActions": null,
"failureActions": null
}{
"id": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/business_rules/rules" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"ruleId\": \"string\",
\"ruleName\": \"string\",
\"description\": null,
\"ruleType\": \"GUARD\",
\"ruleCategory\": null,
\"entityType\": \"string\",
\"eventType\": null,
\"enabled\": true,
\"priority\": 100,
\"version\": 1,
\"effectiveFrom\": null,
\"effectiveTo\": null,
\"tenantId\": \"string\",
\"organizationId\": \"string\",
\"createdBy\": null,
\"conditionExpression\": null,
\"successActions\": null,
\"failureActions\": null
}"/business_rules/rulesUpdates an existing business rule.
{
"description": null,
"ruleCategory": null,
"eventType": null,
"enabled": true,
"priority": 100,
"version": 1,
"effectiveFrom": null,
"effectiveTo": null,
"conditionExpression": null,
"successActions": null,
"failureActions": null,
"id": "string"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/business_rules/rules" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"description\": null,
\"ruleCategory\": null,
\"eventType\": null,
\"enabled\": true,
\"priority\": 100,
\"version\": 1,
\"effectiveFrom\": null,
\"effectiveTo\": null,
\"conditionExpression\": null,
\"successActions\": null,
\"failureActions\": null,
\"id\": \"string\"
}"/business_rules/rulesSoft deletes a business rule by identifier.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | Yes | any | Business rule identifier |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/business_rules/rules?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/business_rules/rules/{id}Returns complete details of a business rule including conditions and actions.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"ruleId": "string",
"ruleName": "string",
"description": null,
"ruleType": "GUARD",
"ruleCategory": null,
"entityType": "string",
"eventType": null,
"successActions": null,
"failureActions": null,
"enabled": true,
"priority": 1,
"version": 1,
"effectiveFrom": null,
"effectiveTo": null,
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"createdBy": null,
"updatedBy": null,
"createdAt": "string",
"updatedAt": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/business_rules/rules/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/business_rules/setsReturns rule sets for the current tenant and organization with filtering and pagination.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| setId | query | No | any | — |
| enabled | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"setId": "string",
"setName": "string",
"description": null,
"enabled": true,
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"createdBy": null,
"updatedBy": null,
"createdAt": "string",
"updatedAt": "string"
}
],
"total": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/business_rules/sets?page=1&pageSize=50&sortDir=asc" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/business_rules/setsCreates a new rule set for organizing business rules.
{
"setId": "string",
"setName": "string",
"description": null,
"enabled": true,
"tenantId": "string",
"organizationId": "string",
"createdBy": null
}{
"id": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/business_rules/sets" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"setId\": \"string\",
\"setName\": \"string\",
\"description\": null,
\"enabled\": true,
\"tenantId\": \"string\",
\"organizationId\": \"string\",
\"createdBy\": null
}"/business_rules/setsUpdates an existing rule set.
{
"description": null,
"enabled": true,
"id": "string"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/business_rules/sets" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"description\": null,
\"enabled\": true,
\"id\": \"string\"
}"/business_rules/setsSoft deletes a rule set by identifier.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | Yes | any | Rule set identifier |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/business_rules/sets?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/business_rules/sets/{id}Returns detailed information about a specific rule set, including all member rules.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"setId": "string",
"setName": "string",
"description": null,
"enabled": true,
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"createdBy": null,
"updatedBy": null,
"createdAt": "string",
"updatedAt": "string",
"members": [
{
"id": "00000000-0000-4000-8000-000000000000",
"ruleId": "00000000-0000-4000-8000-000000000000",
"ruleName": "string",
"ruleType": "string",
"sequence": 1,
"enabled": true
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/business_rules/sets/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/business_rules/sets/{id}/membersAdds a business rule to a rule set with specified sequence and enabled state.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ruleId": "00000000-0000-4000-8000-000000000000",
"sequence": 0,
"enabled": true
}{
"id": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/business_rules/sets/:id/members" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"ruleId\": \"00000000-0000-4000-8000-000000000000\",
\"sequence\": 0,
\"enabled\": true
}"/business_rules/sets/{id}/membersUpdates sequence or enabled state of a rule set member.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"memberId": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/business_rules/sets/:id/members" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"memberId\": \"00000000-0000-4000-8000-000000000000\"
}"/business_rules/sets/{id}/membersRemoves a business rule from a rule set (hard delete).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| memberId | query | Yes | any | Member identifier |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/business_rules/sets/:id/members?memberId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/feature_toggles/check/booleanChecks if a feature toggle is enabled for the current context.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| identifier | query | Yes | any | Feature toggle identifier |
{
"enabled": true,
"source": "override",
"toggleId": "string",
"identifier": "string",
"tenantId": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/feature_toggles/check/boolean?identifier=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/feature_toggles/check/jsonGets the json configuration for a feature toggle.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| identifier | query | Yes | any | Feature toggle identifier |
{
"valueType": "json",
"source": "override",
"toggleId": "string",
"identifier": "string",
"tenantId": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/feature_toggles/check/json?identifier=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/feature_toggles/check/numberGets the number configuration for a feature toggle.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| identifier | query | Yes | any | Feature toggle identifier |
{
"valueType": "number",
"value": 1,
"source": "override",
"toggleId": "string",
"identifier": "string",
"tenantId": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/feature_toggles/check/number?identifier=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/feature_toggles/check/stringGets the string configuration for a feature toggle.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| identifier | query | Yes | any | Feature toggle identifier |
{
"valueType": "string",
"value": "string",
"source": "override",
"toggleId": "string",
"identifier": "string",
"tenantId": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/feature_toggles/check/string?identifier=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/feature_toggles/globalReturns all global feature toggles with filtering and pagination. Requires superadmin role.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | Page number for pagination |
| pageSize | query | No | any | Number of items per page (max 200) |
| search | query | No | any | Case-insensitive search across identifier, name, description, and category |
| type | query | No | any | Filter by toggle type (boolean, string, number, json) |
| category | query | No | any | Filter by category (case-insensitive partial match) |
| name | query | No | any | Filter by name (case-insensitive partial match) |
| identifier | query | No | any | Filter by identifier (case-insensitive partial match) |
| sortField | query | No | any | Field to sort by |
| sortDir | query | No | any | Sort direction (ascending or descending) |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"identifier": "string",
"name": "string",
"description": null,
"category": null,
"type": "boolean",
"defaultValue": null,
"createdAt": null,
"updatedAt": null
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/feature_toggles/global?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/feature_toggles/globalCreates a new global feature toggle. Requires superadmin role.
{
"identifier": "string",
"name": "string",
"description": null,
"category": null,
"type": "boolean",
"defaultValue": null
}{
"id": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/feature_toggles/global" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"identifier\": \"string\",
\"name\": \"string\",
\"description\": null,
\"category\": null,
\"type\": \"boolean\",
\"defaultValue\": null
}"/feature_toggles/globalUpdates an existing global feature toggle. Requires superadmin role.
{
"id": "00000000-0000-4000-8000-000000000000",
"description": null,
"category": null,
"defaultValue": null
}{
"id": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/feature_toggles/global" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"description\": null,
\"category\": null,
\"defaultValue\": null
}"/feature_toggles/globalSoft deletes a global feature toggle by ID. Requires superadmin role.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | Yes | any | Feature toggle identifier |
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/feature_toggles/global?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/feature_toggles/global/{id}Returns complete details of a feature toggle.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"identifier": "string",
"name": "string",
"description": null,
"category": null,
"type": "boolean",
"defaultValue": null,
"createdAt": null,
"updatedAt": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/feature_toggles/global/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/feature_toggles/global/{id}/overrideReturns feature toggle override.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"tenantName": "string",
"tenantId": "00000000-0000-4000-8000-000000000000",
"toggleType": "boolean",
"updatedAt": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/feature_toggles/global/:id/override" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/feature_toggles/overridesReturns list of feature toggle overrides.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| category | query | No | any | — |
| name | query | No | any | — |
| identifier | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"toggleId": "00000000-0000-4000-8000-000000000000",
"tenantName": "string",
"tenantId": "00000000-0000-4000-8000-000000000000",
"identifier": "string",
"name": "string",
"category": "string",
"isOverride": true
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1,
"isSuperAdmin": true
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/feature_toggles/overrides?page=1&pageSize=25" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/feature_toggles/overridesEnable, disable or inherit a feature toggle for a specific tenant.
{
"toggleId": "00000000-0000-4000-8000-000000000000",
"isOverride": true
}{
"ok": true,
"overrideToggleId": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/feature_toggles/overrides" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"toggleId\": \"00000000-0000-4000-8000-000000000000\",
\"isOverride\": true
}"/search/embeddingsReturns current embedding provider and model configuration.
{
"settings": {
"openaiConfigured": true,
"autoIndexingEnabled": true,
"autoIndexingLocked": true,
"lockReason": null,
"embeddingConfig": null,
"configuredProviders": [
"openai"
],
"indexedDimension": null,
"reindexRequired": true,
"documentCount": null
}
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/search/embeddings" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/search/embeddingsUpdates the embedding provider and model settings.
{}{
"settings": {
"openaiConfigured": true,
"autoIndexingEnabled": true,
"autoIndexingLocked": true,
"lockReason": null,
"embeddingConfig": null,
"configuredProviders": [
"openai"
],
"indexedDimension": null,
"reindexRequired": true,
"documentCount": null
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/search/embeddings" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/search/embeddings/reindexStarts a vector embedding reindex operation.
{}{
"ok": true
}{
"error": "string"
}{
"error": "string",
"lock": {
"type": "fulltext",
"action": "string",
"startedAt": "string",
"elapsedMinutes": 1,
"processedCount": null,
"totalCount": null
}
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/search/embeddings/reindex" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/search/embeddings/reindex/cancelCancels an in-progress vector reindex operation.
{
"ok": true,
"jobsRemoved": 1
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/search/embeddings/reindex/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/search/indexReturns paginated list of entries in the vector search index.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| entityId | query | No | any | Filter by entity ID (e.g., "customers:customer_person_profile", "catalog:catalog_product") |
| limit | query | No | any | Maximum entries to return (default: 50, max: 200) |
| offset | query | No | any | Offset for pagination (default: 0) |
{
"entries": [
{
"id": "string",
"entityId": "string",
"recordId": "string",
"tenantId": "string",
"organizationId": null
}
],
"limit": 1,
"offset": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/search/index" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/search/indexPurges entries from the vector search index. Requires confirmAll=true when purging all entities.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| entityId | query | No | any | Specific entity ID to purge (e.g., "customers:customer_person_profile", "catalog:catalog_product") |
| confirmAll | query | No | any | Required when purging all entities |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/search/index" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/search/reindexStarts a fulltext (Meilisearch) reindex operation. Can clear, recreate, or fully reindex.
{}{
"ok": true,
"action": "clear",
"entityId": null
}{
"error": "string"
}{
"error": "string",
"lock": {
"type": "fulltext",
"action": "string",
"startedAt": "string",
"elapsedMinutes": 1,
"processedCount": null,
"totalCount": null
}
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/search/reindex" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/search/reindex/cancelCancels an in-progress fulltext reindex operation.
{
"ok": true,
"jobsRemoved": 1
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/search/reindex/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/search/searchPerforms a search using configured strategies (fulltext, vector, tokens). Use for search playground. Results are limited to the entity types the caller holds the declared view features for; superadmins are exempt.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| q | query | Yes | any | Search query (required) |
| limit | query | No | any | Maximum results to return (default: 50, max: 100) |
| strategies | query | No | any | Comma-separated strategies to use: fulltext, vector, tokens (e.g., "fulltext,vector") |
| entityTypes | query | No | any | Comma-separated entity types to filter results (e.g., "customers:customer_person_profile,catalog:catalog_product,sales:sales_order") |
{
"results": [
{
"entityId": "string",
"recordId": "string",
"score": 1,
"source": "fulltext"
}
],
"strategiesUsed": [
"fulltext"
],
"timing": 1,
"query": "string",
"limit": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/search/search?q=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/search/search/globalPerforms a global search using saved tenant strategies. Does NOT accept strategies from URL.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| q | query | Yes | any | Search query (required) |
| limit | query | No | any | Maximum results to return (default: 50, max: 100) |
| entityTypes | query | No | any | Comma-separated entity types to filter results (e.g., "customers:customer_person_profile,catalog:catalog_product,sales:sales_order") |
{
"results": [
{
"entityId": "string",
"recordId": "string",
"score": 1,
"source": "fulltext"
}
],
"strategiesUsed": [
"fulltext"
],
"strategiesEnabled": [
"fulltext"
],
"timing": 1,
"query": "string",
"limit": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/search/search/global?q=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/search/settingsReturns search module configuration, available strategies, and reindex lock status.
{
"settings": {
"strategies": [
{
"id": "string",
"name": "string",
"priority": 1,
"available": true
}
],
"fulltextConfigured": true,
"fulltextStats": null,
"vectorConfigured": true,
"tokensEnabled": true,
"defaultStrategies": [
"string"
],
"reindexLock": null,
"fulltextReindexLock": null,
"vectorReindexLock": null
}
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/search/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/search/settings/fulltextReturns Meilisearch configuration status and index statistics.
{
"driver": null,
"configured": true,
"envVars": {
"MEILISEARCH_HOST": {
"set": true,
"hint": "string"
},
"MEILISEARCH_API_KEY": {
"set": true,
"hint": "string"
}
},
"optionalEnvVars": {
"MEILISEARCH_INDEX_PREFIX": {
"set": true,
"hint": "string"
},
"SEARCH_EXCLUDE_ENCRYPTED_FIELDS": {
"set": true,
"hint": "string"
}
}
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/search/settings/fulltext" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/search/settings/global-searchReturns the enabled strategies for Cmd+K global search.
{
"enabledStrategies": [
"fulltext"
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/search/settings/global-search" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/search/settings/global-searchSets which strategies are enabled for Cmd+K global search.
{
"enabledStrategies": [
"fulltext"
]
}{
"ok": true,
"enabledStrategies": [
"fulltext"
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/search/settings/global-search" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"enabledStrategies\": [
\"fulltext\"
]
}"/search/settings/vector-storeReturns vector store configuration status.
{
"currentDriver": "pgvector",
"configured": true,
"drivers": [
{
"id": "pgvector",
"name": "string",
"configured": true,
"implemented": true,
"available": null,
"unavailableReason": null,
"envVars": [
{
"name": "string",
"set": true,
"hint": "string"
}
]
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/search/settings/vector-store" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/currencies/currenciesReturns a paginated collection of currencies scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| isBase | query | No | any | — |
| isActive | query | No | any | — |
| code | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "string",
"code": "string",
"name": "string",
"symbol": null,
"decimalPlaces": 1,
"thousandsSeparator": null,
"decimalSeparator": null,
"isBase": true,
"isActive": true,
"createdAt": null,
"updatedAt": null,
"organizationId": "string",
"tenantId": "string"
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/currencies/currencies?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/currencies/currenciesCreates a new currency.
{
"organizationId": "string",
"tenantId": "string",
"code": "string",
"name": "string",
"symbol": null,
"thousandsSeparator": null,
"decimalSeparator": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/currencies/currencies" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"string\",
\"tenantId\": \"string\",
\"code\": \"string\",
\"name\": \"string\",
\"symbol\": null,
\"thousandsSeparator\": null,
\"decimalSeparator\": null
}"/currencies/currenciesUpdates an existing currency by id.
{
"id": "string",
"symbol": null,
"thousandsSeparator": null,
"decimalSeparator": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/currencies/currencies" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"string\",
\"symbol\": null,
\"thousandsSeparator\": null,
\"decimalSeparator\": null
}"/currencies/currenciesDeletes a currency by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/currencies/currencies" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/currencies/currencies/optionsReturns currencies formatted for select inputs.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| q | query | No | any | — |
| query | query | No | any | — |
| search | query | No | any | — |
| includeInactive | query | No | any | — |
| limit | query | No | any | — |
{
"items": [
{
"value": "string",
"label": "string"
}
]
}{
"items": []
}{
"items": []
}curl -X GET "https://om.opperescala.com/api/currencies/currencies/options?limit=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/currencies/exchange-ratesReturns a paginated collection of exchangerates scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| fromCurrencyCode | query | No | any | — |
| toCurrencyCode | query | No | any | — |
| isActive | query | No | any | — |
| source | query | No | any | — |
| type | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"fromCurrencyCode": "string",
"toCurrencyCode": "string",
"rate": "string",
"date": "string",
"source": "string",
"type": null,
"isActive": true,
"createdAt": null,
"updatedAt": null,
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000"
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/currencies/exchange-rates?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/currencies/exchange-ratesCreates a new exchange rate.
{
"organizationId": "string",
"tenantId": "string",
"fromCurrencyCode": "string",
"toCurrencyCode": "string",
"rate": "string",
"type": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/currencies/exchange-rates" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"string\",
\"tenantId\": \"string\",
\"fromCurrencyCode\": \"string\",
\"toCurrencyCode\": \"string\",
\"rate\": \"string\",
\"type\": null
}"/currencies/exchange-ratesUpdates an existing exchange rate by id.
{
"id": "string",
"type": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/currencies/exchange-rates" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"string\",
\"type\": null
}"/currencies/exchange-ratesDeletes an exchange rate by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/currencies/exchange-rates" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/currencies/fetch-configsReturns all currency fetch configurations scoped to the authenticated organization.
{
"configs": [
{
"id": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"provider": "string",
"isEnabled": true,
"syncTime": null,
"lastSyncAt": null,
"lastSyncStatus": null,
"lastSyncMessage": null,
"lastSyncCount": null,
"config": null,
"createdAt": "string",
"updatedAt": "string"
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/currencies/fetch-configs" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/currencies/fetch-configsCreates a new currency fetch configuration.
{
"provider": "NBP",
"isEnabled": false,
"syncTime": null,
"config": null
}{
"config": {
"id": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"provider": "string",
"isEnabled": true,
"syncTime": null,
"lastSyncAt": null,
"lastSyncStatus": null,
"lastSyncMessage": null,
"lastSyncCount": null,
"config": null,
"createdAt": "string",
"updatedAt": "string"
}
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/currencies/fetch-configs" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"provider\": \"NBP\",
\"isEnabled\": false,
\"syncTime\": null,
\"config\": null
}"/currencies/fetch-configsUpdates an existing currency fetch configuration by id.
{
"syncTime": null,
"config": null,
"id": "00000000-0000-4000-8000-000000000000"
}{
"config": {
"id": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"provider": "string",
"isEnabled": true,
"syncTime": null,
"lastSyncAt": null,
"lastSyncStatus": null,
"lastSyncMessage": null,
"lastSyncCount": null,
"config": null,
"createdAt": "string",
"updatedAt": "string"
}
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/currencies/fetch-configs" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"syncTime\": null,
\"config\": null,
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/currencies/fetch-configsDeletes a currency fetch configuration by id.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | Yes | any | Currency fetch configuration identifier to delete |
{
"success": true
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/currencies/fetch-configs?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/currencies/fetch-ratesFetches currency exchange rates from configured providers for a specific date.
{}{
"totalFetched": 1,
"byProvider": {
"key": {
"count": 1
}
},
"errors": [
"string"
]
}{
"error": "string"
}{
"error": "string"
}{
"totalFetched": 1,
"byProvider": {
"key": {
"count": 1
}
},
"errors": [
"string"
]
}curl -X POST "https://om.opperescala.com/api/currencies/fetch-rates" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{}"/eventsReturns every declared event, including its declared payloadSchema when the module (or the generated CRUD default) provides one. Filters: category, module, excludeTriggerExcluded (default true).
{
"data": [
{
"id": "string",
"label": "string"
}
],
"total": 1
}curl -X GET "https://om.opperescala.com/api/events" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/events/stream"string"
curl -X GET "https://om.opperescala.com/api/events/stream" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notificationsReturns a paginated collection of notifications.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| status | query | No | any | — |
| type | query | No | any | — |
| severity | query | No | any | — |
| sourceEntityType | query | No | any | — |
| sourceEntityId | query | No | any | — |
| since | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"type": "string",
"title": "string",
"body": null,
"titleKey": null,
"bodyKey": null,
"titleVariables": null,
"bodyVariables": null,
"icon": null,
"severity": "string",
"status": "string",
"actions": [
{
"id": "string",
"label": "string"
}
],
"sourceModule": null,
"sourceEntityType": null,
"sourceEntityId": null,
"linkHref": null,
"createdAt": "string",
"readAt": null,
"actionTaken": null
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}{
"error": "string",
"code": "string"
}curl -X GET "https://om.opperescala.com/api/notifications?page=1&pageSize=20" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notificationsCreates a notification for a user.
{
"type": "string",
"severity": "info",
"recipientUserId": "00000000-0000-4000-8000-000000000000"
}{
"id": "00000000-0000-4000-8000-000000000000"
}curl -X POST "https://om.opperescala.com/api/notifications" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"type\": \"string\",
\"severity\": \"info\",
\"recipientUserId\": \"00000000-0000-4000-8000-000000000000\"
}"/notifications/{id}/action| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X POST "https://om.opperescala.com/api/notifications/:id/action" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/{id}/dismiss| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X PUT "https://om.opperescala.com/api/notifications/:id/dismiss" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/{id}/read| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X PUT "https://om.opperescala.com/api/notifications/:id/read" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/{id}/restore| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X PUT "https://om.opperescala.com/api/notifications/:id/restore" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/admin/preferences"string"
curl -X GET "https://om.opperescala.com/api/notifications/admin/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/admin/preferences"string"
curl -X PUT "https://om.opperescala.com/api/notifications/admin/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/batch"string"
curl -X POST "https://om.opperescala.com/api/notifications/batch" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/channels"string"
curl -X GET "https://om.opperescala.com/api/notifications/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/feature"string"
curl -X POST "https://om.opperescala.com/api/notifications/feature" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/mark-all-read"string"
curl -X PUT "https://om.opperescala.com/api/notifications/mark-all-read" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/preferences"string"
curl -X GET "https://om.opperescala.com/api/notifications/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/preferences"string"
curl -X PUT "https://om.opperescala.com/api/notifications/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/role"string"
curl -X POST "https://om.opperescala.com/api/notifications/role" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/settings"string"
curl -X GET "https://om.opperescala.com/api/notifications/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/settings"string"
curl -X POST "https://om.opperescala.com/api/notifications/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/types"string"
curl -X GET "https://om.opperescala.com/api/notifications/types" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/types"string"
curl -X PATCH "https://om.opperescala.com/api/notifications/types" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/notifications/types/{id}/channels/{channel}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| channel | path | Yes | any | — |
"string"
curl -X PUT "https://om.opperescala.com/api/notifications/types/:id/channels/:channel" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/progress/active"string"
curl -X GET "https://om.opperescala.com/api/progress/active" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/progress/jobsReturns a paginated collection of progressjobs scoped to the authenticated tenant.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| status | query | No | any | — |
| jobType | query | No | any | — |
| parentJobId | query | No | any | — |
| includeCompleted | query | No | any | — |
| completedSince | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"jobType": "string",
"name": "string",
"description": null,
"status": "string",
"progressPercent": 1,
"processedCount": 1,
"totalCount": null,
"etaSeconds": null,
"cancellable": true,
"startedAt": null,
"finishedAt": null,
"errorMessage": null,
"createdAt": null,
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/progress/jobs?page=1&pageSize=20" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/progress/jobsCreates a new progress job for tracking a long-running operation.
{
"jobType": "string",
"name": "string",
"cancellable": false
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/progress/jobs" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"jobType\": \"string\",
\"name\": \"string\",
\"cancellable\": false
}"/progress/jobs/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/progress/jobs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/progress/jobs/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X PUT "https://om.opperescala.com/api/progress/jobs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/progress/jobs/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
No response body.
curl -X DELETE "https://om.opperescala.com/api/progress/jobs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/integrationsReturns a paginated collection of integrations.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| q | query | No | any | — |
| category | query | No | any | — |
| bundleId | query | No | any | — |
| isEnabled | query | No | any | — |
| healthStatus | query | No | any | — |
| sort | query | No | any | — |
| order | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "string",
"title": "string",
"description": null,
"category": null,
"tags": [
"string"
],
"hub": null,
"providerKey": null,
"bundleId": null,
"author": null,
"company": null,
"version": null,
"hasCredentials": true,
"isEnabled": true,
"apiVersion": null,
"healthStatus": "healthy",
"lastHealthCheckedAt": null,
"lastHealthLatencyMs": null,
"enabledAt": null,
"analytics": {
"lastActivityAt": null,
"totalCount": 1,
"errorCount": 1,
"errorRate": 1,
"dailyCounts": [
1
]
}
}
],
"total": 1,
"totalPages": 1,
"bundles": [
{
"id": "string",
"title": "string",
"description": "string",
"icon": null,
"integrationCount": 1,
"enabledCount": 1
}
]
}curl -X GET "https://om.opperescala.com/api/integrations?order=asc&page=1&pageSize=100" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/integrations/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/integrations/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/integrations/{id}/credentials| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/integrations/:id/credentials" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/integrations/{id}/credentials| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X PUT "https://om.opperescala.com/api/integrations/:id/credentials" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/integrations/{id}/health| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X POST "https://om.opperescala.com/api/integrations/:id/health" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/integrations/{id}/state| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X PUT "https://om.opperescala.com/api/integrations/:id/state" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/integrations/{id}/version| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X PUT "https://om.opperescala.com/api/integrations/:id/version" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/integrations/logs"string"
curl -X GET "https://om.opperescala.com/api/integrations/logs" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/mappings"string"
curl -X GET "https://om.opperescala.com/api/data_sync/mappings" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/mappings"string"
curl -X POST "https://om.opperescala.com/api/data_sync/mappings" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/mappings/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/data_sync/mappings/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/mappings/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X PUT "https://om.opperescala.com/api/data_sync/mappings/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/mappings/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
No response body.
curl -X DELETE "https://om.opperescala.com/api/data_sync/mappings/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/options"string"
curl -X GET "https://om.opperescala.com/api/data_sync/options" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/run"string"
curl -X POST "https://om.opperescala.com/api/data_sync/run" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/runs"string"
curl -X GET "https://om.opperescala.com/api/data_sync/runs" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/runs/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/data_sync/runs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/runs/{id}/cancel| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X POST "https://om.opperescala.com/api/data_sync/runs/:id/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/runs/{id}/retry| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X POST "https://om.opperescala.com/api/data_sync/runs/:id/retry" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/schedules"string"
curl -X GET "https://om.opperescala.com/api/data_sync/schedules" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/schedules"string"
curl -X POST "https://om.opperescala.com/api/data_sync/schedules" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/schedules/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/data_sync/schedules/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/schedules/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X PUT "https://om.opperescala.com/api/data_sync/schedules/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/schedules/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
No response body.
curl -X DELETE "https://om.opperescala.com/api/data_sync/schedules/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/data_sync/validate"string"
curl -X POST "https://om.opperescala.com/api/data_sync/validate" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sync_excel/import{
"runId": "00000000-0000-4000-8000-000000000000",
"progressJobId": null,
"status": "pending"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/sync_excel/import" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sync_excel/preview{
"uploadId": "00000000-0000-4000-8000-000000000000",
"filename": "string",
"mimeType": "string",
"fileSize": 1,
"entityType": "customers.person",
"headers": [
"string"
],
"sampleRows": [
{
"key": null
}
],
"totalRows": 1,
"suggestedMapping": {
"entityType": "customers.person",
"matchStrategy": "externalId",
"fields": [
{
"externalField": "string",
"localField": "string"
}
],
"unmappedColumns": [
"string"
]
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/sync_excel/preview" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sync_excel/uploadstring
{
"uploadId": "00000000-0000-4000-8000-000000000000",
"filename": "string",
"mimeType": "string",
"fileSize": 1,
"entityType": "customers.person",
"headers": [
"string"
],
"sampleRows": [
{
"key": null
}
],
"totalRows": 1,
"suggestedMapping": {
"entityType": "customers.person",
"matchStrategy": "externalId",
"fields": [
{
"externalField": "string",
"localField": "string"
}
],
"unmappedColumns": [
"string"
]
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/sync_excel/upload" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| folder | query | No | any | — |
| status | query | No | any | — |
| type | query | No | any | — |
| visibility | query | No | any | — |
| sourceEntityType | query | No | any | — |
| sourceEntityId | query | No | any | — |
| externalEmail | query | No | any | — |
| hasObjects | query | No | any | — |
| hasAttachments | query | No | any | — |
| hasActions | query | No | any | — |
| senderId | query | No | any | — |
| search | query | No | any | — |
| since | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"type": "string",
"visibility": null,
"sourceEntityType": null,
"sourceEntityId": null,
"externalEmail": null,
"externalName": null,
"subject": "string",
"bodyPreview": "string",
"senderUserId": "00000000-0000-4000-8000-000000000000",
"senderName": null,
"senderEmail": null,
"priority": "string",
"status": "string",
"hasObjects": true,
"objectCount": 1,
"hasAttachments": true,
"attachmentCount": 1,
"recipientCount": 1,
"hasActions": true,
"actionTaken": null,
"sentAt": null,
"readAt": null,
"threadId": null
}
],
"page": 1,
"pageSize": 1,
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/messages?folder=inbox&page=1&pageSize=20" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages{
"type": "default",
"visibility": null,
"recipients": [],
"subject": "",
"body": "",
"bodyFormat": "text",
"priority": "normal",
"sendViaEmail": false,
"isDraft": false
}{
"id": "00000000-0000-4000-8000-000000000000",
"threadId": null
}curl -X POST "https://om.opperescala.com/api/messages" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"type\": \"default\",
\"visibility\": null,
\"recipients\": [],
\"subject\": \"\",
\"body\": \"\",
\"bodyFormat\": \"text\",
\"priority\": \"normal\",
\"sendViaEmail\": false,
\"isDraft\": false
}"/messages/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"updatedAt": null,
"type": "string",
"isDraft": true,
"canEditDraft": true,
"canArchive": true,
"isArchived": true,
"visibility": null,
"sourceEntityType": null,
"sourceEntityId": null,
"externalEmail": null,
"externalName": null,
"typeDefinition": {
"labelKey": "string",
"icon": "string",
"color": null,
"allowReply": true,
"allowForward": true,
"ui": null
},
"threadId": null,
"parentMessageId": null,
"senderUserId": "00000000-0000-4000-8000-000000000000",
"senderName": null,
"senderEmail": null,
"subject": "string",
"body": "string",
"bodyFormat": "text",
"priority": "string",
"sentAt": null,
"actionData": null,
"actionTaken": null,
"actionTakenAt": null,
"actionTakenByUserId": null,
"recipients": [
{
"userId": "00000000-0000-4000-8000-000000000000",
"type": "to",
"status": "string",
"readAt": null
}
],
"objects": [
{
"id": "00000000-0000-4000-8000-000000000000",
"entityModule": "string",
"entityType": "string",
"entityId": "00000000-0000-4000-8000-000000000000",
"actionRequired": true,
"actionType": null,
"actionLabel": null,
"snapshot": null,
"preview": null
}
],
"thread": [
{
"id": "00000000-0000-4000-8000-000000000000",
"senderUserId": "00000000-0000-4000-8000-000000000000",
"senderName": null,
"senderEmail": null,
"externalName": null,
"externalEmail": null,
"sourceEntityType": null,
"body": "string",
"sentAt": null
}
],
"isRead": true,
"conversationArchived": true,
"conversationAllUnread": true,
"_channel": null,
"_channelPayload": null,
"_channelContact": null
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/messages/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"visibility": null
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PATCH "https://om.opperescala.com/api/messages/:id" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"visibility\": null
}"/messages/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/messages/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages/{id}/actions/{actionId}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| actionId | path | Yes | any | — |
"string"
{
"ok": true,
"actionId": "string"
}"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/messages/:id/actions/:actionId" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages/{id}/archive| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/messages/:id/archive" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages/{id}/archive| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/messages/:id/archive" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages/{id}/attachments| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"attachments": [
{
"id": "00000000-0000-4000-8000-000000000000",
"fileName": "string",
"fileSize": 1,
"mimeType": "string",
"url": "string"
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/messages/:id/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages/{id}/attachments| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"attachmentIds": [
"00000000-0000-4000-8000-000000000000"
]
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/messages/:id/attachments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"attachmentIds\": [
\"00000000-0000-4000-8000-000000000000\"
]
}"/messages/{id}/attachments| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/messages/:id/attachments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/messages/{id}/confirmation| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"messageId": "00000000-0000-4000-8000-000000000000",
"confirmed": true,
"confirmedAt": null,
"confirmedByUserId": null
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/messages/:id/confirmation" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages/{id}/conversation| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"affectedCount": 1
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/messages/:id/conversation" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages/{id}/conversation/archive| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"affectedCount": 1
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/messages/:id/conversation/archive" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages/{id}/conversation/archive| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"affectedCount": 1
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/messages/:id/conversation/archive" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages/{id}/conversation/read| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"affectedCount": 1
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/messages/:id/conversation/read" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages/{id}/conversation/read| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"affectedCount": 1
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/messages/:id/conversation/read" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages/{id}/forward| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"recipients": [
{
"userId": "00000000-0000-4000-8000-000000000000",
"type": "to"
}
],
"includeAttachments": true,
"sendViaEmail": false
}{
"id": "00000000-0000-4000-8000-000000000000"
}"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/messages/:id/forward" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"recipients\": [
{
\"userId\": \"00000000-0000-4000-8000-000000000000\",
\"type\": \"to\"
}
],
\"includeAttachments\": true,
\"sendViaEmail\": false
}"/messages/{id}/forward-preview| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"subject": "string",
"body": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/messages/:id/forward-preview" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/messages/{id}/read| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/messages/:id/read" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/channels/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
No response body.
curl -X DELETE "https://om.opperescala.com/api/communication_channels/channels/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/push_notifications/custom-send"string"
curl -X POST "https://om.opperescala.com/api/push_notifications/custom-send" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/actions/{id}Returns the tenant-scoped {@link AiPendingAction} addressed by `:id`. Powers the chat UI reconnect/polling path: after a page reload or SSE reconnect the client carries the `pendingActionId` from an earlier `mutation-preview-card` UI part and calls this route to re-hydrate the card. Server-internal fields (`normalizedInput`, `createdByUserId`, `idempotencyKey`) are stripped by a whitelist serializer. Enforces tenant/org scoping via the repository.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/ai_assistant/ai/actions/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/actions/{id}/cancelFlips a pending AI action from `pending` to `cancelled` and emits the `ai.action.cancelled` event. The tool handler is never invoked. Idempotent: a second call on a row already in `cancelled` status returns 200 with the current row without re-emitting the event. Rows whose `expiresAt` is in the past are flipped to `expired` and returned as 409 `expired` so the client can surface the TTL loss instead of silently masking it as a cancellation.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/ai_assistant/ai/actions/:id/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/actions/{id}/confirmRe-verifies the full contract from spec §9.4 (status, expiry, agent registration, required features, mutation policy, tool whitelist, attachment tenant scope, record version, and schema drift), flips the pending-action state machine to `executing`, invokes the wrapped tool handler, and persists `executionResult`. Idempotent: a second call on a row already in `confirmed` state returns the prior result without re-executing the handler.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/ai_assistant/ai/actions/:id/confirm" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/agentsReturns `{ agents: [...] }` — the subset of agents from `ai-agents.generated.ts` that the authenticated caller can invoke based on each agent's `requiredFeatures`. Mirrors the `meta.list_agents` tool handler so backoffice pages (e.g. the playground) can render an agent picker without going through the MCP tool transport.
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/ai_assistant/ai/agents" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/agents/{agentId}/loop-overrideReturns `{ agentId, override }` where `override` is the agent-scoped loop-policy row from `ai_agent_runtime_overrides` (or `null`). Requires `ai_assistant.view`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| agentId | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/ai_assistant/ai/agents/:agentId/loop-override" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/agents/{agentId}/loop-overrideBody: loop columns. All fields are nullable/optional; `null` explicitly clears that axis. Validates `loopStopWhenJson` items and `loopActiveToolsJson` membership. Requires `ai_assistant.settings.manage`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| agentId | path | Yes | any | — |
{
"loopDisabled": null,
"loopMaxSteps": null,
"loopMaxToolCalls": null,
"loopMaxWallClockMs": null,
"loopMaxTokens": null,
"loopStopWhenJson": null,
"loopActiveToolsJson": null
}"string"
"string"
"string"
"string"
"string"
curl -X PUT "https://om.opperescala.com/api/ai_assistant/ai/agents/:agentId/loop-override" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"loopDisabled\": null,
\"loopMaxSteps\": null,
\"loopMaxToolCalls\": null,
\"loopMaxWallClockMs\": null,
\"loopMaxTokens\": null,
\"loopStopWhenJson\": null,
\"loopActiveToolsJson\": null
}"/ai_assistant/ai/agents/{agentId}/loop-overrideNulls out all seven loop columns on the agent-scoped `ai_agent_runtime_overrides` row. Idempotent — returns 200 even when no override exists. Requires `ai_assistant.settings.manage`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| agentId | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
curl -X DELETE "https://om.opperescala.com/api/ai_assistant/ai/agents/:agentId/loop-override" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/agents/{agentId}/modelsReturns all configured providers with their curated model catalogs, filtered to providers that have an API key configured in the current environment. When the agent declares `allowRuntimeOverride: false`, the response reflects that constraint so the UI picker can hide itself. Includes the agent's resolved default provider/model so the picker can render a "(default)" badge next to the right entry. When a tenant-scoped lookup (the allowlist snapshot or the per-agent runtime override) cannot be loaded, the route still answers 200 with a partially resolved provider list and sets `degraded: true` plus a `degradedReason` code, so callers can tell a full entitlement list from a partial one. RBAC: requires the same features as the agent itself (typically `ai_assistant.view`).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| agentId | path | Yes | any | — |
"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/ai_assistant/ai/agents/:agentId/models" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/agents/{agentId}/mutation-policyReturns `{ agentId, codeDeclared, override }` where `codeDeclared` is the agent's compiled-in `mutationPolicy` and `override` is the persisted tenant-scoped override (or `null`). Requires `ai_assistant.view`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| agentId | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/ai_assistant/ai/agents/:agentId/mutation-policy" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/agents/{agentId}/mutation-policyBody: `{ mutationPolicy: "read-only" | "confirm-required" | "destructive-confirm-required", notes? }`. The override MUST NOT escalate beyond the agent's code-declared policy. Escalation attempts are rejected with 400 + `code: "escalation_not_allowed"`. Requires `ai_assistant.settings.manage`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| agentId | path | Yes | any | — |
{
"mutationPolicy": "read-only"
}"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/ai_assistant/ai/agents/:agentId/mutation-policy" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"mutationPolicy\": \"read-only\"
}"/ai_assistant/ai/agents/{agentId}/mutation-policyDeletes the override row if it exists; subsequent calls fall back to the agent's code-declared policy. Idempotent — returns 200 even when no override exists. Requires `ai_assistant.settings.manage`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| agentId | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
curl -X DELETE "https://om.opperescala.com/api/ai_assistant/ai/agents/:agentId/mutation-policy" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/agents/{agentId}/prompt-overrideReturns `{ agentId, override, versions }` where `override` is the latest persisted row (or `null`) and `versions` is the newest-first history capped at 10 rows. Tenant-scoped; requires `ai_assistant.settings.manage`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| agentId | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/ai_assistant/ai/agents/:agentId/prompt-override" \ -H "Accept: application/json"
/ai_assistant/ai/agents/{agentId}/prompt-overridePersists an additive `{ sections: Record<sectionId, text>, notes? }` override, allocating the next monotonic version for `(tenant, org, agent)`. Reserved policy keys (`mutationPolicy`, `readOnly`, `allowedTools`, `acceptedMediaTypes`) are rejected with 400 / `reserved_key`. Requires `ai_assistant.settings.manage`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| agentId | path | Yes | any | — |
{}"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/ai_assistant/ai/agents/:agentId/prompt-override" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{}"/ai_assistant/ai/chatDispatches a chat turn to the focused AI agent identified by `?agent=<module>.<agent>`. Enforces agent-level `requiredFeatures`, tool whitelisting, read-only / mutationPolicy, execution-mode compatibility, and attachment media-type policy. The streaming response body uses an AI SDK-compatible `text/event-stream` transport. Optional `?provider=`, `?model=`, and `?baseUrl=` query params let callers override the resolved provider/model/base-URL for this turn (Phase 4a). Provider must be registered and configured; baseUrl must match `AI_RUNTIME_BASEURL_ALLOWLIST` when set. Both are suppressed when the agent declares `allowRuntimeOverride: false`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| agent | query | Yes | any | — |
| provider | query | No | any | — |
| model | query | No | any | — |
| baseUrl | query | No | any | — |
| loopBudget | query | No | any | — |
{
"messages": [
{
"role": "user",
"content": "string"
}
]
}string
"string"
"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/ai_assistant/ai/chat?agent=string" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"messages\": [
{
\"role\": \"user\",
\"content\": \"string\"
}
]
}"/ai_assistant/ai/conversationsReturns `{ items, nextCursor }` for the authenticated caller, ordered by `lastMessageAt` descending. View-only callers receive only their own conversations. Callers with `ai_assistant.conversations.manage` may list conversations across users in the same tenant/organization. The `agent` and `status` filters are optional; `cursor` is the ISO timestamp returned by a previous response.
"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/ai_assistant/ai/conversations" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/conversationsIf a non-deleted conversation already exists with the supplied `conversationId` for the authenticated caller in this tenant/org, returns the existing summary. Otherwise creates a fresh row and writes the owner-participant row in the same transaction.
"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/ai_assistant/ai/conversations" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/conversations/{conversationId}Returns `{ conversation, messages, nextCursor }` for the supplied `conversationId`. View-only callers can load only their own conversations. Callers with `ai_assistant.conversations.manage` can load conversations across users in the same tenant/organization. Messages are ordered ascending by `createdAt`. The `before` cursor returns the next older page when paging back through long transcripts.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| conversationId | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/ai_assistant/ai/conversations/:conversationId" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/conversations/{conversationId}Accepts a partial body containing any of `title`, `status`, `pageContext`. Setting `status` to `closed` archives the conversation while keeping its transcript intact. View-only callers can update only their own conversations; conversation managers can update conversations in the same tenant/organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| conversationId | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
curl -X PATCH "https://om.opperescala.com/api/ai_assistant/ai/conversations/:conversationId" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/conversations/{conversationId}View-only callers can delete only their own conversations. Callers with `ai_assistant.conversations.manage` can delete conversations in the same tenant/organization. Marks the conversation row and every undeleted message row with a `deleted_at` timestamp in one transaction. The transcript remains in the database for audit/restore until a future retention worker hard-deletes it.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| conversationId | path | Yes | any | — |
"string"
"string"
"string"
"string"
curl -X DELETE "https://om.opperescala.com/api/ai_assistant/ai/conversations/:conversationId" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ai_assistant/ai/conversations/{conversationId}/participantsReturns the list of active (non-revoked) participants for the conversation. Only the conversation owner or a caller with `ai_assistant.conversations.manage` can call this endpoint.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| conversationId | path | Yes | any | — |
"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/ai_assistant/ai/conversations/:conversationId/participants" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/translations/locales"string"
curl -X GET "https://om.opperescala.com/api/translations/locales" \ -H "Accept: application/json"
/translations/locales"string"
curl -X PUT "https://om.opperescala.com/api/translations/locales" \ -H "Accept: application/json"
/scheduler/jobsReturns a paginated collection of scheduledjobs scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| id | query | No | any | — |
| search | query | No | any | — |
| scopeType | query | No | any | — |
| isEnabled | query | Yes | any | — |
| sourceType | query | No | any | — |
| sourceModule | query | No | any | — |
| sort | query | No | any | — |
| order | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"description": null,
"scopeType": "system",
"organizationId": null,
"tenantId": null,
"scheduleType": "cron",
"scheduleValue": "string",
"timezone": "string",
"targetType": "queue",
"targetQueue": null,
"targetCommand": null,
"targetPayload": null,
"requireFeature": null,
"isEnabled": true,
"lastRunAt": null,
"nextRunAt": null,
"sourceType": "user",
"sourceModule": null,
"createdAt": "string",
"updatedAt": "string"
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/scheduler/jobs?page=1&pageSize=20" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/scheduler/jobsCreates a new scheduled job with cron or interval-based scheduling.
{
"name": "string",
"description": null,
"scopeType": "system",
"organizationId": null,
"tenantId": null,
"scheduleType": "cron",
"scheduleValue": "string",
"timezone": "UTC",
"targetType": "queue",
"targetQueue": null,
"targetCommand": null,
"targetPayload": null,
"requireFeature": null,
"isEnabled": true
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/scheduler/jobs" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"name\": \"string\",
\"description\": null,
\"scopeType\": \"system\",
\"organizationId\": null,
\"tenantId\": null,
\"scheduleType\": \"cron\",
\"scheduleValue\": \"string\",
\"timezone\": \"UTC\",
\"targetType\": \"queue\",
\"targetQueue\": null,
\"targetCommand\": null,
\"targetPayload\": null,
\"requireFeature\": null,
\"isEnabled\": true
}"/scheduler/jobsUpdates an existing scheduled job by ID.
{
"id": "string",
"description": null,
"targetQueue": null,
"targetCommand": null,
"targetPayload": null,
"requireFeature": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/scheduler/jobs" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"string\",
\"description\": null,
\"targetQueue\": null,
\"targetCommand\": null,
\"targetPayload\": null,
\"requireFeature\": null
}"/scheduler/jobsDeletes a scheduled job by ID.
{
"id": "string"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/scheduler/jobs" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"string\"
}"/scheduler/jobs/{id}/executionsFetch recent executions from BullMQ for a scheduled job. Requires QUEUE_STRATEGY=async.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| pageSize | query | No | any | — |
{
"items": [
{
"id": "string",
"scheduleId": "00000000-0000-4000-8000-000000000000",
"startedAt": "string",
"finishedAt": null,
"status": "running",
"triggerType": "scheduled",
"triggeredByUserId": null,
"errorMessage": null,
"errorStack": null,
"durationMs": null,
"queueJobId": "string",
"queueName": "string",
"attemptsMade": 1,
"result": null
}
],
"total": 1,
"page": 1,
"pageSize": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/scheduler/jobs/:id/executions?pageSize=20" \ -H "Accept: application/json"
/scheduler/queue-jobs/{jobId}Fetch detailed information and logs for a queue job. Requires QUEUE_STRATEGY=async.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| jobId | path | Yes | any | — |
| queue | query | Yes | any | — |
{
"id": "string",
"name": "string",
"state": "waiting",
"progress": null,
"returnvalue": null,
"failedReason": null,
"stacktrace": null,
"attemptsMade": 1,
"processedOn": null,
"finishedOn": null,
"logs": [
"string"
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/scheduler/queue-jobs/:jobId?queue=string" \ -H "Accept: application/json"
/scheduler/targetsReturns available queue names and scheduler-safe command IDs for schedule target selection.
{
"queues": [
{
"value": "string",
"label": "string"
}
],
"commands": [
{
"value": "string",
"label": "string"
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/scheduler/targets" \ -H "Accept: application/json"
/scheduler/triggerExecutes a scheduled job immediately, bypassing the scheduled time. Only works with async queue strategy. The attempt is audited against the calling user whether it succeeds, is refused, or fails, except when a before command interceptor blocks it before the command runs.
{
"id": "string"
}{
"ok": true,
"jobId": "string",
"message": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/scheduler/trigger" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"string\"
}"/checkout/links"string"
curl -X GET "https://om.opperescala.com/api/checkout/links" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/checkout/links"string"
curl -X POST "https://om.opperescala.com/api/checkout/links" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/checkout/links/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/checkout/links/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/checkout/links/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X PUT "https://om.opperescala.com/api/checkout/links/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/checkout/links/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
No response body.
curl -X DELETE "https://om.opperescala.com/api/checkout/links/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/checkout/pay/{slug}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| slug | path | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/checkout/pay/:slug" \ -H "Accept: application/json"
/checkout/pay/{slug}/status/{transactionId}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| slug | path | Yes | any | — |
| transactionId | path | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/checkout/pay/:slug/status/:transactionId" \ -H "Accept: application/json"
/checkout/pay/{slug}/submit| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| slug | path | Yes | any | — |
"string"
{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/checkout/pay/:slug/submit" \ -H "Accept: application/json"
/checkout/pay/{slug}/verify-password| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| slug | path | Yes | any | — |
"string"
{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/checkout/pay/:slug/verify-password" \ -H "Accept: application/json"
/checkout/templates"string"
curl -X GET "https://om.opperescala.com/api/checkout/templates" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/checkout/templates"string"
curl -X POST "https://om.opperescala.com/api/checkout/templates" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/checkout/templates/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/checkout/templates/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/checkout/templates/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X PUT "https://om.opperescala.com/api/checkout/templates/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/checkout/templates/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
No response body.
curl -X DELETE "https://om.opperescala.com/api/checkout/templates/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/checkout/templates/{id}/preview| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/checkout/templates/:id/preview" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/checkout/transactions"string"
curl -X GET "https://om.opperescala.com/api/checkout/transactions" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/checkout/transactions/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/checkout/transactions/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/checkout/transactions/by-gateway/{gatewayTransactionId}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| gatewayTransactionId | path | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/checkout/transactions/by-gateway/:gatewayTransactionId" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/documents| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| id | query | No | any | — |
| archived | query | No | any | — |
| favorite | query | Yes | any | — |
| folderId | query | No | any | — |
| entityType | query | No | any | — |
| entityId | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"title": "string",
"folderId": null,
"ownerUserId": "00000000-0000-4000-8000-000000000000",
"ownerLabel": null,
"createdByUserId": "00000000-0000-4000-8000-000000000000",
"isActive": true,
"archivedAt": null,
"isFavorite": true,
"sharedWithCount": 1,
"createdAt": "string",
"updatedAt": "string",
"relationshipTier": null,
"capabilities": {
"canView": true,
"canComment": true,
"canEdit": true,
"canShare": true,
"canDelete": true,
"canCreate": true,
"canManageTemplates": true,
"canArchive": true,
"canDuplicate": true
}
}
],
"collectionCapabilities": {
"canCreateDocument": true,
"canCreateFolder": true,
"canLinkDocuments": true,
"canInstantiateTemplate": true,
"canManageTemplates": true
},
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/documents?page=1&pageSize=50&archived=exclude" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/documents{
"title": "string",
"folderId": null
}{
"id": "00000000-0000-4000-8000-000000000000",
"updatedAt": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/documents" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"title\": \"string\",
\"folderId\": null
}"/documents/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"title": "string",
"folderId": null,
"ownerUserId": "00000000-0000-4000-8000-000000000000",
"createdByUserId": "00000000-0000-4000-8000-000000000000",
"isActive": true,
"archivedAt": null,
"isFavorite": true,
"isWatching": true,
"createdAt": "string",
"updatedAt": "string",
"tier": "owner",
"canShare": true,
"capabilities": {
"canView": true,
"canComment": true,
"canEdit": true,
"canShare": true,
"canDelete": true,
"canCreate": true,
"canManageTemplates": true,
"canArchive": true,
"canDuplicate": true
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/documents/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"folderId": null
}{
"id": "00000000-0000-4000-8000-000000000000",
"updatedAt": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"folderId\": null
}"/documents/{id}Transactionally releases every document-owned attachment row and its quota usage, soft-deletes the document record, then runs reference-checked provider cleanup after commit. Because attachment bytes cannot be restored, this operation is intentionally not undoable.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"id": "00000000-0000-4000-8000-000000000000",
"updatedAt": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/documents/{id}/archive| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"archivedAt": null,
"updatedAt": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/archive" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/documents/{id}/attachments| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
file=string
{
"id": "00000000-0000-4000-8000-000000000000",
"attachmentId": "00000000-0000-4000-8000-000000000000",
"updatedAt": "string",
"url": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/attachments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: multipart/form-data" \
-d "{
\"file\": \"string\"
}"/documents/{id}/attachments/{attachmentId}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| attachmentId | path | Yes | any | — |
"string"
{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/attachments/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/documents/{id}/attachments/{attachmentId}Transactionally removes the document attachment row and quota usage, then runs reference-checked provider cleanup after commit. This operation is audited and intentionally not undoable.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| attachmentId | path | Yes | any | — |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/attachments/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/documents/{id}/collab-token| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"token": "string",
"url": null,
"documentId": "string",
"tier": "owner",
"expiresInSec": 1,
"expiresAt": "string",
"userName": "string",
"userColor": "string",
"canEdit": true,
"readOnly": true,
"user": {
"id": "string",
"name": "string",
"color": "string"
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/collab-token" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/documents/{id}/comments| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| page | query | No | any | — |
| pageSize | query | Yes | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"documentId": "00000000-0000-4000-8000-000000000000",
"parentCommentId": null,
"authorUserId": "00000000-0000-4000-8000-000000000000",
"body": "string",
"anchor": null,
"mentions": [
{
"userId": "00000000-0000-4000-8000-000000000000"
}
],
"resolvedAt": null,
"resolvedByUserId": null,
"createdAt": "string",
"updatedAt": "string",
"canResolve": true,
"replies": []
}
],
"userLabels": {
"key": {
"label": "string"
}
},
"page": 1,
"pageSize": 1,
"total": 1,
"totalPages": 1,
"totalComments": 1,
"truncated": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/comments?page=1" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/documents/{id}/commentsMentions may be sent out-of-band as mentions: [{ userId }]. Legacy bracketed @[user-uuid] tokens in the comment body are still honored.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"body": "string",
"anchor": null,
"parentCommentId": null
}{
"id": "00000000-0000-4000-8000-000000000000",
"updatedAt": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/comments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"body\": \"string\",
\"anchor\": null,
\"parentCommentId\": null
}"/documents/{id}/comments| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"resolved": true
}{
"id": "00000000-0000-4000-8000-000000000000",
"resolvedAt": null,
"resolvedByUserId": null,
"updatedAt": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PATCH "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/comments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"resolved\": true
}"/documents/{id}/comments/access-check| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"userIds": [
"00000000-0000-4000-8000-000000000000"
]
}{
"withoutAccess": [
"00000000-0000-4000-8000-000000000000"
],
"withoutAccessUsers": [
{
"userId": "00000000-0000-4000-8000-000000000000",
"label": null,
"secondary": null
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/comments/access-check" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"userIds\": [
\"00000000-0000-4000-8000-000000000000\"
]
}"/documents/{id}/content| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"contentHtml": "string",
"contentText": "string",
"updatedAt": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/content" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/documents/{id}/content| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"contentHtml": "string",
"contentText": null
}{
"ok": true,
"updatedAt": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/content" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"contentHtml\": \"string\",
\"contentText\": null
}"/documents/{id}/duplicate| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{}{
"id": "00000000-0000-4000-8000-000000000000",
"updatedAt": "string",
"copiedAttachments": 1,
"copiedLinks": 1,
"droppedLinks": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/duplicate" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/documents/{id}/exportReturns a binary .docx or PDF file attachment for a document.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| format | query | No | any | — |
string
{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/export" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/documents/{id}/exportReturns a DOCX attachment using the editor pagination snapshot supplied by the client.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| format | query | No | any | — |
{
"contentHtml": "string",
"pageBreakMarker": "string"
}string
{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/export" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"contentHtml\": \"string\",
\"pageBreakMarker\": \"string\"
}"/documents/{id}/favorite| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"active": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/documents/00000000-0000-4000-8000-000000000000/favorite" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sync_akeneo/custom-fields"string"
curl -X GET "https://om.opperescala.com/api/sync_akeneo/custom-fields" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sync_akeneo/custom-fields"string"
curl -X POST "https://om.opperescala.com/api/sync_akeneo/custom-fields" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sync_akeneo/delete-products"string"
curl -X POST "https://om.opperescala.com/api/sync_akeneo/delete-products" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sync_akeneo/discovery"string"
curl -X GET "https://om.opperescala.com/api/sync_akeneo/discovery" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sync_akeneo/first-import"string"
curl -X GET "https://om.opperescala.com/api/sync_akeneo/first-import" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sync_akeneo/first-import"string"
curl -X POST "https://om.opperescala.com/api/sync_akeneo/first-import" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/tillio/operators"string"
curl -X GET "https://om.opperescala.com/api/tillio/operators" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/tillio/operators"string"
curl -X POST "https://om.opperescala.com/api/tillio/operators" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/tillio/operators/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
No response body.
curl -X DELETE "https://om.opperescala.com/api/tillio/operators/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/tillio/pull"string"
curl -X GET "https://om.opperescala.com/api/tillio/pull" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/tillio/pull"string"
curl -X POST "https://om.opperescala.com/api/tillio/pull" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/webhooksReturns paginated webhooks for the current tenant and organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| isActive | query | No | any | — |
{
"items": [
{
"id": "string",
"name": "string",
"description": null,
"url": "string",
"subscribedEvents": [
"string"
],
"httpMethod": "string",
"isActive": true,
"deliveryStrategy": "string",
"maxRetries": 1,
"consecutiveFailures": 1,
"lastSuccessAt": null,
"lastFailureAt": null,
"createdAt": "string",
"updatedAt": "string"
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/webhooks" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/webhooksCreates a new webhook endpoint. A signing secret (whsec_ prefixed) is auto-generated and returned once.
{
"name": "string",
"description": null,
"url": "https://example.com/resource",
"subscribedEvents": [
"string"
],
"httpMethod": "POST",
"customHeaders": null,
"deliveryStrategy": "http",
"strategyConfig": null,
"maxRetries": 10,
"timeoutMs": 15000,
"rateLimitPerMinute": 0,
"autoDisableThreshold": 100,
"integrationId": null
}{
"id": "string",
"name": "string",
"url": "string",
"secret": "string",
"subscribedEvents": [
"string"
],
"isActive": true
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/webhooks" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"name\": \"string\",
\"description\": null,
\"url\": \"https://example.com/resource\",
\"subscribedEvents\": [
\"string\"
],
\"httpMethod\": \"POST\",
\"customHeaders\": null,
\"deliveryStrategy\": \"http\",
\"strategyConfig\": null,
\"maxRetries\": 10,
\"timeoutMs\": 15000,
\"rateLimitPerMinute\": 0,
\"autoDisableThreshold\": 100,
\"integrationId\": null
}"/webhooks/{id}Returns webhook configuration, masked secret metadata, and delivery settings.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "string",
"name": "string",
"description": null,
"url": "string",
"subscribedEvents": [
"string"
],
"httpMethod": "string",
"isActive": true,
"deliveryStrategy": "string",
"maxRetries": 1,
"consecutiveFailures": 1,
"lastSuccessAt": null,
"lastFailureAt": null,
"createdAt": "string",
"updatedAt": "string",
"customHeaders": null,
"strategyConfig": null,
"timeoutMs": 1,
"rateLimitPerMinute": 1,
"autoDisableThreshold": 1,
"integrationId": null,
"maskedSecret": "string",
"previousSecretSetAt": null
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/webhooks/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/webhooks/{id}Updates a single webhook configuration.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"description": null,
"httpMethod": "POST",
"customHeaders": null,
"deliveryStrategy": "http",
"strategyConfig": null,
"maxRetries": 10,
"timeoutMs": 15000,
"rateLimitPerMinute": 0,
"autoDisableThreshold": 100,
"integrationId": null
}{
"id": "string",
"name": "string",
"description": null,
"url": "string",
"subscribedEvents": [
"string"
],
"httpMethod": "string",
"isActive": true,
"deliveryStrategy": "string",
"maxRetries": 1,
"consecutiveFailures": 1,
"lastSuccessAt": null,
"lastFailureAt": null,
"createdAt": "string",
"updatedAt": "string",
"customHeaders": null,
"strategyConfig": null,
"timeoutMs": 1,
"rateLimitPerMinute": 1,
"autoDisableThreshold": 1,
"integrationId": null,
"maskedSecret": "string",
"previousSecretSetAt": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/webhooks/00000000-0000-4000-8000-000000000000" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"description\": null,
\"httpMethod\": \"POST\",
\"customHeaders\": null,
\"deliveryStrategy\": \"http\",
\"strategyConfig\": null,
\"maxRetries\": 10,
\"timeoutMs\": 15000,
\"rateLimitPerMinute\": 0,
\"autoDisableThreshold\": 100,
\"integrationId\": null
}"/webhooks/{id}Soft-deletes a webhook endpoint.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"success": true
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/webhooks/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/webhooks/{id}/rotate-secretReturns the new secret once. Store it immediately; future reads only expose a masked value.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"success": true,
"secret": "string",
"previousSecretSetAt": null
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/webhooks/00000000-0000-4000-8000-000000000000/rotate-secret" \ -H "Accept: application/json"
/webhooks/{id}/testCreates a synthetic event payload and delivers it immediately without using the queue.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{}{
"success": true,
"delivery": {
"id": "string",
"webhookId": "string",
"eventType": "string",
"messageId": "string",
"status": "string",
"responseStatus": null,
"errorMessage": null,
"attemptNumber": 1,
"maxAttempts": 1,
"targetUrl": "string",
"durationMs": null,
"enqueuedAt": "string",
"lastAttemptAt": null,
"deliveredAt": null,
"createdAt": "string",
"payload": {},
"responseBody": null,
"responseHeaders": null,
"nextRetryAt": null,
"updatedAt": "string"
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/webhooks/00000000-0000-4000-8000-000000000000/test" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{}"/webhooks/deliveriesReturns paginated webhook delivery attempts with filtering by webhook, event type, and status.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| webhookId | query | No | any | — |
| eventType | query | No | any | — |
| status | query | No | any | — |
{
"items": [
{
"id": "string",
"webhookId": "string",
"webhookName": null,
"eventType": "string",
"messageId": "string",
"status": "string",
"responseStatus": null,
"errorMessage": null,
"attemptNumber": 1,
"maxAttempts": 1,
"targetUrl": "string",
"durationMs": null,
"enqueuedAt": "string",
"lastAttemptAt": null,
"deliveredAt": null,
"createdAt": "string"
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/webhooks/deliveries?page=1&pageSize=50" \ -H "Accept: application/json"
/webhooks/deliveries/{id}Returns a single delivery attempt by ID.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "string",
"webhookId": "string",
"eventType": "string",
"messageId": "string",
"status": "string",
"responseStatus": null,
"errorMessage": null,
"attemptNumber": 1,
"maxAttempts": 1,
"targetUrl": "string",
"durationMs": null,
"enqueuedAt": "string",
"lastAttemptAt": null,
"deliveredAt": null,
"createdAt": "string",
"payload": {},
"responseBody": null,
"responseHeaders": null,
"nextRetryAt": null,
"updatedAt": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/webhooks/deliveries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/webhooks/deliveries/{id}/retryResets retry scheduling fields and enqueues the delivery again.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"success": true,
"delivery": {
"id": "string",
"webhookId": "string",
"eventType": "string",
"messageId": "string",
"status": "string",
"responseStatus": null,
"errorMessage": null,
"attemptNumber": 1,
"maxAttempts": 1,
"targetUrl": "string",
"durationMs": null,
"enqueuedAt": "string",
"lastAttemptAt": null,
"deliveredAt": null,
"createdAt": "string",
"payload": {},
"responseBody": null,
"responseHeaders": null,
"nextRetryAt": null,
"updatedAt": "string"
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/webhooks/deliveries/00000000-0000-4000-8000-000000000000/retry" \ -H "Accept: application/json"
/webhooks/eventsReturns all declared non-webhook events, sorted by event id.
{
"data": [
{
"id": "string",
"label": "string"
}
],
"total": 1
}curl -X GET "https://om.opperescala.com/api/webhooks/events" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/webhooks/inbound/{endpointId}The endpoint id resolves to a registered webhook source first (module-level handler dispatch), otherwise to a legacy adapter provider key.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| endpointId | path | Yes | any | — |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/webhooks/inbound/string" \ -H "Accept: application/json"
/webhooks/webhook-deliveriesReturns paginated webhook delivery attempts with filtering by webhook, event type, and status.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| webhookId | query | No | any | — |
| eventType | query | No | any | — |
| status | query | No | any | — |
{
"items": [
{
"id": "string",
"webhookId": "string",
"webhookName": null,
"eventType": "string",
"messageId": "string",
"status": "string",
"responseStatus": null,
"errorMessage": null,
"attemptNumber": 1,
"maxAttempts": 1,
"targetUrl": "string",
"durationMs": null,
"enqueuedAt": "string",
"lastAttemptAt": null,
"deliveredAt": null,
"createdAt": "string"
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/webhooks/webhook-deliveries?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/webhooks/webhook-deliveries/{id}Returns a single delivery attempt by ID.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "string",
"webhookId": "string",
"eventType": "string",
"messageId": "string",
"status": "string",
"responseStatus": null,
"errorMessage": null,
"attemptNumber": 1,
"maxAttempts": 1,
"targetUrl": "string",
"durationMs": null,
"enqueuedAt": "string",
"lastAttemptAt": null,
"deliveredAt": null,
"createdAt": "string",
"payload": {},
"responseBody": null,
"responseHeaders": null,
"nextRetryAt": null,
"updatedAt": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/webhooks/webhook-deliveries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/webhooks/webhook-deliveries/{id}/retryResets retry scheduling fields and enqueues the delivery again.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"success": true,
"delivery": {
"id": "string",
"webhookId": "string",
"eventType": "string",
"messageId": "string",
"status": "string",
"responseStatus": null,
"errorMessage": null,
"attemptNumber": 1,
"maxAttempts": 1,
"targetUrl": "string",
"durationMs": null,
"enqueuedAt": "string",
"lastAttemptAt": null,
"deliveredAt": null,
"createdAt": "string",
"payload": {},
"responseBody": null,
"responseHeaders": null,
"nextRetryAt": null,
"updatedAt": "string"
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/webhooks/webhook-deliveries/00000000-0000-4000-8000-000000000000/retry" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/webhooks/webhooksReturns paginated webhooks for the current tenant and organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| isActive | query | No | any | — |
{
"items": [
{
"id": "string",
"name": "string",
"description": null,
"url": "string",
"subscribedEvents": [
"string"
],
"httpMethod": "string",
"isActive": true,
"deliveryStrategy": "string",
"maxRetries": 1,
"consecutiveFailures": 1,
"lastSuccessAt": null,
"lastFailureAt": null,
"createdAt": "string",
"updatedAt": "string"
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/webhooks/webhooks" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/webhooks/webhooksCreates a new webhook endpoint. A signing secret (whsec_ prefixed) is auto-generated and returned once.
{
"name": "string",
"description": null,
"url": "https://example.com/resource",
"subscribedEvents": [
"string"
],
"httpMethod": "POST",
"customHeaders": null,
"deliveryStrategy": "http",
"strategyConfig": null,
"maxRetries": 10,
"timeoutMs": 15000,
"rateLimitPerMinute": 0,
"autoDisableThreshold": 100,
"integrationId": null
}{
"id": "string",
"name": "string",
"url": "string",
"secret": "string",
"subscribedEvents": [
"string"
],
"isActive": true
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/webhooks/webhooks" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"name\": \"string\",
\"description\": null,
\"url\": \"https://example.com/resource\",
\"subscribedEvents\": [
\"string\"
],
\"httpMethod\": \"POST\",
\"customHeaders\": null,
\"deliveryStrategy\": \"http\",
\"strategyConfig\": null,
\"maxRetries\": 10,
\"timeoutMs\": 15000,
\"rateLimitPerMinute\": 0,
\"autoDisableThreshold\": 100,
\"integrationId\": null
}"/webhooks/webhooksUpdates an existing webhook configuration.
{
"description": null,
"httpMethod": "POST",
"customHeaders": null,
"deliveryStrategy": "http",
"strategyConfig": null,
"maxRetries": 10,
"timeoutMs": 15000,
"rateLimitPerMinute": 0,
"autoDisableThreshold": 100,
"integrationId": null
}{
"id": "string",
"name": "string",
"description": null,
"url": "string",
"subscribedEvents": [
"string"
],
"httpMethod": "string",
"isActive": true,
"deliveryStrategy": "string",
"maxRetries": 1,
"consecutiveFailures": 1,
"lastSuccessAt": null,
"lastFailureAt": null,
"createdAt": "string",
"updatedAt": "string",
"customHeaders": null,
"strategyConfig": null,
"timeoutMs": 1,
"rateLimitPerMinute": 1,
"autoDisableThreshold": 1,
"integrationId": null
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/webhooks/webhooks" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"description\": null,
\"httpMethod\": \"POST\",
\"customHeaders\": null,
\"deliveryStrategy\": \"http\",
\"strategyConfig\": null,
\"maxRetries\": 10,
\"timeoutMs\": 15000,
\"rateLimitPerMinute\": 0,
\"autoDisableThreshold\": 100,
\"integrationId\": null
}"/webhooks/webhooksSoft-deletes a webhook endpoint.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | Yes | any | Webhook ID to delete |
{
"success": true
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/webhooks/webhooks?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/webhooks/webhooks/{id}Returns webhook configuration, masked secret metadata, and delivery settings.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "string",
"name": "string",
"description": null,
"url": "string",
"subscribedEvents": [
"string"
],
"httpMethod": "string",
"isActive": true,
"deliveryStrategy": "string",
"maxRetries": 1,
"consecutiveFailures": 1,
"lastSuccessAt": null,
"lastFailureAt": null,
"createdAt": "string",
"updatedAt": "string",
"customHeaders": null,
"strategyConfig": null,
"timeoutMs": 1,
"rateLimitPerMinute": 1,
"autoDisableThreshold": 1,
"integrationId": null,
"maskedSecret": "string",
"previousSecretSetAt": null
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/webhooks/webhooks/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/telemetry/browser-traces"string"
curl -X POST "https://om.opperescala.com/api/telemetry/browser-traces" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customer_accounts/portal/events/streamLong-lived SSE connection that receives server-side events marked with portalBroadcast: true. Events are filtered by the customer's tenant, organization, and recipient user audience.
"string"
"string"
curl -X GET "https://om.opperescala.com/api/customer_accounts/portal/events/stream" \ -H "Accept: application/json"
/customer_accounts/portal/feature-checkChecks which of the requested features the authenticated customer user has. Used by portal menu injection for feature-gating.
{
"features": [
"string"
]
}{
"ok": true,
"granted": [
"string"
]
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/portal/feature-check" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"features\": [
\"string\"
]
}"/customer_accounts/portal/logoutRevokes the current session and clears authentication cookies.
{
"ok": true
}curl -X POST "https://om.opperescala.com/api/customer_accounts/portal/logout" \ -H "Accept: application/json"
/customer_accounts/portal/navReturns the portal sidebar for the authenticated customer. Items are derived from each portal page's `nav` metadata and filtered by `requireCustomerFeatures` against concrete effective features.
{
"ok": true,
"orgSlug": "string",
"groups": [
{
"id": "main",
"items": [
{
"id": "string",
"label": "string",
"href": "string",
"order": 1
}
]
}
],
"grantedFeatures": [
"string"
],
"isPortalAdmin": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/portal/nav" \ -H "Accept: application/json"
/customer_accounts/portal/notificationsReturns paginated notifications for the authenticated customer user. Dismissed notifications are excluded by default unless ?status=dismissed is specified.
{
"ok": true,
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"type": "string",
"title": "string",
"body": null,
"titleKey": null,
"bodyKey": null,
"titleVariables": null,
"bodyVariables": null,
"icon": null,
"severity": "info",
"status": "unread",
"actions": [
{
"id": "string",
"label": "string"
}
],
"sourceModule": null,
"sourceEntityType": null,
"sourceEntityId": null,
"linkHref": null,
"createdAt": "string",
"readAt": null,
"actionTaken": null
}
],
"total": 1,
"page": 1,
"pageSize": 1
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/portal/notifications" \ -H "Accept: application/json"
/customer_accounts/portal/notifications/{id}/dismissDismisses a single notification for the authenticated customer user.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/customer_accounts/portal/notifications/00000000-0000-4000-8000-000000000000/dismiss" \ -H "Accept: application/json"
/customer_accounts/portal/notifications/{id}/readMarks a single notification as read for the authenticated customer user.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/customer_accounts/portal/notifications/00000000-0000-4000-8000-000000000000/read" \ -H "Accept: application/json"
/customer_accounts/portal/notifications/mark-all-readMarks all unread notifications as read for the authenticated customer user.
{
"ok": true,
"count": 1
}{
"ok": false,
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/customer_accounts/portal/notifications/mark-all-read" \ -H "Accept: application/json"
/customer_accounts/portal/notifications/unread-countReturns the number of unread notifications for the authenticated customer user.
{
"ok": true,
"unreadCount": 1
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/portal/notifications/unread-count" \ -H "Accept: application/json"
/customer_accounts/portal/password-changeChanges the authenticated customer user password after verifying the current password. Revokes all existing sessions.
{
"currentPassword": "string",
"newPassword": "string"
}{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/portal/password-change" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"currentPassword\": \"string\",
\"newPassword\": \"string\"
}"/customer_accounts/portal/profileReturns the authenticated customer user profile with roles and permissions.
{
"ok": true,
"user": {
"id": "00000000-0000-4000-8000-000000000000",
"email": "string",
"displayName": "string",
"emailVerified": true,
"customerEntityId": null,
"personEntityId": null,
"isActive": true,
"lastLoginAt": null,
"createdAt": "string"
},
"roles": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"slug": "string"
}
],
"resolvedFeatures": [
"string"
],
"isPortalAdmin": true
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/portal/profile" \ -H "Accept: application/json"
/customer_accounts/portal/profileUpdates the authenticated customer user profile.
{}{
"ok": true,
"user": {
"id": "00000000-0000-4000-8000-000000000000",
"email": "string",
"displayName": "string"
}
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/customer_accounts/portal/profile" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{}"/customer_accounts/portal/sessionsReturns active sessions for the authenticated customer user.
{
"ok": true,
"sessions": [
{
"id": "00000000-0000-4000-8000-000000000000",
"ipAddress": null,
"userAgent": null,
"lastUsedAt": null,
"createdAt": "string",
"expiresAt": "string",
"isCurrent": true
}
]
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/portal/sessions" \ -H "Accept: application/json"
/customer_accounts/portal/sessions-refreshUses the session cookie to issue a fresh JWT access token.
{
"ok": true,
"resolvedFeatures": [
"string"
]
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/portal/sessions-refresh" \ -H "Accept: application/json"
/customer_accounts/portal/sessions/{id}Revokes a specific session (not the current one).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/customer_accounts/portal/sessions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/customer_accounts/portal/usersLists portal users associated with the same company. Paginated (default pageSize 25, max 100).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
{
"ok": true,
"users": [
{
"id": "00000000-0000-4000-8000-000000000000",
"email": "string",
"displayName": "string",
"emailVerified": true,
"isActive": true,
"lastLoginAt": null,
"createdAt": "string",
"roles": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"slug": "string"
}
]
}
],
"total": 1,
"totalPages": 1,
"page": 1,
"pageSize": 1
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/portal/users" \ -H "Accept: application/json"
/customer_accounts/portal/users-inviteCreates an invitation for a new user to join the company portal.
{
"email": "user@example.com",
"roleIds": [
"00000000-0000-4000-8000-000000000000"
]
}{
"ok": true,
"invitation": {
"id": "00000000-0000-4000-8000-000000000000",
"email": "string",
"expiresAt": "string"
}
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/portal/users-invite" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"email\": \"user@example.com\",
\"roleIds\": [
\"00000000-0000-4000-8000-000000000000\"
]
}"/customer_accounts/portal/users/{id}Soft deletes a portal user and revokes all their sessions.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/customer_accounts/portal/users/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/customer_accounts/portal/users/{id}/rolesAssigns new roles to a company portal user.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"roleIds": [
"00000000-0000-4000-8000-000000000000"
]
}{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/customer_accounts/portal/users/00000000-0000-4000-8000-000000000000/roles" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"roleIds\": [
\"00000000-0000-4000-8000-000000000000\"
]
}"/formsReturns paginated forms scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| status | query | No | any | — |
| q | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"key": "string",
"name": "string",
"description": null,
"status": "draft",
"defaultLocale": "string",
"supportedLocales": [
"string"
],
"currentPublishedVersionId": null,
"currentPublishedVersionNumber": null,
"draftVersionId": null,
"createdAt": "string",
"updatedAt": "string"
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/formsCreates a new form. Status starts as draft until a version is published.
{
"key": "string",
"name": "string",
"description": null,
"defaultLocale": "string",
"supportedLocales": [
"string"
],
"retentionDays": null
}{
"id": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"key\": \"string\",
\"name\": \"string\",
\"description\": null,
\"defaultLocale\": \"string\",
\"supportedLocales\": [
\"string\"
],
\"retentionDays\": null
}"/forms/{id}Returns the form metadata + version summaries.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"key": "string",
"name": "string",
"description": null,
"status": "draft",
"defaultLocale": "string",
"supportedLocales": [
"string"
],
"currentPublishedVersionId": null,
"createdAt": "string",
"updatedAt": "string",
"versions": [
{
"id": "00000000-0000-4000-8000-000000000000",
"versionNumber": 1,
"status": "draft",
"schemaHash": "string",
"registryVersion": "string",
"publishedAt": null,
"publishedBy": null,
"changelog": null,
"archivedAt": null,
"createdAt": "string",
"updatedAt": "string"
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/{id}Updates the form name, description, and/or locale set (supportedLocales + defaultLocale).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"description": null,
"retentionDays": null
}{
"ok": true,
"updatedAt": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PATCH "https://om.opperescala.com/api/forms/00000000-0000-4000-8000-000000000000" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"description\": null,
\"retentionDays\": null
}"/forms/{id}Soft-archives the form (sets archived_at, status=archived).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"updatedAt": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/forms/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/{id}/distributionsReturns all distributions for a form scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"formId": "00000000-0000-4000-8000-000000000000",
"mode": "open",
"status": "active",
"publicSlug": null,
"title": null,
"defaultLocale": "string",
"pinnedVersionId": null,
"requireCustomerAuth": true,
"allowMultipleSubmissions": true,
"maxResponses": null,
"responseCount": 1,
"opensAt": null,
"closesAt": null,
"redirectUrl": null,
"createdAt": "string",
"updatedAt": "string"
}
],
"total": 1
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/00000000-0000-4000-8000-000000000000/distributions" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/{id}/distributionsCreates an open (public link) or personal (per-recipient invitations) distribution. Open distributions mint a public_slug.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"mode": "open",
"pinnedVersionId": null,
"title": null,
"defaultLocale": "string",
"maxResponses": null,
"opensAt": null,
"closesAt": null,
"redirectUrl": null,
"settings": null
}{
"id": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/00000000-0000-4000-8000-000000000000/distributions" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"mode\": \"open\",
\"pinnedVersionId\": null,
\"title\": null,
\"defaultLocale\": \"string\",
\"maxResponses\": null,
\"opensAt\": null,
\"closesAt\": null,
\"redirectUrl\": null,
\"settings\": null
}"/forms/{id}/versions/{versionId}Returns the full schema/uiSchema/roles for a form version.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| versionId | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"formId": "00000000-0000-4000-8000-000000000000",
"versionNumber": 1,
"status": "draft",
"schema": {},
"uiSchema": {},
"roles": [
"string"
],
"schemaHash": "string",
"registryVersion": "string",
"publishedAt": null,
"publishedBy": null,
"changelog": null,
"archivedAt": null,
"createdAt": "string",
"updatedAt": "string",
"answerMappings": {
"key": "string"
}
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/00000000-0000-4000-8000-000000000000/versions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/{id}/versions/{versionId}Updates schema/uiSchema/roles/changelog on a draft version. Rejects with 409 (version_is_frozen) for non-draft versions.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| versionId | path | Yes | any | — |
{
"changelog": null
}{
"ok": true,
"updatedAt": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PATCH "https://om.opperescala.com/api/forms/00000000-0000-4000-8000-000000000000/versions/00000000-0000-4000-8000-000000000000" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"changelog\": null
}"/forms/{id}/versions/{versionId}/diffReturns added/removed/modified fields between the URL `versionId` (newer) and the `against` query param (older).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| versionId | path | Yes | any | — |
| against | query | Yes | any | — |
{
"base": {
"id": "00000000-0000-4000-8000-000000000000",
"versionNumber": 1,
"schemaHash": "string"
},
"against": {
"id": "00000000-0000-4000-8000-000000000000",
"versionNumber": 1,
"schemaHash": "string"
},
"diff": [
{
"kind": "added",
"key": "string",
"field": {
"key": "string",
"type": "string",
"sectionKey": null,
"sensitive": true,
"editableBy": [
"string"
],
"visibleTo": [
"string"
],
"required": true
}
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/00000000-0000-4000-8000-000000000000/versions/00000000-0000-4000-8000-000000000000/diff?against=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/{id}/versions/{versionId}/publishPublishes a draft version. Emits forms.form_version.published, advances form.current_published_version_id, and pins registry_version. Rejects with 422 no_op_publish if schema is unchanged.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| versionId | path | Yes | any | — |
{
"changelog": null
}{
"versionId": "00000000-0000-4000-8000-000000000000",
"versionNumber": 1,
"updatedAt": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/00000000-0000-4000-8000-000000000000/versions/00000000-0000-4000-8000-000000000000/publish" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"changelog\": null
}"/forms/{id}/versions/forkCreates a new draft version. Optionally clones from `fromVersionId`. Rejects if a draft already exists (422 draft_already_exists).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"fromVersionId": null
}{
"versionId": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/00000000-0000-4000-8000-000000000000/versions/fork" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"fromVersionId\": null
}"/forms/distributions/{distributionId}Returns a single distribution scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| distributionId | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"formId": "00000000-0000-4000-8000-000000000000",
"mode": "open",
"status": "active",
"publicSlug": null,
"title": null,
"defaultLocale": "string",
"pinnedVersionId": null,
"requireCustomerAuth": true,
"allowMultipleSubmissions": true,
"maxResponses": null,
"responseCount": 1,
"opensAt": null,
"closesAt": null,
"redirectUrl": null,
"settings": null,
"createdAt": "string",
"updatedAt": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/distributions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/distributions/{distributionId}Updates mutable distribution fields. A body of { "status": "closed" } closes the distribution and emits forms.distribution.closed.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| distributionId | path | Yes | any | — |
{
"title": null,
"maxResponses": null,
"opensAt": null,
"closesAt": null,
"redirectUrl": null,
"settings": null
}{
"id": "00000000-0000-4000-8000-000000000000",
"updatedAt": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PATCH "https://om.opperescala.com/api/forms/distributions/00000000-0000-4000-8000-000000000000" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"title\": null,
\"maxResponses\": null,
\"opensAt\": null,
\"closesAt\": null,
\"redirectUrl\": null,
\"settings\": null
}"/forms/distributions/{distributionId}/invitationsReturns invitations for a distribution with recipient PII decrypted. Token hashes are never returned.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| distributionId | path | Yes | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"recipientEmail": null,
"recipientName": null,
"recipientRef": null,
"role": null,
"status": "pending",
"locale": null,
"sentAt": null,
"openedAt": null,
"startedAt": null,
"submittedAt": null,
"expiresAt": null,
"sendCount": 1,
"lastError": null,
"createdAt": "string"
}
],
"total": 1
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/distributions/00000000-0000-4000-8000-000000000000/invitations" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/distributions/{distributionId}/invitationsCreates one invitation per recipient. For personal distributions, the response returns each invitation rawToken exactly once so the admin can build the personal link.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| distributionId | path | Yes | any | — |
{
"recipients": [
{}
]
}{
"invitations": [
{
"id": "00000000-0000-4000-8000-000000000000",
"rawToken": null
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/distributions/00000000-0000-4000-8000-000000000000/invitations" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"recipients\": [
{}
]
}"/forms/distributions/{distributionId}/invitations/{invitationId}Soft-revokes an invitation — the row is retained and its status becomes revoked so a revoked token resolves to 410 (not 404).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| distributionId | path | Yes | any | — |
| invitationId | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/forms/distributions/00000000-0000-4000-8000-000000000000/invitations/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/distributions/{distributionId}/invitations/{invitationId}/sendMarks the invitation sent (sent_at, send_count += 1) and emits forms.invitation.sent so the email subscriber dispatches a reminder. Also the resend path.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| distributionId | path | Yes | any | — |
| invitationId | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/distributions/00000000-0000-4000-8000-000000000000/invitations/00000000-0000-4000-8000-000000000000/send" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/auth/users/consentsReturns all consent records for a given user, with integrity verification status.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| userId | query | Yes | any | — |
"string"
curl -X GET "https://om.opperescala.com/api/auth/users/consents?userId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/catalog/categoriesReturns a paginated collection of categories scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| view | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| status | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"slug": null,
"description": null,
"parentId": null,
"parentName": null,
"depth": 1,
"treePath": "string",
"pathLabel": "string",
"childCount": 1,
"descendantCount": 1,
"isActive": true,
"updatedAt": null,
"organizationId": null,
"tenantId": "00000000-0000-4000-8000-000000000000"
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/catalog/categories?view=manage&page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/catalog/categoriesCreates a new product category.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"name": "string",
"slug": null,
"parentId": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/catalog/categories" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"name\": \"string\",
\"slug\": null,
\"parentId\": null
}"/catalog/categoriesUpdates an existing category by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"slug": null,
"parentId": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/catalog/categories" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"slug\": null,
\"parentId\": null
}"/catalog/categoriesDeletes a category by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/catalog/categories" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/catalog/dictionaries/{key}Returns dictionary entries for a specific key (e.g., currency, unit).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| key | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"entries": [
{
"id": "00000000-0000-4000-8000-000000000000",
"value": "string",
"label": "string",
"color": null,
"icon": null
}
]
}curl -X GET "https://om.opperescala.com/api/catalog/dictionaries/:key" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/catalog/offersReturns a paginated collection of offers scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| productId | query | No | any | — |
| channelId | query | No | any | — |
| channelIds | query | No | any | — |
| id | query | No | any | — |
| search | query | No | any | — |
| isActive | query | No | any | — |
| withDeleted | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"productId": null,
"organizationId": null,
"tenantId": null,
"channelId": null,
"title": "string",
"description": null,
"defaultMediaId": null,
"defaultMediaUrl": null,
"metadata": null,
"isActive": null,
"createdAt": null,
"updatedAt": null,
"product": null,
"productChannelPrice": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/catalog/offers?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/catalog/offersCreates a new offer linking a product to a sales channel.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"channelId": "00000000-0000-4000-8000-000000000000",
"title": "string",
"defaultMediaId": null,
"defaultMediaUrl": null,
"productId": "00000000-0000-4000-8000-000000000000"
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/catalog/offers" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"channelId\": \"00000000-0000-4000-8000-000000000000\",
\"title\": \"string\",
\"defaultMediaId\": null,
\"defaultMediaUrl\": null,
\"productId\": \"00000000-0000-4000-8000-000000000000\"
}"/catalog/offersUpdates an existing offer by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"defaultMediaId": null,
"defaultMediaUrl": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/catalog/offers" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"defaultMediaId\": null,
\"defaultMediaUrl\": null
}"/catalog/offersDeletes an offer by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/catalog/offers" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/catalog/option-schemasReturns a paginated collection of option schemas scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| id | query | No | any | — |
| search | query | No | any | — |
| isActive | query | No | any | — |
| withDeleted | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"code": null,
"description": null,
"schema": null,
"metadata": null,
"is_active": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/catalog/option-schemas?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/catalog/option-schemasCreates a new option schema template for product configurations.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"name": "string",
"schema": {
"options": [
{
"code": "string",
"label": "string",
"inputType": "select"
}
]
}
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/catalog/option-schemas" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"name\": \"string\",
\"schema\": {
\"options\": [
{
\"code\": \"string\",
\"label\": \"string\",
\"inputType\": \"select\"
}
]
}
}"/catalog/option-schemasUpdates an existing option schema by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/catalog/option-schemas" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/catalog/option-schemasDeletes an option schema by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/catalog/option-schemas" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/catalog/price-kindsReturns a paginated collection of price kinds scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| isPromotion | query | No | any | — |
| isActive | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"organization_id": null,
"tenant_id": null,
"code": "string",
"title": "string",
"display_mode": null,
"currency_code": null,
"is_promotion": null,
"is_active": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/catalog/price-kinds?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/catalog/price-kindsCreates a new price kind for categorizing product prices.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"code": "string",
"title": "string",
"displayMode": "excluding-tax"
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/catalog/price-kinds" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"code\": \"string\",
\"title\": \"string\",
\"displayMode\": \"excluding-tax\"
}"/catalog/price-kindsUpdates an existing price kind by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"displayMode": "excluding-tax"
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/catalog/price-kinds" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"displayMode\": \"excluding-tax\"
}"/catalog/price-kindsDeletes a price kind by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/catalog/price-kinds" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/catalog/pricesReturns a paginated collection of prices scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| productId | query | No | any | — |
| variantId | query | No | any | — |
| offerId | query | No | any | — |
| channelId | query | No | any | — |
| currencyCode | query | No | any | — |
| priceKindId | query | No | any | — |
| kind | query | No | any | — |
| userId | query | No | any | — |
| userGroupId | query | No | any | — |
| customerId | query | No | any | — |
| customerGroupId | query | No | any | — |
| quantity | query | No | any | — |
| quantityUnit | query | No | any | — |
| withDeleted | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"product_id": null,
"variant_id": null,
"offer_id": null,
"currency_code": null,
"price_kind_id": null,
"kind": null,
"min_quantity": null,
"max_quantity": null,
"unit_price_net": null,
"unit_price_gross": null,
"tax_rate": null,
"tax_amount": null,
"channel_id": null,
"user_id": null,
"user_group_id": null,
"customer_id": null,
"customer_group_id": null,
"metadata": null,
"starts_at": null,
"ends_at": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/catalog/prices?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/catalog/pricesCreates a new price entry for a product or variant.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"currencyCode": "string",
"priceKindId": "00000000-0000-4000-8000-000000000000",
"taxRateId": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/catalog/prices" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"currencyCode\": \"string\",
\"priceKindId\": \"00000000-0000-4000-8000-000000000000\",
\"taxRateId\": null
}"/catalog/pricesUpdates an existing price by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"taxRateId": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/catalog/prices" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"taxRateId\": null
}"/channel_discord/ai-auto-reply/channels"string"
"string"
curl -X GET "https://om.opperescala.com/api/channel_discord/ai-auto-reply/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/channel_discord/channels/{id}/ai-auto-reply| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/channel_discord/channels/:id/ai-auto-reply" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/channel_discord/channels/{id}/ai-auto-reply| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
curl -X PUT "https://om.opperescala.com/api/channel_discord/channels/:id/ai-auto-reply" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/admin/channels/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
No response body.
"string"
"string"
"string"
curl -X DELETE "https://om.opperescala.com/api/communication_channels/admin/channels/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/channels"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/communication_channels/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/channels/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/communication_channels/channels/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/channels/{id}/health| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/communication_channels/channels/:id/health" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/channels/{id}/import-history| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"sinceDays": 30,
"maxMessages": 1000
}"string"
"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/communication_channels/channels/:id/import-history" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"sinceDays\": 30,
\"maxMessages\": 1000
}"/communication_channels/channels/{id}/poll-now| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/communication_channels/channels/:id/poll-now" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/channels/{id}/push/register| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/communication_channels/channels/:id/push/register" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/channels/{id}/set-primary| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/communication_channels/channels/:id/set-primary" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/channels/{id}/test-send| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/communication_channels/channels/:id/test-send" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/channels/{id}/visibility| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
"string"
curl -X PUT "https://om.opperescala.com/api/communication_channels/channels/:id/visibility" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/channels/connect/credentials"string"
"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/communication_channels/channels/connect/credentials" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/channels/connect/tenant-credentials"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/communication_channels/channels/connect/tenant-credentials" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/me/channels"string"
"string"
curl -X GET "https://om.opperescala.com/api/communication_channels/me/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/messages/{messageId}/reactions| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| messageId | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/communication_channels/messages/:messageId/reactions" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/messages/{messageId}/reactions/{reactionId}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| messageId | path | Yes | any | — |
| reactionId | path | Yes | any | — |
No response body.
"string"
"string"
"string"
"string"
"string"
curl -X DELETE "https://om.opperescala.com/api/communication_channels/messages/:messageId/reactions/:reactionId" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/oauth/{provider}/callback| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| provider | path | Yes | any | — |
"string"
"string"
curl -X GET "https://om.opperescala.com/api/communication_channels/oauth/:provider/callback" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/communication_channels/oauth/{provider}/initiate| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| provider | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/communication_channels/oauth/:provider/initiate" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/channel_discord/interactions"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/channel_discord/interactions" \ -H "Accept: application/json"
/configs/cacheReturns detailed cache statistics including total entries and breakdown by cache segments. Requires cache service to be available.
{
"generatedAt": "string",
"totalKeys": 1,
"segments": [
{
"segment": "string",
"resource": null,
"method": null,
"path": null,
"keyCount": 1,
"keys": [
"string"
]
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/configs/cache" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/configs/cachePurges cache entries. Supports two actions: purgeAll (clears entire cache) or purgeSegment (clears specific segment). Returns updated cache statistics after purge.
{
"action": "purgeAll"
}{
"action": "purgeSegment",
"segment": "string",
"deleted": 1,
"stats": {
"generatedAt": "string",
"totalKeys": 1,
"segments": [
{
"segment": "string",
"resource": null,
"method": null,
"path": null,
"keyCount": 1,
"keys": [
"string"
]
}
]
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/configs/cache" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"action\": \"purgeAll\"
}"/configs/module-telemetryReturns in-process module resource attribution for API routes, event subscribers, and queue workers.
{
"generatedAt": "string",
"startedAt": "string",
"enabled": true,
"bucketIntervalMs": 1,
"totals": {
"modules": 1,
"operations": 1,
"calls": 1,
"errors": 1,
"totalDurationMs": 1,
"totalCpuMs": 1,
"positiveHeapDeltaBytes": 1,
"positiveRssDeltaBytes": 1
},
"thresholds": {
"p95DurationMs": 1,
"cpuMs": 1,
"positiveHeapDeltaBytes": 1,
"positiveRssDeltaBytes": 1,
"errors": 1
},
"modules": [
{
"moduleId": "string",
"calls": 1,
"errors": 1,
"totalDurationMs": 1,
"p95DurationMs": 1,
"totalCpuMs": 1,
"positiveHeapDeltaBytes": 1,
"positiveRssDeltaBytes": 1,
"surfaces": [
{
"surface": "api",
"calls": 1,
"errors": 1,
"totalDurationMs": 1,
"p95DurationMs": 1,
"totalCpuMs": 1,
"positiveHeapDeltaBytes": 1,
"positiveRssDeltaBytes": 1
}
],
"topOperations": [
{
"moduleId": "string",
"surface": "api",
"operation": "string",
"resourceId": null,
"calls": 1,
"errors": 1,
"totalDurationMs": 1,
"maxDurationMs": 1,
"p95DurationMs": 1,
"totalCpuUserMs": 1,
"totalCpuSystemMs": 1,
"maxCpuMs": 1,
"totalHeapDeltaBytes": 1,
"positiveHeapDeltaBytes": 1,
"maxHeapDeltaBytes": 1,
"totalRssDeltaBytes": 1,
"positiveRssDeltaBytes": 1,
"maxRssDeltaBytes": 1,
"firstSeenAt": "string",
"lastSeenAt": "string"
}
],
"candidateReasons": [
"string"
]
}
],
"candidates": [
{
"moduleId": "string",
"calls": 1,
"errors": 1,
"totalDurationMs": 1,
"p95DurationMs": 1,
"totalCpuMs": 1,
"positiveHeapDeltaBytes": 1,
"positiveRssDeltaBytes": 1,
"surfaces": [
{
"surface": "api",
"calls": 1,
"errors": 1,
"totalDurationMs": 1,
"p95DurationMs": 1,
"totalCpuMs": 1,
"positiveHeapDeltaBytes": 1,
"positiveRssDeltaBytes": 1
}
],
"topOperations": [
{
"moduleId": "string",
"surface": "api",
"operation": "string",
"resourceId": null,
"calls": 1,
"errors": 1,
"totalDurationMs": 1,
"maxDurationMs": 1,
"p95DurationMs": 1,
"totalCpuUserMs": 1,
"totalCpuSystemMs": 1,
"maxCpuMs": 1,
"totalHeapDeltaBytes": 1,
"positiveHeapDeltaBytes": 1,
"maxHeapDeltaBytes": 1,
"totalRssDeltaBytes": 1,
"positiveRssDeltaBytes": 1,
"maxRssDeltaBytes": 1,
"firstSeenAt": "string",
"lastSeenAt": "string"
}
],
"candidateReasons": [
"string"
]
}
],
"buckets": [
{
"bucketStart": "string",
"bucketEnd": "string",
"bucketIntervalMs": 1,
"stage": "startup",
"partial": true,
"totals": {
"modules": 1,
"calls": 1,
"errors": 1,
"totalDurationMs": 1,
"totalCpuMs": 1,
"positiveHeapDeltaBytes": 1,
"positiveRssDeltaBytes": 1
},
"modules": [
{
"moduleId": "string",
"calls": 1,
"errors": 1,
"totalDurationMs": 1,
"p95DurationMs": 1,
"totalCpuMs": 1,
"positiveHeapDeltaBytes": 1,
"positiveRssDeltaBytes": 1,
"surfaces": [
{
"surface": "api",
"calls": 1,
"errors": 1,
"totalDurationMs": 1,
"p95DurationMs": 1,
"totalCpuMs": 1,
"positiveHeapDeltaBytes": 1,
"positiveRssDeltaBytes": 1
}
],
"topOperations": [
{
"moduleId": "string",
"surface": "api",
"operation": "string",
"resourceId": null,
"calls": 1,
"errors": 1,
"totalDurationMs": 1,
"maxDurationMs": 1,
"p95DurationMs": 1,
"totalCpuUserMs": 1,
"totalCpuSystemMs": 1,
"maxCpuMs": 1,
"totalHeapDeltaBytes": 1,
"positiveHeapDeltaBytes": 1,
"maxHeapDeltaBytes": 1,
"totalRssDeltaBytes": 1,
"positiveRssDeltaBytes": 1,
"maxRssDeltaBytes": 1,
"firstSeenAt": "string",
"lastSeenAt": "string"
}
],
"candidateReasons": [
"string"
]
}
]
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/configs/module-telemetry" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/configs/module-telemetryDevelopment-only endpoint that clears in-memory module telemetry and local process telemetry files.
{
"cleared": true
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/configs/module-telemetry" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/configs/system-statusReturns comprehensive system health information including environment details, version, resource usage, and service connectivity status.
{
"generatedAt": "string",
"runtimeMode": "development",
"categories": [
{
"key": "profiling",
"labelKey": "string",
"descriptionKey": null,
"items": [
{
"key": "string",
"category": "profiling",
"kind": "boolean",
"labelKey": "string",
"descriptionKey": "string",
"docUrl": null,
"defaultValue": null,
"state": "enabled",
"value": null,
"normalizedValue": null
}
]
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/configs/system-status" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/configs/system-statusPurges the entire cache for the current tenant. Useful for troubleshooting or forcing fresh data loading.
{
"cleared": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/configs/system-status" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/configs/upgrade-actionsReturns a list of pending upgrade actions for the current version. These are one-time setup tasks that need to be executed after upgrading to a new version. Requires organization and tenant context.
{
"version": "string",
"actions": [
{
"id": "string",
"version": "string",
"message": "string",
"ctaLabel": "string",
"successMessage": "string",
"loadingLabel": "string"
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/configs/upgrade-actions" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/configs/upgrade-actionsExecutes a specific upgrade action by ID. Typically used for one-time setup tasks like seeding example data after version upgrade. Returns execution status and localized success message.
{
"actionId": "string"
}{
"status": "string",
"message": "string",
"version": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/configs/upgrade-actions" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"actionId\": \"string\"
}"/customer_accounts/admin/demo-accountsReturns the example-data portal accounts that exist in the caller’s organization and can still be logged into with the credentials the seeding hook created them with. Accounts that were deactivated, left unverified, soft-deleted, or had their password changed are omitted, as is every account when example data was not seeded.
{
"ok": true,
"items": [
{
"email": "user@example.com",
"password": "string",
"roles": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"slug": "string"
}
]
}
]
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/admin/demo-accounts" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customer_accounts/admin/rolesReturns all customer roles for the tenant.
{
"ok": true,
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"slug": "string",
"description": null,
"isDefault": true,
"isSystem": true,
"customerAssignable": true,
"createdAt": "string",
"updatedAt": null
}
],
"total": 1,
"totalPages": 1,
"page": 1
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/admin/roles" \ -H "Accept: application/json"
/customer_accounts/admin/rolesCreates a new customer role with an empty ACL.
{
"name": "string",
"slug": "string"
}{
"ok": true,
"role": {
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"slug": "string",
"description": null,
"isDefault": true,
"isSystem": true,
"customerAssignable": true,
"createdAt": "string"
}
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/admin/roles" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"name\": \"string\",
\"slug\": \"string\"
}"/customer_accounts/admin/roles/{id}Returns full customer role details including ACL features.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"role": {
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"slug": "string",
"description": null,
"isDefault": true,
"isSystem": true,
"customerAssignable": true,
"createdAt": "string",
"updatedAt": null,
"acl": {
"features": [
"string"
],
"isPortalAdmin": true
}
}
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/admin/roles/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/customer_accounts/admin/roles/{id}Updates a customer role. System roles are protected from name changes.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{}{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/customer_accounts/admin/roles/00000000-0000-4000-8000-000000000000" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{}"/customer_accounts/admin/roles/{id}Soft deletes a customer role and its ACL. The default role (auto-assigned to new portal users) and roles with assigned users cannot be deleted.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/customer_accounts/admin/roles/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/customer_accounts/admin/roles/{id}/aclUpdates the ACL (features and portal admin flag) for a customer role. Invalidates RBAC cache after update.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"features": [
"string"
]
}{
"ok": true,
"updatedAt": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/customer_accounts/admin/roles/00000000-0000-4000-8000-000000000000/acl" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"features\": [
\"string\"
]
}"/customer_accounts/admin/usersReturns a paginated list of customer users with roles. Supports filtering by status, company, role, and search.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| status | query | No | any | — |
| customerEntityId | query | No | any | — |
| roleId | query | No | any | — |
| search | query | No | any | — |
{
"ok": true,
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"email": "string",
"displayName": "string",
"emailVerified": true,
"isActive": true,
"lockedUntil": null,
"lastLoginAt": null,
"customerEntityId": null,
"personEntityId": null,
"organizationId": null,
"organizationName": null,
"createdAt": "string",
"updatedAt": null,
"roles": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"slug": "string"
}
]
}
],
"total": 1,
"totalPages": 1,
"page": 1
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/admin/users" \ -H "Accept: application/json"
/customer_accounts/admin/usersCreates a new customer user directly. Staff-initiated, bypasses signup flow.
{
"email": "user@example.com",
"password": "string",
"displayName": "string"
}{
"ok": true,
"user": {
"id": "00000000-0000-4000-8000-000000000000",
"email": "string",
"displayName": "string"
}
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/admin/users" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"email\": \"user@example.com\",
\"password\": \"string\",
\"displayName\": \"string\"
}"/customer_accounts/admin/users-inviteLists invitations that are still pending — not accepted, not cancelled, and not expired — for the caller's tenant and organization. The invitation token is never returned.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| personEntityId | query | No | any | — |
| customerEntityId | query | No | any | — |
| query | No | any | — |
{
"ok": true,
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"email": "string",
"displayName": null,
"customerEntityId": null,
"personEntityId": null,
"roleIds": [
"00000000-0000-4000-8000-000000000000"
],
"invitedByUserId": null,
"expiresAt": "string",
"createdAt": "string"
}
],
"total": 1,
"totalPages": 1,
"page": 1
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/admin/users-invite" \ -H "Accept: application/json"
/customer_accounts/admin/users-inviteCreates a staff-initiated invitation for a new customer user. The invitedByUserId is set from the staff auth context.
{
"email": "user@example.com",
"roleIds": [
"00000000-0000-4000-8000-000000000000"
]
}{
"ok": true,
"invitation": {
"id": "00000000-0000-4000-8000-000000000000",
"email": "string",
"customerEntityId": null,
"personEntityId": null,
"expiresAt": "string"
}
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/admin/users-invite" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"email\": \"user@example.com\",
\"roleIds\": [
\"00000000-0000-4000-8000-000000000000\"
]
}"/customer_accounts/admin/users/{id}Returns full customer user details including CRM links, roles, and active session count.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"user": {
"id": "00000000-0000-4000-8000-000000000000",
"email": "string",
"displayName": "string",
"emailVerified": true,
"isActive": true,
"lockedUntil": null,
"lastLoginAt": null,
"failedLoginAttempts": 1,
"customerEntityId": null,
"personEntityId": null,
"createdAt": "string",
"updatedAt": null,
"roles": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"slug": "string"
}
],
"activeSessionCount": 1
}
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/customer_accounts/admin/users/{id}Updates a customer user. Staff can update status, lock, CRM links, and roles. Role assignment bypasses customer_assignable check.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"lockedUntil": null,
"personEntityId": null,
"customerEntityId": null
}{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"lockedUntil\": null,
\"personEntityId\": null,
\"customerEntityId\": null
}"/customer_accounts/admin/users/{id}Soft deletes a customer user and revokes all their active sessions.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/customer_accounts/admin/users/{id}/reset-passwordAllows staff to set a new password for a customer user.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"newPassword": "string"
}{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000/reset-password" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"newPassword\": \"string\"
}"/customer_accounts/admin/users/{id}/send-reset-linkCreates a password reset token for a customer user and returns a reset link URL. The admin must prepend the appropriate portal domain/slug to the relative URL.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"resetLink": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000/send-reset-link" \ -H "Accept: application/json"
/customer_accounts/admin/users/{id}/sessions/{sessionId}Allows staff to end one active portal session of a customer user. The customer is signed out of that session on the next request.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| sessionId | path | Yes | any | — |
{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000/sessions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/customer_accounts/admin/users/{id}/verify-emailAllows staff to manually mark a customer user email as verified.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000/verify-email" \ -H "Accept: application/json"
/customer_accounts/admin/domain-mappingsReturns all custom-domain mappings for the current tenant, optionally filtered by organization.
{
"ok": true,
"domainMappings": [
{
"id": "00000000-0000-4000-8000-000000000000",
"hostname": "string",
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"provider": "traefik",
"status": "pending",
"verifiedAt": null,
"lastDnsCheckAt": null,
"dnsFailureReason": null,
"tlsFailureReason": null,
"tlsRetryCount": 1,
"cnameTarget": null,
"aRecordTarget": null,
"createdAt": "string",
"updatedAt": null
}
],
"config": {
"cnameTarget": null,
"aRecordTarget": null
}
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/admin/domain-mappings" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customer_accounts/admin/domain-mappingsRegisters a new custom domain mapping for an organization. Verifies via DNS asynchronously.
{
"hostname": "string",
"organizationId": "00000000-0000-4000-8000-000000000000"
}{
"ok": true,
"domainMapping": {
"id": "00000000-0000-4000-8000-000000000000",
"hostname": "string",
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"provider": "traefik",
"status": "pending",
"verifiedAt": null,
"lastDnsCheckAt": null,
"dnsFailureReason": null,
"tlsFailureReason": null,
"tlsRetryCount": 1,
"cnameTarget": null,
"aRecordTarget": null,
"createdAt": "string",
"updatedAt": null
}
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/admin/domain-mappings" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"hostname\": \"string\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\"
}"/customer_accounts/admin/domain-mappingsRemoves the domain mapping identified by ?id=. Cache and Traefik routing drain within TTL.
{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/customer_accounts/admin/domain-mappings" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customer_accounts/admin/domain-mappings/{id}/health-checkRuns an HTTPS probe to verify Traefik has provisioned a certificate. On success: transitions the mapping to active.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"domainMapping": {
"id": "00000000-0000-4000-8000-000000000000",
"hostname": "string",
"status": "string",
"tlsRetryCount": 1,
"tlsFailureReason": null
}
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/admin/domain-mappings/:id/health-check" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customer_accounts/admin/domain-mappings/{id}/verifyRuns DNS verification (CNAME → A → reverse-resolve fallback) for the domain mapping. Returns diagnostics on failure.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"domainMapping": {
"id": "00000000-0000-4000-8000-000000000000",
"hostname": "string",
"status": "string",
"verifiedAt": null,
"lastDnsCheckAt": null,
"dnsFailureReason": null
},
"diagnostics": null
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/admin/domain-mappings/:id/verify" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customer_accounts/domain-checkCalled by Traefik before issuing a Let's Encrypt certificate. Requires the X-Domain-Check-Secret header to match DOMAIN_CHECK_SECRET.
{
"ok": true
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/domain-check" \ -H "Accept: application/json"
/customer_accounts/domain-resolveInternal endpoint used by the portal middleware to populate its in-memory cache. Requires X-Domain-Resolve-Secret header.
{
"ok": true,
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"orgSlug": null,
"status": "active"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/domain-resolve" \ -H "Accept: application/json"
/customer_accounts/domain-resolve/allReturns every active domain mapping in a single payload so the middleware can populate its cache on process start. Requires X-Domain-Resolve-Secret header.
{
"ok": true,
"domains": [
{
"hostname": "string",
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"orgSlug": null,
"status": "active"
}
]
}{
"ok": false,
"error": "string"
}{
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_accounts/domain-resolve/all" \ -H "Accept: application/json"
/customer_accounts/email/verifyValidates the email verification token and marks the email as verified.
{
"token": "string"
}{
"ok": true
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/email/verify" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"token\": \"string\"
}"/customer_accounts/invitations/acceptAccepts an invitation, creates the user account, assigns roles, and auto-logs in.
{
"token": "string",
"password": "string",
"displayName": "string"
}{
"ok": true,
"user": {
"id": "00000000-0000-4000-8000-000000000000",
"email": "user@example.com",
"displayName": "string",
"emailVerified": true
},
"resolvedFeatures": [
"string"
]
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/invitations/accept" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"token\": \"string\",
\"password\": \"string\",
\"displayName\": \"string\"
}"/customer_accounts/loginValidates customer credentials and issues JWT + session cookies.
{
"email": "user@example.com",
"password": "string"
}{
"ok": true,
"user": {
"id": "00000000-0000-4000-8000-000000000000",
"email": "user@example.com",
"displayName": "string",
"emailVerified": true
},
"resolvedFeatures": [
"string"
]
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/login" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"email\": \"user@example.com\",
\"password\": \"string\"
}"/customer_accounts/magic-link/requestSends a magic link to the customer email. Always returns 200 to prevent enumeration.
{
"email": "user@example.com"
}{
"ok": true
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/magic-link/request" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"email\": \"user@example.com\"
}"/customer_accounts/magic-link/verifyValidates the magic link token, auto-verifies email, and creates a session.
{
"token": "string"
}{
"ok": true,
"user": {
"id": "00000000-0000-4000-8000-000000000000",
"email": "user@example.com",
"displayName": "string",
"emailVerified": true
},
"resolvedFeatures": [
"string"
]
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/magic-link/verify" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"token\": \"string\"
}"/customer_accounts/password/reset-confirmValidates the reset token and sets a new password. Revokes all existing sessions.
{
"token": "string",
"password": "string"
}{
"ok": true
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/password/reset-confirm" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"token\": \"string\",
\"password\": \"string\"
}"/customer_accounts/password/reset-requestInitiates a password reset flow. Always returns 200 to prevent email enumeration.
{
"email": "user@example.com"
}{
"ok": true
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/password/reset-request" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"email\": \"user@example.com\"
}"/customer_accounts/signupAccepts a signup request and always returns 202 to prevent account enumeration.
{
"email": "user@example.com",
"password": "string",
"displayName": "string"
}{
"ok": true
}{
"ok": false,
"error": "string"
}{
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_accounts/signup" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"email\": \"user@example.com\",
\"password\": \"string\",
\"displayName\": \"string\"
}"/customer_groups/customer-groupsReturns a paginated collection of customergroups scoped to the authenticated tenant.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| id | query | No | any | — |
| search | query | No | any | — |
| kind | query | No | any | — |
| parentId | query | No | any | — |
| isActive | query | No | any | — |
| isDefault | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"organization_id": null,
"tenant_id": null,
"code": "string",
"name": "string",
"description": null,
"kind": "string",
"parent_id": null,
"priority": 1,
"is_default": true,
"is_active": true,
"metadata": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/customer_groups/customer-groups?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customer_groups/customer-groupsCreates a customer group scoped to the authenticated tenant. A requested default that loses a concurrent promotion still creates the group, as a non-default one (isDefault: false in the response).
{
"organizationId": null,
"tenantId": "00000000-0000-4000-8000-000000000000",
"code": "string",
"name": "string",
"description": null,
"kind": "b2c",
"parentId": null,
"priority": 1,
"isDefault": false,
"isActive": true,
"metadata": null
}{
"id": null,
"isDefault": true
}curl -X POST "https://om.opperescala.com/api/customer_groups/customer-groups" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": null,
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"code\": \"string\",
\"name\": \"string\",
\"description\": null,
\"kind\": \"b2c\",
\"parentId\": null,
\"priority\": 1,
\"isDefault\": false,
\"isActive\": true,
\"metadata\": null
}"/customer_groups/customer-groupsUpdates a customer group by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"organizationId": null,
"description": null,
"parentId": null,
"metadata": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/customer_groups/customer-groups" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": null,
\"description\": null,
\"parentId\": null,
\"metadata\": null
}"/customer_groups/customer-groupsSoft-deletes a customer group by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/customer_groups/customer-groups" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/customer_groups/customer-groups/{id}/termsReturns the group’s own terms row, or `{ terms: null }` when the group has none and inherits from its parent/tenant defaults.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"terms": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_groups/customer-groups/:id/terms" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customer_groups/customer-groups/{id}/termsUpserts the group’s terms row (creates it on first save). Supports optimistic locking via the extension header once a row exists.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"organizationId": null,
"priceKindId": null,
"paymentTermsDays": null,
"allowPurchaseOnAccount": null,
"defaultCreditLimit": null,
"creditCurrencyCode": null,
"approvalRequiredAbove": null,
"minOrderValue": null,
"metadata": null
}{
"terms": {
"id": "00000000-0000-4000-8000-000000000000",
"groupId": "00000000-0000-4000-8000-000000000000",
"organizationId": null,
"tenantId": "00000000-0000-4000-8000-000000000000",
"priceKindId": null,
"paymentTermsDays": null,
"allowPurchaseOnAccount": null,
"defaultCreditLimit": null,
"creditCurrencyCode": null,
"approvalRequiredAbove": null,
"minOrderValue": null,
"metadata": null,
"createdAt": "string",
"updatedAt": "string"
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/customer_groups/customer-groups/:id/terms" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": null,
\"priceKindId\": null,
\"paymentTermsDays\": null,
\"allowPurchaseOnAccount\": null,
\"defaultCreditLimit\": null,
\"creditCurrencyCode\": null,
\"approvalRequiredAbove\": null,
\"minOrderValue\": null,
\"metadata\": null
}"/customer_groups/customer-groups/explain-termsResolves the effective commercial terms for a customer and, per field, the group that supplied the value (or tenant default) plus the visible ancestor path (child → parent → tenant) used to find it.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| customerId | query | Yes | any | — |
{
"groups": [
{
"id": "00000000-0000-4000-8000-000000000000",
"code": "string",
"name": "string"
}
],
"fields": {
"priceKindId": {
"value": "string",
"sourceGroupId": null,
"path": [
{
"id": "00000000-0000-4000-8000-000000000000",
"code": "string",
"name": "string"
}
]
},
"paymentTermsDays": {
"value": "string",
"sourceGroupId": null,
"path": [
{
"id": "00000000-0000-4000-8000-000000000000",
"code": "string",
"name": "string"
}
]
},
"allowPurchaseOnAccount": {
"value": "string",
"sourceGroupId": null,
"path": [
{
"id": "00000000-0000-4000-8000-000000000000",
"code": "string",
"name": "string"
}
]
},
"approvalRequiredAbove": {
"value": "string",
"sourceGroupId": null,
"path": [
{
"id": "00000000-0000-4000-8000-000000000000",
"code": "string",
"name": "string"
}
]
},
"minOrderValue": {
"value": "string",
"sourceGroupId": null,
"path": [
{
"id": "00000000-0000-4000-8000-000000000000",
"code": "string",
"name": "string"
}
]
}
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_groups/customer-groups/explain-terms?customerId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customer_groups/customer-groups/membershipsReturns a paginated collection of customergroupmemberships scoped to the authenticated tenant.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| id | query | No | any | — |
| customerId | query | No | any | — |
| groupId | query | No | any | — |
| activeOnly | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"organization_id": null,
"tenant_id": null,
"group_id": "00000000-0000-4000-8000-000000000000",
"customer_id": "00000000-0000-4000-8000-000000000000",
"source": "string",
"valid_from": null,
"valid_until": null,
"assigned_by_user_id": null,
"notes": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/customer_groups/customer-groups/memberships?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customer_groups/customer-groups/membershipsAdds a customer to a customer group, scoped to the authenticated tenant. The tenant, the organization (taken from the customer) and assignedByUserId (the acting user) are set by the server.
{
"groupId": "00000000-0000-4000-8000-000000000000",
"customerId": "00000000-0000-4000-8000-000000000000",
"source": "manual",
"validFrom": null,
"validUntil": null,
"notes": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/customer_groups/customer-groups/memberships" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"groupId\": \"00000000-0000-4000-8000-000000000000\",
\"customerId\": \"00000000-0000-4000-8000-000000000000\",
\"source\": \"manual\",
\"validFrom\": null,
\"validUntil\": null,
\"notes\": null
}"/customer_groups/customer-groups/membershipsUpdates a customer group membership by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"validFrom": null,
"validUntil": null,
"notes": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/customer_groups/customer-groups/memberships" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"validFrom\": null,
\"validUntil\": null,
\"notes\": null
}"/customer_groups/customer-groups/membershipsSoft-deletes a customer group membership by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/customer_groups/customer-groups/memberships" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/customer_groups/customer-groups/price-kindsReturns the tenant’s catalog price kinds (id, code, title) for the commercial terms price kind picker, readable with customer_groups.terms.view instead of catalog.settings.manage. Returns an empty list when the catalog module is not installed.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| search | query | No | any | — |
| ids | query | No | any | Comma-separated price kind ids |
| pageSize | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"code": "string",
"title": "string"
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_groups/customer-groups/price-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customer_groups/customer-groups/reconcileScans catalog_product_variant_prices.customer_group_id and sales_tax_rates.customer_group_id for values with no matching customer_groups row, scoped to the authenticated tenant.
{
"orphans": [
{
"groupId": "00000000-0000-4000-8000-000000000000",
"tenantId": null,
"catalogPriceCount": 1,
"salesTaxRateCount": 1,
"sampleCatalogPriceIds": [
"00000000-0000-4000-8000-000000000000"
],
"sampleSalesTaxRateIds": [
"00000000-0000-4000-8000-000000000000"
]
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customer_groups/customer-groups/reconcile" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customer_groups/customer-groups/reconcile/adoptCreates one inactive placeholder CustomerGroup per orphaned customer_group_id found by the reconciliation scan, reusing that id so existing catalog price / sales tax rate rows resolve.
{
"ok": true,
"adoptedCount": 1,
"adopted": [
{
"groupId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"code": "string"
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_groups/customer-groups/reconcile/adopt" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customer_groups/customer-groups/reorderRewrites CustomerGroup.priority for the given ordered list of ids (at most 500) inside one transaction. When the list covers every group in the tenant, priorities are renumbered in gaps of 10; otherwise the listed groups are reordered among the priority values they already hold and unlisted groups are left untouched.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"ids": [
"00000000-0000-4000-8000-000000000000"
]
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/customer_groups/customer-groups/reorder" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"ids\": [
\"00000000-0000-4000-8000-000000000000\"
]
}"/customers/activitiesReturns a paginated collection of activitys scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| entityId | query | No | any | — |
| dealId | query | No | any | — |
| activityType | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"activityType": "string",
"subject": null,
"body": null,
"occurredAt": null,
"createdAt": "string",
"appearanceIcon": null,
"appearanceColor": null,
"entityId": null,
"authorUserId": null,
"authorName": null,
"authorEmail": null,
"dealId": null,
"dealTitle": null,
"customValues": null,
"activityTypeLabel": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/customers/activities?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customers/activitiesDEPRECATED (sunset 2026-06-30): Creates a timeline activity. Use POST /api/customers/interactions instead.
{
"entityId": "00000000-0000-4000-8000-000000000000",
"activityType": "string",
"date": null,
"time": null,
"phoneNumber": null,
"appearanceIcon": null,
"appearanceColor": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/customers/activities" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityId\": \"00000000-0000-4000-8000-000000000000\",
\"activityType\": \"string\",
\"date\": null,
\"time\": null,
\"phoneNumber\": null,
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/customers/activitiesDEPRECATED (sunset 2026-06-30): Updates an activity. Use PUT /api/customers/interactions instead.
{
"id": "00000000-0000-4000-8000-000000000000",
"date": null,
"time": null,
"phoneNumber": null,
"appearanceIcon": null,
"appearanceColor": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/customers/activities" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"date\": null,
\"time\": null,
\"phoneNumber\": null,
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/customers/activitiesDEPRECATED (sunset 2026-06-30): Deletes an activity. Use DELETE /api/customers/interactions instead.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/customers/activities" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/customers/addressesReturns a paginated collection of addresss scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| entityId | query | No | any | — |
| id | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"entity_id": "00000000-0000-4000-8000-000000000000",
"name": null,
"purpose": null,
"company_name": null,
"address_line1": null,
"address_line2": null,
"building_number": null,
"flat_number": null,
"city": null,
"region": null,
"postal_code": null,
"country": null,
"latitude": null,
"longitude": null,
"is_primary": null,
"organization_id": null,
"tenant_id": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/customers/addresses?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customers/addressesCreates a customer address record and associates it with the referenced entity.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"entityId": "00000000-0000-4000-8000-000000000000",
"addressLine1": "string",
"latitude": null,
"longitude": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/customers/addresses" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"entityId\": \"00000000-0000-4000-8000-000000000000\",
\"addressLine1\": \"string\",
\"latitude\": null,
\"longitude\": null
}"/customers/addressesUpdates fields on an existing customer address.
{
"id": "00000000-0000-4000-8000-000000000000",
"latitude": null,
"longitude": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/customers/addresses" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"latitude\": null,
\"longitude\": null
}"/customers/addressesDeletes an address by id. The identifier may be included in the body or query.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/customers/addresses" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/customers/assignable-staffDeprecated. Returns 308 Permanent Redirect to /api/staff/team-members/assignable preserving the query string. Will be removed no earlier than the next major release.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"teamMemberId": "00000000-0000-4000-8000-000000000000",
"userId": "00000000-0000-4000-8000-000000000000",
"displayName": "string",
"email": null,
"teamName": null,
"user": null,
"team": null
}
],
"total": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customers/assignable-staff?page=1&pageSize=24" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customers/commentsReturns a paginated collection of comments scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| entityId | query | No | any | — |
| dealId | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"entity_id": null,
"deal_id": null,
"body": null,
"author_user_id": null,
"appearance_icon": null,
"appearance_color": null,
"organization_id": null,
"tenant_id": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/customers/comments?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customers/commentsAdds a comment to a customer timeline.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"entityId": "00000000-0000-4000-8000-000000000000",
"body": "string",
"appearanceIcon": null,
"appearanceColor": null
}{
"id": null,
"authorUserId": null
}curl -X POST "https://om.opperescala.com/api/customers/comments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"entityId\": \"00000000-0000-4000-8000-000000000000\",
\"body\": \"string\",
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/customers/commentsUpdates an existing timeline comment.
{
"id": "00000000-0000-4000-8000-000000000000",
"appearanceIcon": null,
"appearanceColor": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/customers/comments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/customers/commentsDeletes a comment identified by `id` supplied via body or query string.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/customers/comments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/customers/companiesReturns a paginated collection of companies scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| query | No | any | — | |
| emailStartsWith | query | No | any | — |
| emailContains | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| status | query | No | any | — |
| lifecycleStage | query | No | any | — |
| source | query | No | any | — |
| hasEmail | query | No | any | — |
| hasPhone | query | No | any | — |
| hasNextInteraction | query | No | any | — |
| createdFrom | query | No | any | — |
| createdTo | query | No | any | — |
| id | query | No | any | — |
| tagIds | query | No | any | — |
| tagIdsEmpty | query | No | any | — |
| excludeIds | query | No | any | — |
| excludeLinkedPersonId | query | No | any | — |
| excludeLinkedCompanyId | query | No | any | — |
| excludeLinkedDealId | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"description": null,
"owner_user_id": null,
"primary_email": null,
"primary_phone": null,
"status": null,
"lifecycle_stage": null,
"source": null,
"next_interaction_at": null,
"next_interaction_name": null,
"next_interaction_ref_id": null,
"next_interaction_icon": null,
"next_interaction_color": null,
"organization_id": null,
"tenant_id": null,
"created_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/customers/companies?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customers/companiesCreates a company record and associated profile data.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"displayName": "string",
"description": null,
"primaryEmail": null,
"primaryPhone": null,
"nextInteraction": null,
"legalName": null,
"brandName": null,
"domain": null,
"websiteUrl": null,
"sizeBucket": null,
"annualRevenue": null
}{
"id": null,
"companyId": null
}curl -X POST "https://om.opperescala.com/api/customers/companies" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"displayName\": \"string\",
\"description\": null,
\"primaryEmail\": null,
\"primaryPhone\": null,
\"nextInteraction\": null,
\"legalName\": null,
\"brandName\": null,
\"domain\": null,
\"websiteUrl\": null,
\"sizeBucket\": null,
\"annualRevenue\": null
}"/customers/companiesUpdates company profile fields, tags, or custom attributes.
{
"id": "00000000-0000-4000-8000-000000000000",
"description": null,
"primaryEmail": null,
"primaryPhone": null,
"nextInteraction": null,
"legalName": null,
"brandName": null,
"domain": null,
"websiteUrl": null,
"sizeBucket": null,
"annualRevenue": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/customers/companies" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"description\": null,
\"primaryEmail\": null,
\"primaryPhone\": null,
\"nextInteraction\": null,
\"legalName\": null,
\"brandName\": null,
\"domain\": null,
\"websiteUrl\": null,
\"sizeBucket\": null,
\"annualRevenue\": null
}"/customers/companiesDeletes a company by id. The identifier can be provided via body or query.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}{
"error": "string",
"code": "COMPANY_HAS_DEPENDENTS"
}curl -X DELETE "https://om.opperescala.com/api/customers/companies" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/customers/companies/{id}Returns a company customer record with optional related resources such as addresses, comments, activities, interactions, deals, todos, and linked people.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| include | query | No | any | Comma-separated list of relations to include (addresses, comments, activities, interactions, deals, todos, people). |
{
"interactionMode": "canonical",
"company": {
"id": "00000000-0000-4000-8000-000000000000",
"displayName": null,
"description": null,
"ownerUserId": null,
"primaryEmail": null,
"primaryPhone": null,
"status": null,
"lifecycleStage": null,
"source": null,
"nextInteractionAt": null,
"nextInteractionName": null,
"nextInteractionRefId": null,
"nextInteractionIcon": null,
"nextInteractionColor": null,
"organizationId": null,
"tenantId": null,
"temperature": null,
"renewalQuarter": null,
"createdAt": "string",
"updatedAt": "string"
},
"profile": null,
"customFields": {},
"tags": [
{
"id": "00000000-0000-4000-8000-000000000000",
"label": "string",
"color": null
}
],
"addresses": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": null,
"purpose": null,
"addressLine1": null,
"addressLine2": null,
"buildingNumber": null,
"flatNumber": null,
"city": null,
"region": null,
"postalCode": null,
"country": null,
"latitude": null,
"longitude": null,
"isPrimary": null,
"createdAt": "string"
}
],
"comments": [
{
"id": "00000000-0000-4000-8000-000000000000",
"body": null,
"authorUserId": null,
"authorName": null,
"authorEmail": null,
"dealId": null,
"createdAt": "string",
"appearanceIcon": null,
"appearanceColor": null
}
],
"activities": [
{
"id": "00000000-0000-4000-8000-000000000000",
"activityType": "string",
"subject": null,
"body": null,
"occurredAt": null,
"dealId": null,
"authorUserId": null,
"authorName": null,
"authorEmail": null,
"createdAt": "string",
"appearanceIcon": null,
"appearanceColor": null
}
],
"interactions": [
{
"id": "00000000-0000-4000-8000-000000000000",
"entityId": null,
"interactionType": "string",
"title": null,
"body": null,
"status": "string",
"scheduledAt": null,
"occurredAt": null,
"priority": null,
"authorUserId": null,
"ownerUserId": null,
"dealId": null,
"organizationId": null,
"tenantId": null,
"authorName": null,
"authorEmail": null,
"dealTitle": null,
"customValues": null,
"appearanceIcon": null,
"appearanceColor": null,
"source": null,
"createdAt": "string",
"updatedAt": "string"
}
],
"deals": [
{
"id": "00000000-0000-4000-8000-000000000000",
"title": null,
"status": null,
"pipelineStage": null,
"valueAmount": null,
"valueCurrency": null,
"probability": null,
"expectedCloseAt": null,
"ownerUserId": null,
"source": null,
"createdAt": "string",
"updatedAt": "string"
}
],
"todos": [
{
"id": "00000000-0000-4000-8000-000000000000",
"todoId": "00000000-0000-4000-8000-000000000000",
"todoSource": "string",
"createdAt": "string",
"createdByUserId": null,
"title": null,
"isDone": null,
"priority": null,
"severity": null,
"description": null,
"dueAt": null,
"todoOrganizationId": null,
"customValues": null
}
],
"people": [
{
"id": "00000000-0000-4000-8000-000000000000",
"displayName": null,
"primaryEmail": null,
"primaryPhone": null,
"status": null,
"lifecycleStage": null,
"jobTitle": null,
"department": null,
"createdAt": "string",
"organizationId": null,
"source": null,
"temperature": null,
"linkedAt": null
}
],
"viewer": {
"userId": null,
"name": null,
"email": null
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customers/companies/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customers/companies/{id}/people| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| sort | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"displayName": "string",
"primaryEmail": null,
"primaryPhone": null,
"status": null,
"lifecycleStage": null,
"jobTitle": null,
"department": null,
"createdAt": "string",
"organizationId": null,
"temperature": null,
"source": null,
"linkedAt": null
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/customers/companies/:id/people?page=1&pageSize=20&sort=name-asc" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/customers/companies/{id}/roles| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"entityType": "company",
"entityId": "00000000-0000-4000-8000-000000000000",
"userId": "00000000-0000-4000-8000-000000000000",
"userName": null,
"userEmail": null,
"userPhone": null,
"roleType": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/customers/companies/00000000-0000-4000-8000-000000000000/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/dashboards/layoutReturns the saved widget layout together with the widgets the current user is allowed to place.
{
"layout": {
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"widgetId": "string",
"order": 1
}
]
},
"allowedWidgetIds": [
"string"
],
"canConfigure": true,
"context": {
"userId": "00000000-0000-4000-8000-000000000000",
"tenantId": null,
"organizationId": null,
"userName": null,
"userEmail": null,
"userLabel": "string"
},
"widgets": [
{
"id": "string",
"title": "string",
"description": null,
"defaultSize": "sm",
"defaultEnabled": true,
"defaultSettings": null,
"features": [
"string"
],
"moduleId": "string",
"icon": null,
"loaderKey": "string",
"supportsRefresh": true
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/dashboards/layout" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/dashboards/layoutSaves the provided widget ordering, sizes, and settings for the current user.
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"widgetId": "string",
"order": 1
}
]
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/dashboards/layout" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"items\": [
{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"widgetId\": \"string\",
\"order\": 1
}
]
}"/dashboards/layout/{itemId}Adjusts the size or settings for a single widget within the dashboard layout.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| itemId | path | Yes | any | — |
{}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PATCH "https://om.opperescala.com/api/dashboards/layout/00000000-0000-4000-8000-000000000000" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/dashboards/roles/widgetsReturns the widgets explicitly assigned to the given role together with the evaluation scope.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| roleId | query | Yes | any | — |
| tenantId | query | No | any | — |
| organizationId | query | No | any | — |
{
"widgetIds": [
"string"
],
"hasCustom": true,
"scope": {
"tenantId": null,
"organizationId": null
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/dashboards/roles/widgets?roleId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/dashboards/roles/widgetsPersists the widget list for a role within the provided tenant and organization scope.
{
"roleId": "00000000-0000-4000-8000-000000000000",
"widgetIds": [
"string"
]
}{
"ok": true,
"widgetIds": [
"string"
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/dashboards/roles/widgets" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"roleId\": \"00000000-0000-4000-8000-000000000000\",
\"widgetIds\": [
\"string\"
]
}"/dashboards/users/widgetsReturns the widgets inherited and explicitly configured for the requested user within the current scope.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| userId | query | Yes | any | — |
| tenantId | query | No | any | — |
| organizationId | query | No | any | — |
{
"mode": "inherit",
"widgetIds": [
"string"
],
"hasCustom": true,
"effectiveWidgetIds": [
"string"
],
"scope": {
"tenantId": null,
"organizationId": null
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/dashboards/users/widgets?userId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/dashboards/users/widgetsSets the widget override mode and allowed widgets for a user. Passing `mode: inherit` clears overrides.
{
"userId": "00000000-0000-4000-8000-000000000000",
"mode": "inherit",
"widgetIds": [
"string"
]
}{
"ok": true,
"mode": "inherit",
"widgetIds": [
"string"
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/dashboards/users/widgets" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"userId\": \"00000000-0000-4000-8000-000000000000\",
\"mode\": \"inherit\",
\"widgetIds\": [
\"string\"
]
}"/dashboards/widgets/catalogReturns the catalog of widgets that modules expose, including defaults and feature requirements.
{
"items": [
{
"id": "string",
"title": "string",
"description": null,
"defaultSize": "sm",
"defaultEnabled": true,
"defaultSettings": null,
"features": [
"string"
],
"moduleId": "string",
"icon": null,
"loaderKey": "string",
"supportsRefresh": true
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/dashboards/widgets/catalog" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/dashboards/widgets/dataExecutes an aggregation query against the specified entity type and returns the result. Supports date range filtering, grouping, and period-over-period comparison.
{
"entityType": "string",
"metric": {
"field": "string",
"aggregate": "count"
}
}{
"value": null,
"data": [
{
"value": null
}
],
"metadata": {
"fetchedAt": "string",
"recordCount": 1,
"currency": null
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/dashboards/widgets/data" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityType\": \"string\",
\"metric\": {
\"field\": \"string\",
\"aggregate\": \"count\"
}
}"/dashboards/widgets/data/batchResolves a batch of widget data requests with a single authentication, RBAC, organization-scope, and database-context setup. Each request is keyed by an opaque widget id and resolved independently, so a failure in one widget does not fail the batch.
{
"requests": [
{
"id": "string",
"request": {
"entityType": "string",
"metric": {
"field": "string",
"aggregate": "count"
}
}
}
]
}{
"results": [
{
"id": "string",
"ok": true,
"data": {
"value": null,
"data": [
{
"value": null
}
],
"metadata": {
"fetchedAt": "string",
"recordCount": 1,
"currency": null
}
}
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/dashboards/widgets/data/batch" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"requests\": [
{
\"id\": \"string\",
\"request\": {
\"entityType\": \"string\",
\"metric\": {
\"field\": \"string\",
\"aggregate\": \"count\"
}
}
}
]
}"/devices/admin/devices/{id}Admin: fetch a single device by id (push_token is never returned). Response keys are camelCase. The snake_case keys (`user_id`, `device_id`, `last_seen_at`, …) are deprecated aliases of their camelCase counterparts, retained for one minor version and removed in the next; read `userId`, `deviceId`, `lastSeenAt`, … instead.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"item": {
"id": "00000000-0000-4000-8000-000000000000",
"userId": "00000000-0000-4000-8000-000000000000",
"deviceId": "string",
"platform": "ios",
"clientAppVersion": null,
"osVersion": null,
"pushProvider": null,
"pushTokenUpdatedAt": null,
"lastSeenAt": null,
"createdAt": null,
"updatedAt": null,
"user_id": "00000000-0000-4000-8000-000000000000",
"device_id": "string",
"client_app_version": null,
"os_version": null,
"push_provider": null,
"push_token_updated_at": null,
"last_seen_at": null,
"created_at": null,
"updated_at": null
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/devices/admin/devices/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/devices/admin/devices/{id}Admin: update last-seen, app/OS metadata, and push token for any device. Set pushToken to null to clear it.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"clientAppVersion": null,
"osVersion": null,
"locale": null,
"pushToken": null,
"pushProvider": null
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/devices/admin/devices/:id" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"clientAppVersion\": null,
\"osVersion\": null,
\"locale\": null,
\"pushToken\": null,
\"pushProvider\": null
}"/devices/admin/devices/{id}Admin: soft-delete any device in the tenant.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/devices/admin/devices/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/dictionariesReturns dictionaries accessible to the current organization, optionally including inactive records.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| includeInactive | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"key": "string",
"name": "string",
"description": null,
"isSystem": true,
"isActive": true,
"managerVisibility": null,
"organizationId": null,
"createdAt": "string",
"updatedAt": null
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/dictionaries" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/dictionariesRegisters a dictionary scoped to the current organization.
{
"key": "string",
"name": "string"
}{
"id": "00000000-0000-4000-8000-000000000000",
"key": "string",
"name": "string",
"description": null,
"isSystem": true,
"isActive": true,
"managerVisibility": null,
"organizationId": null,
"createdAt": "string",
"updatedAt": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/dictionaries" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"key\": \"string\",
\"name\": \"string\"
}"/dictionaries/{dictionaryId}Returns details for the specified dictionary, including inheritance flags.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| dictionaryId | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"key": "string",
"name": "string",
"description": null,
"isSystem": true,
"isActive": true,
"managerVisibility": null,
"organizationId": null,
"createdAt": "string",
"updatedAt": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/dictionaries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/dictionaries/{dictionaryId}Updates mutable attributes of the dictionary. Currency dictionaries are protected from modification.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| dictionaryId | path | Yes | any | — |
{}{
"id": "00000000-0000-4000-8000-000000000000",
"key": "string",
"name": "string",
"description": null,
"isSystem": true,
"isActive": true,
"managerVisibility": null,
"organizationId": null,
"createdAt": "string",
"updatedAt": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PATCH "https://om.opperescala.com/api/dictionaries/00000000-0000-4000-8000-000000000000" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/dictionaries/{dictionaryId}Soft deletes the dictionary unless it is the protected currency dictionary.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| dictionaryId | path | Yes | any | — |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/dictionaries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/dictionaries/{dictionaryId}/entriesReturns entries for the specified dictionary ordered by its configured entry sort mode. The number of entries returned per request is capped at 500; use `limit` and `offset` with the `total`/`hasMore` response fields to page through larger dictionaries.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| dictionaryId | path | Yes | any | — |
| limit | query | No | any | Maximum entries to return. Defaults to and is capped at 500. |
| offset | query | No | any | Number of entries to skip. Defaults to 0. |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"value": "string",
"label": "string",
"color": null,
"icon": null,
"position": 1,
"isDefault": true,
"createdAt": "string",
"updatedAt": null
}
],
"total": 1,
"limit": 1,
"offset": 1,
"hasMore": true,
"sortMode": "label_asc"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/dictionaries/00000000-0000-4000-8000-000000000000/entries" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/dictionaries/{dictionaryId}/entriesCreates a new entry in the specified dictionary.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| dictionaryId | path | Yes | any | — |
{
"value": "string",
"color": null,
"icon": null
}{
"id": "00000000-0000-4000-8000-000000000000",
"value": "string",
"label": "string",
"color": null,
"icon": null,
"position": 1,
"isDefault": true,
"createdAt": "string",
"updatedAt": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/dictionaries/00000000-0000-4000-8000-000000000000/entries" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"value\": \"string\",
\"color\": null,
\"icon\": null
}"/dictionaries/{dictionaryId}/entries/{entryId}Updates the specified dictionary entry using the command bus pipeline.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| dictionaryId | path | Yes | any | — |
| entryId | path | Yes | any | — |
{
"color": null,
"icon": null
}{
"id": "00000000-0000-4000-8000-000000000000",
"value": "string",
"label": "string",
"color": null,
"icon": null,
"position": 1,
"isDefault": true,
"createdAt": "string",
"updatedAt": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PATCH "https://om.opperescala.com/api/dictionaries/00000000-0000-4000-8000-000000000000/entries/00000000-0000-4000-8000-000000000000" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"color\": null,
\"icon\": null
}"/dictionaries/{dictionaryId}/entries/{entryId}Deletes the specified dictionary entry via the command bus.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| dictionaryId | path | Yes | any | — |
| entryId | path | Yes | any | — |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/dictionaries/00000000-0000-4000-8000-000000000000/entries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/dictionaries/{dictionaryId}/entries/reorderUpdates the position of dictionary entries for drag-and-drop reordering.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| dictionaryId | path | Yes | any | — |
{
"entries": [
{
"id": "00000000-0000-4000-8000-000000000000",
"position": 1
}
]
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/dictionaries/00000000-0000-4000-8000-000000000000/entries/reorder" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entries\": [
{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"position\": 1
}
]
}"/dictionaries/{dictionaryId}/entries/set-defaultMarks the specified entry as the default for this dictionary, clearing any previous default.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| dictionaryId | path | Yes | any | — |
{
"entryId": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/dictionaries/00000000-0000-4000-8000-000000000000/entries/set-default" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entryId\": \"00000000-0000-4000-8000-000000000000\"
}"/directory/organization-brandingReturns the logo URL used by the backend sidebar for the currently selected organization.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"organizationName": "string",
"tenantId": "00000000-0000-4000-8000-000000000000",
"logoUrl": null,
"logoPreserveAspectRatio": true,
"updatedAt": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/directory/organization-branding" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/directory/organization-brandingStores an external image URL or an internal attachment image URL as the selected organization logo.
{
"logoUrl": null
}{
"organizationId": "00000000-0000-4000-8000-000000000000",
"organizationName": "string",
"tenantId": "00000000-0000-4000-8000-000000000000",
"logoUrl": null,
"logoPreserveAspectRatio": true,
"updatedAt": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/directory/organization-branding" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"logoUrl\": null
}"/directory/organization-switcherReturns the hierarchical menu of organizations the current user may switch to within the active tenant.
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"depth": 1,
"selectable": true,
"children": []
}
],
"selectedId": null,
"canManage": true,
"canViewAllOrganizations": true,
"tenantId": null,
"tenants": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"isActive": true
}
],
"isSuperAdmin": true
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/directory/organization-switcher" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/directory/organizationsReturns organizations using options, tree, or paginated manage view depending on the `view` parameter.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| view | query | No | any | — |
| ids | query | No | any | — |
| tenantId | query | No | any | — |
| includeInactive | query | No | any | — |
| status | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"parentId": null,
"parentName": null,
"tenantId": null,
"tenantName": null,
"rootId": null,
"treePath": null
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/directory/organizations?page=1&pageSize=50&view=options" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/directory/organizationsCreates a new organization within a tenant and optionally assigns hierarchy relationships.
{
"name": "string",
"slug": null,
"logoUrl": null,
"parentId": null
}{
"id": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/directory/organizations" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"name\": \"string\",
\"slug\": null,
\"logoUrl\": null,
\"parentId\": null
}"/directory/organizationsUpdates organization details and hierarchy assignments. Fields that are omitted keep their current value; send `parentId: null` or `childIds: []` to clear the parent or the children.
{
"id": "00000000-0000-4000-8000-000000000000",
"slug": null,
"logoUrl": null,
"parentId": null
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/directory/organizations" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"slug\": null,
\"logoUrl\": null,
\"parentId\": null
}"/directory/organizationsSoft deletes an organization identified by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/directory/organizations" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/directory/tenantsReturns tenants visible to the current user with optional search and pagination.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| isActive | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"isActive": true,
"createdAt": null,
"updatedAt": null
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/directory/tenants?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/directory/tenantsCreates a new tenant and returns its identifier.
{
"name": "string"
}{
"id": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/directory/tenants" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"name\": \"string\"
}"/directory/tenantsUpdates tenant properties such as name or activation state.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/directory/tenants" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/directory/tenantsSoft deletes the tenant identified by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/directory/tenants" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/entities/definitionsReturns active custom field definitions for the supplied entity ids, respecting tenant scope and tombstones.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| entityId | query | No | any | — |
| entityIds | query | No | any | — |
| fieldset | query | No | any | — |
{
"items": [
{
"key": "string",
"kind": "string",
"label": "string",
"entityId": "string"
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/entities/definitions" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/entities/definitionsCreates or updates a custom field definition for the current tenant/org scope.
{
"entityId": "string",
"key": "string",
"kind": "text"
}{
"ok": true,
"item": {
"id": "00000000-0000-4000-8000-000000000000",
"key": "string",
"kind": "string",
"configJson": {}
}
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/entities/definitions" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityId\": \"string\",
\"key\": \"string\",
\"kind\": \"text\"
}"/entities/definitionsMarks the specified definition inactive and tombstones it for the current scope.
{
"entityId": "string",
"key": "string"
}{
"ok": true,
"version": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/entities/definitions" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityId\": \"string\",
\"key\": \"string\"
}"/entities/definitions.batchCreates or updates multiple definitions for a single entity in one transaction.
{
"entityId": "string",
"definitions": [
{
"key": "string",
"kind": "text"
}
]
}{
"ok": true,
"version": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/entities/definitions.batch" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityId\": \"string\",
\"definitions\": [
{
\"key\": \"string\",
\"kind\": \"text\"
}
]
}"/entities/definitions.manageReturns scoped custom field definitions (including inactive tombstones) for administration interfaces.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| entityId | query | Yes | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"key": "string",
"kind": "string",
"configJson": null,
"organizationId": null,
"tenantId": null
}
],
"deletedKeys": [
"string"
],
"version": null
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/entities/definitions.manage?entityId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/entities/definitions.restoreReactivates a previously soft-deleted definition within the current tenant/org scope.
{
"entityId": "string",
"key": "string"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/entities/definitions.restore" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityId\": \"string\",
\"key\": \"string\"
}"/entities/encryptionReturns the encrypted field map for the current tenant/organization scope.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| entityId | query | Yes | any | — |
{
"entityId": "string",
"fields": [
{
"field": "string",
"hashField": null
}
],
"updatedAt": null
}curl -X GET "https://om.opperescala.com/api/entities/encryption?entityId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/entities/encryptionCreates or updates the encryption map for the current tenant/organization scope. Enforces optimistic locking when the caller sends the expected version header.
{
"entityId": "string",
"tenantId": null,
"organizationId": null,
"fields": [
{
"field": "string",
"hashField": null
}
]
}{
"ok": true,
"updatedAt": null
}{
"error": "string",
"code": "string",
"currentUpdatedAt": "string",
"expectedUpdatedAt": "string"
}{
"error": "string",
"code": "organization_selection_invalid"
}curl -X POST "https://om.opperescala.com/api/entities/encryption" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityId\": \"string\",
\"tenantId\": null,
\"organizationId\": null,
\"fields\": [
{
\"field\": \"string\",
\"hashField\": null
}
]
}"/entities/entitiesReturns generated and custom entities scoped to the caller with field counts per entity.
{
"items": [
{
"entityId": "string",
"source": "code",
"label": "string",
"count": 1
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/entities/entities" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/entities/entitiesCreates or updates a tenant/org scoped custom entity definition.
{
"entityId": "string",
"label": "string",
"description": null,
"showInSidebar": false,
"accessRestricted": false
}{
"ok": true,
"item": {
"id": "00000000-0000-4000-8000-000000000000",
"entityId": "string",
"label": "string"
}
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/entities/entities" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityId\": \"string\",
\"label\": \"string\",
\"description\": null,
\"showInSidebar\": false,
\"accessRestricted\": false
}"/entities/entitiesMarks the specified custom entity inactive within the current scope.
{
"entityId": "string"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/entities/entities" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityId\": \"string\"
}"/entities/entity-settingsReturns the tenant-scoped default-restricted policy for new custom entities.
{
"newEntitiesRestrictedByDefault": true,
"updatedAt": null
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/entities/entity-settings" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/entities/entity-settingsSets the tenant-scoped default-restricted policy for new custom entities.
{
"newEntitiesRestrictedByDefault": true
}{
"ok": true,
"newEntitiesRestrictedByDefault": true,
"updatedAt": null
}{
"error": "string"
}{
"error": "string"
}{
"code": "string",
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/entities/entity-settings" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"newEntitiesRestrictedByDefault\": true
}"/entities/recordsReturns paginated records for the supplied entity. Supports custom field filters, exports, and soft-delete toggles.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| entityId | query | Yes | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| search | query | No | any | — |
| searchFields | query | No | any | — |
| withDeleted | query | No | any | — |
| format | query | No | any | — |
| exportScope | query | No | any | — |
| export_scope | query | No | any | — |
| all | query | No | any | — |
| full | query | No | any | — |
{
"items": [
{}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/entities/records?entityId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/entities/recordsCreates a record for the given entity. When `recordId` is omitted or not a UUID the data engine will generate one automatically.
{
"entityId": "string",
"values": {}
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/entities/records" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityId\": \"string\",
\"values\": {}
}"/entities/recordsUpdates an existing record. If the provided recordId is not a UUID the record will be created instead to support optimistic flows.
{
"entityId": "string",
"recordId": "string",
"values": {}
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/entities/records" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityId\": \"string\",
\"recordId\": \"string\",
\"values\": {}
}"/entities/recordsSoft deletes the specified record within the current tenant/org scope.
{
"entityId": "string",
"recordId": "string"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/entities/records" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityId\": \"string\",
\"recordId\": \"string\"
}"/entities/relations/optionsReturns up to 200 option entries for populating relation dropdowns, automatically resolving label fields when omitted. An entityId that matches neither an active custom entity nor a registered ORM entity yields an empty option list.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| entityId | query | Yes | any | — |
| labelField | query | No | any | — |
| q | query | No | any | — |
| ids | query | No | any | — |
| routeContextFields | query | No | any | — |
{
"items": [
{
"value": "string",
"label": "string"
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/entities/relations/options?entityId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/entities/sidebar-entitiesReturns custom entities flagged with `showInSidebar` for the current tenant/org scope.
{
"items": [
{
"entityId": "string",
"label": "string",
"href": "string"
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/entities/sidebar-entities" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/eudr/dashboard/widgets/compliance-overview{
"deadline": {
"date": "2026-12-30",
"daysLeft": 1
},
"statements": {
"total": 1,
"byStatus": {
"key": 1
},
"notReady": 1,
"missingReference": 1
},
"queues": {}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/eudr/dashboard/widgets/compliance-overview" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/eudr/evidence-submissionsReturns a paginated collection of evidence submissions scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| commodity | query | No | any | — |
| status | query | No | any | — |
| supplierEntityId | query | No | any | — |
| statementId | query | No | any | — |
| id | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"supplierEntityId": null,
"supplierSnapshot": null,
"commodity": null,
"productMappingId": null,
"statementId": null,
"originCountry": null,
"geolocation": null,
"quantityKg": null,
"batchNumber": null,
"harvestFrom": null,
"harvestTo": null,
"producerName": null,
"status": null,
"completenessScore": 1,
"missingFields": [
"string"
],
"warnings": [
"string"
],
"notes": null,
"createdAt": null,
"updatedAt": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/eudr/evidence-submissions?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/eudr/evidence-submissionsCreates an EUDR supplier evidence submission for the scoped organization.
{
"supplierEntityId": "00000000-0000-4000-8000-000000000000",
"supplierSnapshot": null,
"commodity": "cattle",
"productMappingId": null,
"statementId": null,
"originCountry": null,
"geolocation": null,
"quantityKg": null,
"batchNumber": null,
"harvestFrom": null,
"harvestTo": null,
"producerName": null,
"notes": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/eudr/evidence-submissions" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"supplierEntityId\": \"00000000-0000-4000-8000-000000000000\",
\"supplierSnapshot\": null,
\"commodity\": \"cattle\",
\"productMappingId\": null,
\"statementId\": null,
\"originCountry\": null,
\"geolocation\": null,
\"quantityKg\": null,
\"batchNumber\": null,
\"harvestFrom\": null,
\"harvestTo\": null,
\"producerName\": null,
\"notes\": null
}"/eudr/evidence-submissionsUpdates an EUDR supplier evidence submission.
{
"id": "00000000-0000-4000-8000-000000000000",
"supplierSnapshot": null,
"productMappingId": null,
"statementId": null,
"originCountry": null,
"geolocation": null,
"quantityKg": null,
"batchNumber": null,
"harvestFrom": null,
"harvestTo": null,
"producerName": null,
"notes": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/eudr/evidence-submissions" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"supplierSnapshot\": null,
\"productMappingId\": null,
\"statementId\": null,
\"originCountry\": null,
\"geolocation\": null,
\"quantityKg\": null,
\"batchNumber\": null,
\"harvestFrom\": null,
\"harvestTo\": null,
\"producerName\": null,
\"notes\": null
}"/eudr/evidence-submissionsDeletes an EUDR supplier evidence submission by id. Request body or query may provide the identifier.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/eudr/evidence-submissions" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/eudr/mitigation-actionsReturns a paginated collection of mitigation actions scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| riskAssessmentId | query | No | any | — |
| status | query | No | any | — |
| actionType | query | No | any | — |
| id | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"riskAssessmentId": null,
"actionType": null,
"title": null,
"description": null,
"status": null,
"dueDate": null,
"completedAt": null,
"notes": null,
"createdAt": null,
"updatedAt": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/eudr/mitigation-actions?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/eudr/mitigation-actionsCreates an EUDR mitigation action for the scoped organization.
{
"riskAssessmentId": "00000000-0000-4000-8000-000000000000",
"title": "string",
"description": null,
"dueDate": null,
"notes": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/eudr/mitigation-actions" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"riskAssessmentId\": \"00000000-0000-4000-8000-000000000000\",
\"title\": \"string\",
\"description\": null,
\"dueDate\": null,
\"notes\": null
}"/eudr/mitigation-actionsUpdates an EUDR mitigation action.
{
"id": "00000000-0000-4000-8000-000000000000",
"description": null,
"dueDate": null,
"notes": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/eudr/mitigation-actions" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"description\": null,
\"dueDate\": null,
\"notes\": null
}"/eudr/mitigation-actionsDeletes an EUDR mitigation action by id. Request body or query may provide the identifier.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/eudr/mitigation-actions" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/eudr/plotsReturns a paginated collection of plots scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| supplierEntityId | query | No | any | — |
| plotType | query | No | any | — |
| isActive | query | No | any | — |
| originCountry | query | No | any | — |
| id | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"supplierEntityId": null,
"supplierSnapshot": null,
"name": null,
"externalId": null,
"originCountry": null,
"plotType": null,
"areaHa": null,
"geometry": null,
"validationWarnings": [
"string"
],
"producerName": null,
"isActive": null,
"createdAt": null,
"updatedAt": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/eudr/plots?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/eudr/plotsCreates an EUDR supplier plot for the scoped organization.
{
"supplierEntityId": "00000000-0000-4000-8000-000000000000",
"supplierSnapshot": null,
"name": "string",
"externalId": null,
"description": null,
"areaHa": null,
"producerName": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/eudr/plots" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"supplierEntityId\": \"00000000-0000-4000-8000-000000000000\",
\"supplierSnapshot\": null,
\"name\": \"string\",
\"externalId\": null,
\"description\": null,
\"areaHa\": null,
\"producerName\": null
}"/eudr/plotsUpdates an EUDR supplier plot.
{
"id": "00000000-0000-4000-8000-000000000000",
"supplierSnapshot": null,
"externalId": null,
"description": null,
"areaHa": null,
"producerName": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/eudr/plots" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"supplierSnapshot\": null,
\"externalId\": null,
\"description\": null,
\"areaHa\": null,
\"producerName\": null
}"/eudr/plotsDeletes an EUDR supplier plot by id. Request body or query may provide the identifier.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/eudr/plots" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/eudr/plots/import{
"supplierEntityId": "00000000-0000-4000-8000-000000000000"
}{
"created": 1,
"failed": [
{
"index": 1,
"name": "string",
"errorKey": "string"
}
]
}{}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/eudr/plots/import" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"supplierEntityId\": \"00000000-0000-4000-8000-000000000000\"
}"/eudr/product-mappingsReturns a paginated collection of product mappings scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| commodity | query | No | any | — |
| productId | query | No | any | — |
| isInScope | query | No | any | — |
| id | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"productId": null,
"productSnapshot": null,
"commodity": null,
"hsCode": null,
"speciesScientificName": null,
"speciesCommonName": null,
"isInScope": null,
"notes": null,
"createdAt": null,
"updatedAt": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/eudr/product-mappings?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/eudr/product-mappingsCreates an EUDR product commodity mapping for the scoped organization.
{
"productId": "00000000-0000-4000-8000-000000000000",
"productSnapshot": null,
"commodity": "cattle",
"hsCode": null,
"speciesScientificName": null,
"speciesCommonName": null,
"notes": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/eudr/product-mappings" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"productId\": \"00000000-0000-4000-8000-000000000000\",
\"productSnapshot\": null,
\"commodity\": \"cattle\",
\"hsCode\": null,
\"speciesScientificName\": null,
\"speciesCommonName\": null,
\"notes\": null
}"/eudr/product-mappingsUpdates an EUDR product commodity mapping.
{
"id": "00000000-0000-4000-8000-000000000000",
"productSnapshot": null,
"hsCode": null,
"speciesScientificName": null,
"speciesCommonName": null,
"notes": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/eudr/product-mappings" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"productSnapshot\": null,
\"hsCode\": null,
\"speciesScientificName\": null,
\"speciesCommonName\": null,
\"notes\": null
}"/eudr/product-mappingsDeletes an EUDR product commodity mapping by id. Request body or query may provide the identifier.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/eudr/product-mappings" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/eudr/product-mappings/suggestions{
"items": [
{
"productId": "00000000-0000-4000-8000-000000000000",
"name": "string",
"sku": null,
"hsCode": "string",
"suggestedCommodity": "cattle"
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/eudr/product-mappings/suggestions" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/eudr/product-mappings/suggestions/apply{}{
"created": 1,
"failed": [
{
"productId": "00000000-0000-4000-8000-000000000000",
"errorKey": "string"
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/eudr/product-mappings/suggestions/apply" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/example-customers-sync/mappings| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| interactionId | query | No | any | — |
| todoId | query | No | any | — |
| limit | query | No | any | — |
| cursor | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"interactionId": "00000000-0000-4000-8000-000000000000",
"todoId": "00000000-0000-4000-8000-000000000000",
"syncStatus": "string",
"lastSyncedAt": null,
"lastError": null,
"sourceUpdatedAt": null,
"createdAt": "string",
"updatedAt": "string",
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"exampleHref": "string",
"interaction": null
}
]
}curl -X GET "https://om.opperescala.com/api/example-customers-sync/mappings?limit=50" \ -H "Accept: application/json"
/example-customers-sync/reconcile{}{
"queued": 1
}curl -X POST "https://om.opperescala.com/api/example-customers-sync/reconcile" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{}"/example/assigneesReturns mock assignee options filtered by the optional `q` query parameter.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| q | query | No | any | — |
{
"items": [
{
"value": "string",
"label": "string"
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/example/assignees" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/example/assigneesEmits a clientBroadcast example todo event with optional recipient filters (user/role/org).
{
"ok": true,
"eventId": "string",
"payload": {}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/example/assignees" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/example/blog/{id}Returns a placeholder blog record containing the provided identifier.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "string",
"method": "GET"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/example/blog/string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/example/blog/{id}Echoes the provided identifier as a placeholder write endpoint.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "string",
"method": "POST"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/example/blog/string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/example/customer-prioritiesReturns a paginated collection of customer priorities in the current tenant scope.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | No | any | — |
| customerId | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"customer_id": "00000000-0000-4000-8000-000000000000",
"priority": "low",
"tenant_id": null,
"organization_id": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/example/customer-priorities?page=1&pageSize=50&sortField=created_at&sortDir=desc" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/example/customer-prioritiesCreates or stores customer priority records for injected CRUD fields.
{
"customerId": "00000000-0000-4000-8000-000000000000",
"priority": "normal"
}{
"id": "00000000-0000-4000-8000-000000000000"
}curl -X POST "https://om.opperescala.com/api/example/customer-priorities" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"customerId\": \"00000000-0000-4000-8000-000000000000\",
\"priority\": \"normal\"
}"/example/customer-prioritiesUpdates customer priority values.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/example/customer-priorities" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/example/customer-prioritiesSoft-deletes a customer priority record.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/example/customer-priorities" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/example/notifications"string"
{
"id": "00000000-0000-4000-8000-000000000000"
}curl -X POST "https://om.opperescala.com/api/example/notifications" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/example/organizationsFetches organization names for the provided identifiers within the current tenant scope.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| ids | query | No | any | — |
{
"items": [
{
"value": "string",
"label": "string"
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/example/organizations" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/example/override-probeReturns a small payload used by integration tests to verify modules.ts API route overrides.
{
"ok": true,
"source": "string",
"route": "string"
}curl -X GET "https://om.opperescala.com/api/example/override-probe" \ -H "Accept: application/json"
/example/qa-events{
"items": [
{
"event": "string",
"payload": {},
"capturedAt": "string"
}
]
}curl -X GET "https://om.opperescala.com/api/example/qa-events" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/example/qa-events{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/example/qa-events" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/example/tagsReturns tag options collected from custom field values and dictionary configuration.
{
"items": [
{
"value": "string",
"label": "string"
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/example/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/example/todosReturns a paginated collection of todos in the current tenant scope.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| title | query | No | any | — |
| notes | query | No | any | — |
| isDone | query | No | any | — |
| withDeleted | query | No | any | — |
| organizationId | query | No | any | — |
| createdFrom | query | No | any | — |
| createdTo | query | No | any | — |
| format | query | No | any | — |
{
"items": [
{
"id": "string",
"title": "string",
"notes": null,
"tenant_id": null,
"organization_id": null,
"updatedAt": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/example/todos?page=1&pageSize=50&sortField=id&sortDir=asc&withDeleted=false" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/example/todosCreates a todo record. Supports additional custom field keys prefixed with `cf_`.
{}{
"id": "00000000-0000-4000-8000-000000000000"
}curl -X POST "https://om.opperescala.com/api/example/todos" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/example/todosUpdates an existing todo record by id. Accepts base fields and optional `cf_` custom fields.
{}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/example/todos" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/example/todosDeletes a todo by id. Provide the identifier in the request body.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/example/todos" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/forms/{id}/analyticsTenant-scoped, PII-safe aggregate analytics across all versions of a form: funnel/completion, daily volume, time-to-complete, per-field response counts (value distributions only for non-sensitive enumerable types), and best-effort draft drop-off. Counts only — never raw answer values.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"formId": "string",
"window": {
"from": null,
"to": null
},
"scan": {
"limit": 1,
"scanned": 1,
"capped": true
},
"funnel": {
"started": 1,
"submitted": 1,
"completionRate": 1,
"byStatus": {
"key": 1
}
},
"volume": [
{
"date": "string",
"started": 1,
"submitted": 1
}
],
"timeToComplete": {
"sampleSize": 1,
"medianSeconds": null,
"averageSeconds": null
},
"fields": [
{
"fieldKey": "string",
"type": "string",
"sensitive": true,
"answered": 1,
"blank": 1
}
],
"dropOff": [
{
"sectionKey": "string",
"count": 1
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/:id/analytics" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/{id}/submissionsPaginated submission listing scoped to the form id.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"items": [
{}
],
"total": 1,
"page": 1,
"pageSize": 1
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/:id/submissions" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/submissions/{submissionId}Returns the current submission state for the admin role. Phase 2b will write a form_access_audit row at this call site.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| submissionId | path | Yes | any | — |
{
"submission": {},
"revision": {},
"decoded_data": {},
"actors": [
{}
],
"formVersion": {}
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/submissions/:submissionId" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/submissions/{submissionId}/actorsAssigns a (user, role) pair as an active actor on the submission. The role MUST be declared on the form version.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| submissionId | path | Yes | any | — |
{
"user_id": "00000000-0000-4000-8000-000000000000",
"role": "string"
}{
"actor": {}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/submissions/:submissionId/actors" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"user_id\": \"00000000-0000-4000-8000-000000000000\",
\"role\": \"string\"
}"/forms/submissions/{submissionId}/actors/{actorId}Revokes the supplied actor row by setting revoked_at.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| submissionId | path | Yes | any | — |
| actorId | path | Yes | any | — |
{
"ok": true
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/forms/submissions/:submissionId/actors/:actorId" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/submissions/{submissionId}/reopenTransitions status from submitted back to reopened so further saves are allowed.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| submissionId | path | Yes | any | — |
{
"submission": {}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/submissions/:submissionId/reopen" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/submissions/{submissionId}/revisionsReturns the append-only revision timeline for an admin viewer.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| submissionId | path | Yes | any | — |
{
"submission": {},
"revisions": [
{}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/submissions/:submissionId/revisions" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/{id}/run/contextReturns the schema + uiSchema for the form's currently published version. Authenticated and scoped to the caller's tenant and organization — anonymous runs go through POST /api/forms/public/start instead.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"form": {
"id": "00000000-0000-4000-8000-000000000000",
"key": "string",
"name": "string",
"defaultLocale": "string",
"supportedLocales": [
"string"
]
},
"formVersion": {
"id": "00000000-0000-4000-8000-000000000000",
"versionNumber": 1,
"schemaHash": "string",
"registryVersion": "string"
},
"schema": {},
"uiSchema": {},
"requiresCustomerAuth": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/:id/run/context" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/{id}/run/submissionsServer-side re-runs the evaluator against the posted answers and asserts the claimed ending is reachable. 422 on mismatch. Authenticated and scoped to the caller's tenant and organization; deprecated in favour of POST /api/forms/public/submissions/:id/submit.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"accepted": true,
"reachedEndingKey": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/:id/run/submissions" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/by-key/{key}/activeReturns the published form version matching the supplied key, sliced to the caller's available roles.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| key | path | Yes | any | — |
{
"form": {
"id": "00000000-0000-4000-8000-000000000000",
"key": "string",
"name": "string",
"defaultLocale": "string",
"supportedLocales": [
"string"
]
},
"formVersion": {
"id": "00000000-0000-4000-8000-000000000000",
"versionNumber": 1,
"schemaHash": "string",
"registryVersion": "string",
"roles": [
"string"
]
},
"schema": {},
"uiSchema": {},
"fieldIndex": {
"key": {
"key": "string",
"type": "string",
"sectionKey": null,
"sensitive": true,
"editableBy": [
"string"
],
"visibleTo": [
"string"
],
"required": true
}
},
"callerRoles": [
"string"
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/by-key/:key/active" \ -H "Accept: application/json"
/forms/form-submissionsStarts a submission for the active version of a form, auto-assigning the starter to the default actor role.
{
"form_key": "string",
"subject_type": "string",
"subject_id": "00000000-0000-4000-8000-000000000000"
}{
"submission": {},
"revision": {},
"decoded_data": {},
"actors": [
{}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/form-submissions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"form_key\": \"string\",
\"subject_type\": \"string\",
\"subject_id\": \"00000000-0000-4000-8000-000000000000\"
}"/forms/form-submissions/{id}Returns the current revision payload sliced to the calling user's active actor role.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"submission": {},
"revision": {},
"decoded_data": {},
"actors": [
{}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/form-submissions/:id" \ -H "Accept: application/json"
/forms/form-submissions/{id}Appends a revision when the supplied base_revision_id matches; rate-limited to FORMS_AUTOSAVE_INTERVAL_MS / 2.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"base_revision_id": "00000000-0000-4000-8000-000000000000",
"patch": {}
}{
"revision": {},
"coalesced": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PATCH "https://om.opperescala.com/api/forms/form-submissions/:id" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"base_revision_id\": \"00000000-0000-4000-8000-000000000000\",
\"patch\": {}
}"/forms/form-submissions/{id}/attachmentsStores an encrypted file for a file-typed field. Caller must be an active actor on the submission.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "string",
"filename": "string",
"contentType": "string",
"sizeBytes": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/form-submissions/:id/attachments" \ -H "Accept: application/json"
/forms/form-submissions/{id}/resume-tokenReturns a signed token that another device can use to resume the submission. TTL governed by FORMS_RESUME_TOKEN_TTL_S.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"token": "string",
"expiresAt": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/form-submissions/:id/resume-token" \ -H "Accept: application/json"
/forms/form-submissions/{id}/submitFinal submission of a draft submission. Verifies base_revision_id and stores the submit metadata.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"base_revision_id": "00000000-0000-4000-8000-000000000000"
}{
"submission": {}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/form-submissions/:id/submit" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"base_revision_id\": \"00000000-0000-4000-8000-000000000000\"
}"/forms/form-submissions/by-subject/{subject_type}/{subject_id}Returns submissions accessible to the caller for the supplied (subject_type, subject_id).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| subject_type | path | Yes | any | — |
| subject_id | path | Yes | any | — |
{
"items": [
{}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/form-submissions/by-subject/:subject_type/:subject_id" \ -H "Accept: application/json"
/forms/{id}/theme-logoStores a brand logo as a public, unscoped attachment and returns its assetId for x-om-theme.logo. Requires forms.design.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"assetId": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/:id/theme-logo" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/public/distributions/{slug}Returns the form context served by an open-mode distribution identified by its public slug.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| slug | path | Yes | any | — |
{
"distribution_id": "00000000-0000-4000-8000-000000000000",
"form": {
"key": "string",
"name": "string",
"defaultLocale": "string",
"supportedLocales": [
"string"
]
},
"schema": {},
"ui_schema": {},
"fieldIndex": {},
"completion": {
"title": null,
"message": null
},
"redirect_url": null,
"embed": null,
"requires_customer_auth": true,
"default_locale": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/public/distributions/:slug" \ -H "Accept: application/json"
/forms/public/distributions/{slug}/embed-policyReturns the Content-Security-Policy frame-ancestors directive authorizing which origins may frame the /embed/:slug host page. Fails closed to frame-ancestors none for non-embeddable or unknown distributions.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| slug | path | Yes | any | — |
{
"frame_ancestors": "string",
"embeddable": true
}"string"
"string"
curl -X GET "https://om.opperescala.com/api/forms/public/distributions/:slug/embed-policy" \ -H "Accept: application/json"
/forms/public/embed-loaderReturns a framework-free JS loader that injects an iframe per [data-om-form] element pointing at /embed/:slug and wires postMessage auto-resize.
"string"
curl -X GET "https://om.opperescala.com/api/forms/public/embed-loader" \ -H "Accept: application/json"
/forms/public/invitations/{token}Returns the form context for a personal-mode invitation identified by its raw token, marking the invitation opened.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| token | path | Yes | any | — |
{
"distribution_id": "00000000-0000-4000-8000-000000000000",
"form": {
"key": "string",
"name": "string",
"defaultLocale": "string",
"supportedLocales": [
"string"
]
},
"schema": {},
"ui_schema": {},
"fieldIndex": {},
"completion": {
"title": null,
"message": null
},
"redirect_url": null,
"requires_customer_auth": true,
"default_locale": "string",
"invitation": {
"id": "00000000-0000-4000-8000-000000000000",
"status": "string",
"locale": null
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/public/invitations/:token" \ -H "Accept: application/json"
/forms/public/startResolves a distribution by slug or token and bootstraps an anonymous submission, returning a submission access token.
{}{
"submission": {},
"revision": {},
"decoded_data": {},
"access_token": "string",
"expires_at": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/public/start" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{}"/forms/public/submissions/{id}Returns the role-sliced current state for the submission named in the access token (or customer session).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"submission": {},
"revision": {},
"decoded_data": {},
"actors": [
{}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/public/submissions/:id" \ -H "Accept: application/json"
/forms/public/submissions/{id}Appends a revision when base_revision_id matches; re-issues the access token (token-authorized requests) with a slid TTL.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"base_revision_id": "00000000-0000-4000-8000-000000000000",
"patch": {}
}{
"revision": {}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PATCH "https://om.opperescala.com/api/forms/public/submissions/:id" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"base_revision_id\": \"00000000-0000-4000-8000-000000000000\",
\"patch\": {}
}"/forms/public/submissions/{id}/attachmentsStores an encrypted file for a file-typed field. Authorized via access token or portal session.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "string",
"filename": "string",
"contentType": "string",
"sizeBytes": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/public/submissions/:id/attachments" \ -H "Accept: application/json"
/forms/public/submissions/{id}/attachments/{attachmentId}Streams the decrypted user-upload bytes for the owning participant. Authorized via access token or portal session.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| attachmentId | path | Yes | any | — |
string
"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/forms/public/submissions/:id/attachments/:attachmentId" \ -H "Accept: application/json"
/forms/public/submissions/{id}/pdfStreams the immutable signed-PDF snapshot for the owning participant. Authorized via access token or portal session. Generates the snapshot on first request when missing.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
string
"string"
"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/forms/public/submissions/:id/pdf" \ -H "Accept: application/json"
/forms/public/submissions/{id}/submitFinalizes the submission named in the access token / session, enforcing the distribution response cap atomically before submitting.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"base_revision_id": "00000000-0000-4000-8000-000000000000"
}{
"submission": {},
"redirect_url": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/public/submissions/:id/submit" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"base_revision_id\": \"00000000-0000-4000-8000-000000000000\"
}"/forms/subjects/{subjectType}/{subjectId}/consentsReturns the subject's consent history projected from signed signature fields — active and superseded records. PII-free: clause SHA-256, signed-at, status timestamps, and ids only. Optional `status` and `formId` query filters. Requires `forms.view`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| subjectType | path | Yes | any | — |
| subjectId | path | Yes | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"formId": "00000000-0000-4000-8000-000000000000",
"formName": null,
"formVersionId": "00000000-0000-4000-8000-000000000000",
"versionNumber": 1,
"submissionId": "00000000-0000-4000-8000-000000000000",
"consentFieldKey": "string",
"clauseSha256": "string",
"signedAt": "string",
"status": "string",
"supersededAt": null,
"supersededByRecordId": null
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/subjects/:subjectType/:subjectId/consents" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/subjects/{subjectType}/{subjectId}/exportReturns a structured JSON document with every submission for the subject — form key/name, version, status, timestamps, decrypted answers keyed by field with labels, and signature metadata. Attachments are referenced by id. Writes one `export` access-audit row per submission. Requires `forms.submissions.export`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| subjectType | path | Yes | any | — |
| subjectId | path | Yes | any | — |
{}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/subjects/:subjectType/:subjectId/export" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/submissions/{submissionId}/access-auditReturns the access-audit trail for a submission (who/when/purpose/IP). Carries no payload content. Reading the list does not write a new audit row.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| submissionId | path | Yes | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"accessedBy": "00000000-0000-4000-8000-000000000000",
"accessedAt": "string",
"accessPurpose": "view",
"ip": null,
"revisionId": null
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/submissions/:submissionId/access-audit" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/submissions/{submissionId}/anonymizeTombstones every sensitive field across every revision. Requires body `{ "confirm": "DELETE" }`. Preserves actor rows and access-audit rows. Emits `forms.submission.anonymized`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| submissionId | path | Yes | any | — |
{
"confirm": "DELETE"
}{
"submissionId": "00000000-0000-4000-8000-000000000000",
"revisionsAnonymized": 1,
"anonymizedAt": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/forms/submissions/:submissionId/anonymize" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"confirm\": \"DELETE\"
}"/forms/submissions/{submissionId}/attachments/{attachmentId}Streams the decrypted user-upload bytes. Writes an access-audit row with access_purpose = "export".
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| submissionId | path | Yes | any | — |
| attachmentId | path | Yes | any | — |
string
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/forms/submissions/:submissionId/attachments/:attachmentId" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/submissions/{submissionId}/exportReturns the structured export document for one submission — decrypted answers keyed by field with labels, signature metadata, attachment references. Writes one `export` access-audit row. Requires `forms.submissions.export`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| submissionId | path | Yes | any | — |
{}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/forms/submissions/:submissionId/export" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/forms/submissions/{submissionId}/pdfStreams the immutable PDF snapshot, generating it on first request when the on-submit job has not produced it yet. Never re-renders an existing snapshot. Writes an audit row with `access_purpose = "export"`.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| submissionId | path | Yes | any | — |
string
"string"
curl -X GET "https://om.opperescala.com/api/forms/submissions/:submissionId/pdf" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/emailsProcessing log of all received emails
"string"
curl -X GET "https://om.opperescala.com/api/inbox_ops/emails" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/emails/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
curl -X GET "https://om.opperescala.com/api/inbox_ops/emails/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/emails/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
curl -X DELETE "https://om.opperescala.com/api/inbox_ops/emails/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/emails/{id}/reprocess| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/inbox_ops/emails/:id/reprocess" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/extractCreates an InboxEmail record from raw text and triggers the extraction pipeline. The extraction runs asynchronously.
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/inbox_ops/extract" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/proposalsList inbox proposals with optional status filter and pagination
"string"
"string"
curl -X GET "https://om.opperescala.com/api/inbox_ops/proposals" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/proposals/{id}Returns proposal with actions, discrepancies, and source email
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
curl -X GET "https://om.opperescala.com/api/inbox_ops/proposals/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/proposals/{id}/accept-all| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
curl -X POST "https://om.opperescala.com/api/inbox_ops/proposals/:id/accept-all" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/proposals/{id}/actions/{actionId}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| actionId | path | Yes | any | — |
"string"
"string"
"string"
curl -X PATCH "https://om.opperescala.com/api/inbox_ops/proposals/:id/actions/:actionId" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/proposals/{id}/actions/{actionId}/acceptExecutes the action and creates the entity in the target module. Returns 409 if already processed.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| actionId | path | Yes | any | — |
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/inbox_ops/proposals/:id/actions/:actionId/accept" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/proposals/{id}/actions/{actionId}/completeUsed when an action is fulfilled through the normal sales form instead of the execution engine. Updates the action status without running the execution engine.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| actionId | path | Yes | any | — |
"string"
"string"
"string"
"string"
curl -X PATCH "https://om.opperescala.com/api/inbox_ops/proposals/:id/actions/:actionId/complete" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/proposals/{id}/actions/{actionId}/reject| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| actionId | path | Yes | any | — |
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/inbox_ops/proposals/:id/actions/:actionId/reject" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/proposals/{id}/categorizeAssigns a category to a proposal. Returns the new and previous category for undo support.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/inbox_ops/proposals/:id/categorize" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/proposals/{id}/reject| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
curl -X POST "https://om.opperescala.com/api/inbox_ops/proposals/:id/reject" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/proposals/{id}/replies/{replyId}/sendSends the draft_reply action payload via the configured email provider. When the messages module is available, also records the sent reply as an internal message record. Sets In-Reply-To and References headers for threading.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
| replyId | path | Yes | any | — |
"string"
"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/inbox_ops/proposals/:id/replies/:replyId/send" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/proposals/{id}/translateTranslates the proposal summary and action descriptions to the target locale. Results are cached.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/inbox_ops/proposals/:id/translate" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/proposals/countsReturns counts by status and by category for tab badges and filter dropdowns
"string"
curl -X GET "https://om.opperescala.com/api/inbox_ops/proposals/counts" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/settingsReturns the forwarding address and configuration for this tenant
"string"
curl -X GET "https://om.opperescala.com/api/inbox_ops/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/settingsUpdates working language and/or active status
"string"
curl -X PATCH "https://om.opperescala.com/api/inbox_ops/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/inbox_ops/webhook/inboundPublic endpoint — validated by provider HMAC signature or Resend/Svix signature. Rate limited per tenant.
{}"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/inbox_ops/webhook/inbound" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{}"/onboarding/demo-feedbackSends a feedback/contact request from the demo environment to the configured admin.
{
"email": "user@example.com",
"message": "",
"termsAccepted": true,
"marketingConsent": false
}"string"
curl -X POST "https://om.opperescala.com/api/onboarding/demo-feedback" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"email\": \"user@example.com\",
\"message\": \"\",
\"termsAccepted\": true,
\"marketingConsent\": false
}"/payment_gateways/cancel"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/payment_gateways/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/payment_gateways/capture"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/payment_gateways/capture" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/payment_gateways/providers"string"
curl -X GET "https://om.opperescala.com/api/payment_gateways/providers" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/payment_gateways/providers/{providerKey}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| providerKey | path | Yes | any | — |
"string"
"string"
curl -X GET "https://om.opperescala.com/api/payment_gateways/providers/:providerKey" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/payment_gateways/refund"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/payment_gateways/refund" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/payment_gateways/sessions"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/payment_gateways/sessions" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/payment_gateways/status"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/payment_gateways/status" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/payment_gateways/status"string"
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/payment_gateways/status" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/payment_gateways/transactions"string"
curl -X GET "https://om.opperescala.com/api/payment_gateways/transactions" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/payment_gateways/transactions/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
"string"
"string"
curl -X GET "https://om.opperescala.com/api/payment_gateways/transactions/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/payment_gateways/webhook/{provider}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| provider | path | Yes | any | — |
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/payment_gateways/webhook/:provider" \ -H "Accept: application/json"
/perspectives/{tableId}Returns personal perspectives and available role defaults for the requested table identifier.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| tableId | path | Yes | any | — |
{
"tableId": "string",
"perspectives": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"tableId": "string",
"settings": {},
"isDefault": true,
"createdAt": "string",
"updatedAt": null
}
],
"defaultPerspectiveId": null,
"rolePerspectives": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"tableId": "string",
"settings": {},
"isDefault": true,
"createdAt": "string",
"updatedAt": null,
"roleId": "00000000-0000-4000-8000-000000000000",
"tenantId": null,
"organizationId": null,
"roleName": null
}
],
"manageableRolePerspectives": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"tableId": "string",
"settings": {},
"isDefault": true,
"createdAt": "string",
"updatedAt": null,
"roleId": "00000000-0000-4000-8000-000000000000",
"tenantId": null,
"organizationId": null,
"roleName": null
}
],
"roles": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"hasPerspective": true,
"hasDefault": true
}
],
"canApplyToRoles": true
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/perspectives/string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/perspectives/{tableId}Saves a personal perspective and optionally applies the same configuration to selected roles.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| tableId | path | Yes | any | — |
{
"name": "string",
"settings": {}
}{
"perspective": {
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"tableId": "string",
"settings": {},
"isDefault": true,
"createdAt": "string",
"updatedAt": null
},
"rolePerspectives": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"tableId": "string",
"settings": {},
"isDefault": true,
"createdAt": "string",
"updatedAt": null,
"roleId": "00000000-0000-4000-8000-000000000000",
"tenantId": null,
"organizationId": null,
"roleName": null
}
],
"clearedRoleIds": [
"00000000-0000-4000-8000-000000000000"
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/perspectives/string" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"name\": \"string\",
\"settings\": {}
}"/perspectives/{tableId}/{perspectiveId}Removes a perspective owned by the current user for the given table.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| tableId | path | Yes | any | — |
| perspectiveId | path | Yes | any | — |
{
"success": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/perspectives/string/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/perspectives/{tableId}/roles/{roleId}Removes all role-level perspectives associated with the provided role identifier for the table.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| tableId | path | Yes | any | — |
| roleId | path | Yes | any | — |
"string"
{
"success": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/perspectives/string/roles/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/phone_calls/callsReturns a paginated collection of phonecalls scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| q | query | No | any | — |
| providerKey | query | No | any | — |
| status | query | No | any | — |
| direction | query | No | any | — |
| startedFrom | query | No | any | — |
| startedTo | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| id | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"organization_id": null,
"tenant_id": null,
"provider_key": null,
"integration_id": null,
"external_call_id": null,
"external_conversation_id": null,
"direction": null,
"status": null,
"started_at": null,
"answered_at": null,
"ended_at": null,
"duration_seconds": null,
"recording_url": null,
"ingest_status": null,
"last_ingested_at": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/phone_calls/calls?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/planner/availabilityReturns a paginated collection of availability rules scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| subjectType | query | No | any | — |
| subjectIds | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": null,
"organization_id": null,
"tenant_id": null,
"subject_type": null,
"subject_id": null,
"timezone": null,
"rrule": null,
"exdates": null,
"kind": null,
"note": null,
"unavailability_reason_entry_id": null,
"unavailability_reason_value": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/planner/availability?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/planner/availabilityCreates an availability rule for the selected subject.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"subjectType": "member",
"subjectId": "00000000-0000-4000-8000-000000000000",
"timezone": "string",
"rrule": "string",
"exdates": [],
"kind": "availability",
"note": null,
"unavailabilityReasonEntryId": null,
"unavailabilityReasonValue": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/planner/availability" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"subjectType\": \"member\",
\"subjectId\": \"00000000-0000-4000-8000-000000000000\",
\"timezone\": \"string\",
\"rrule\": \"string\",
\"exdates\": [],
\"kind\": \"availability\",
\"note\": null,
\"unavailabilityReasonEntryId\": null,
\"unavailabilityReasonValue\": null
}"/planner/availabilityUpdates an availability rule by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"note": null,
"unavailabilityReasonEntryId": null,
"unavailabilityReasonValue": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/planner/availability" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"note\": null,
\"unavailabilityReasonEntryId\": null,
\"unavailabilityReasonValue\": null
}"/planner/availabilityDeletes an availability rule by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/planner/availability" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/planner/availability-date-specificReplaces date-specific availability rules for the subject in a single request.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"subjectType": "member",
"subjectId": "00000000-0000-4000-8000-000000000000",
"timezone": "string",
"windows": [],
"isAvailable": true,
"note": null,
"unavailabilityReasonEntryId": null,
"unavailabilityReasonValue": null
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string",
"code": "string",
"currentUpdatedAt": "string",
"expectedUpdatedAt": "string"
}curl -X POST "https://om.opperescala.com/api/planner/availability-date-specific" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"subjectType\": \"member\",
\"subjectId\": \"00000000-0000-4000-8000-000000000000\",
\"timezone\": \"string\",
\"windows\": [],
\"isAvailable\": true,
\"note\": null,
\"unavailabilityReasonEntryId\": null,
\"unavailabilityReasonValue\": null
}"/planner/availability-rule-setsReturns a paginated collection of availability rule sets scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
| search | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": null,
"organization_id": null,
"tenant_id": null,
"name": null,
"description": null,
"timezone": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/planner/availability-rule-sets?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/planner/availability-rule-setsCreates a reusable availability rule set.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"name": "string",
"description": null,
"timezone": "string"
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/planner/availability-rule-sets" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"name\": \"string\",
\"description\": null,
\"timezone\": \"string\"
}"/planner/availability-rule-setsUpdates an availability rule set by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"description": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/planner/availability-rule-sets" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"description\": null
}"/planner/availability-rule-setsDeletes an availability rule set by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/planner/availability-rule-sets" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/planner/availability-weeklyReplaces weekly availability rules for the subject in a single request.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"subjectType": "member",
"subjectId": "00000000-0000-4000-8000-000000000000",
"timezone": "string",
"windows": []
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string",
"code": "optimistic_lock_conflict",
"currentUpdatedAt": "string",
"expectedUpdatedAt": "string"
}curl -X POST "https://om.opperescala.com/api/planner/availability-weekly" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"subjectType\": \"member\",
\"subjectId\": \"00000000-0000-4000-8000-000000000000\",
\"timezone\": \"string\",
\"windows\": []
}"/push_notifications/deliveriesReturns the tenant's push push deliveries (admin observability).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| status | query | No | any | — |
| userId | query | No | any | — |
| from | query | No | any | — |
| to | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"tenant_id": "00000000-0000-4000-8000-000000000000",
"organization_id": null,
"notification_id": null,
"notification_type_id": "string",
"user_device_id": "00000000-0000-4000-8000-000000000000",
"user_id": "00000000-0000-4000-8000-000000000000",
"provider": "string",
"token_snapshot": "string",
"status": "pending",
"attempts": 1,
"last_error": null,
"created_at": null,
"sent_at": null,
"next_retry_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/push_notifications/deliveries?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/push_notifications/deliveries/{id}Admin: fetch a single push delivery row (payload + provider response; no full push token).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"item": {
"id": "00000000-0000-4000-8000-000000000000",
"tenant_id": "00000000-0000-4000-8000-000000000000",
"organization_id": null,
"notification_id": null,
"notification_type_id": "string",
"user_device_id": "00000000-0000-4000-8000-000000000000",
"user_id": "00000000-0000-4000-8000-000000000000",
"provider": "string",
"token_snapshot": "string",
"status": "pending",
"attempts": 1,
"last_error": null,
"created_at": null,
"sent_at": null,
"next_retry_at": null,
"updated_at": null,
"payload": null,
"provider_response": null
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/push_notifications/deliveries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/query_index/purgeQueues a purge job to remove indexed records for an entity type within the active scope.
{
"entityType": "string"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/query_index/purge" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityType\": \"string\"
}"/query_index/reindexQueues a reindex job for the specified entity type within the current tenant scope.
{
"entityType": "string"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/query_index/reindex" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"entityType\": \"string\"
}"/query_index/statusReturns entity counts comparing base tables with the query index along with the latest job status.
{
"items": [
{
"entityId": "string",
"label": "string",
"baseCount": null,
"indexCount": null,
"vectorCount": null,
"fulltextCount": null,
"ok": true,
"job": {
"status": "idle",
"startedAt": null,
"finishedAt": null,
"heartbeatAt": null,
"processedCount": null,
"totalCount": null,
"scope": null
},
"refreshedAt": null
}
],
"errors": [
{
"id": "string",
"source": "string",
"handler": "string",
"entityType": null,
"recordId": null,
"tenantId": null,
"organizationId": null,
"message": "string",
"stack": null,
"payload": null,
"occurredAt": "string"
}
],
"logs": [
{
"id": "string",
"source": "string",
"handler": "string",
"level": "info",
"entityType": null,
"recordId": null,
"tenantId": null,
"organizationId": null,
"message": "string",
"details": null,
"occurredAt": "string"
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/query_index/status" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/ratelimit_probe/ping{
"ok": true
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/ratelimit_probe/ping" \ -H "Accept: application/json"
/resources/activitiesReturns a paginated collection of resourceactivitys scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| entityId | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"resource_id": null,
"activity_type": null,
"subject": null,
"body": null,
"occurred_at": null,
"author_user_id": null,
"appearance_icon": null,
"appearance_color": null,
"organization_id": null,
"tenant_id": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/resources/activities?page=1&pageSize=50" \ -H "Accept: application/json"
/resources/activitiesAdds an activity to a resource timeline.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"entityId": "00000000-0000-4000-8000-000000000000",
"activityType": "string",
"appearanceIcon": null,
"appearanceColor": null
}{
"id": null,
"authorUserId": null
}curl -X POST "https://om.opperescala.com/api/resources/activities" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"entityId\": \"00000000-0000-4000-8000-000000000000\",
\"activityType\": \"string\",
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/resources/activitiesUpdates a resource activity.
{
"id": "00000000-0000-4000-8000-000000000000",
"appearanceIcon": null,
"appearanceColor": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/resources/activities" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/resources/activitiesDeletes a resource activity.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/resources/activities" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/resources/commentsReturns a paginated collection of resourcecomments scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| entityId | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"resource_id": null,
"body": null,
"author_user_id": null,
"appearance_icon": null,
"appearance_color": null,
"organization_id": null,
"tenant_id": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/resources/comments?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/resources/commentsAdds a note to a resource timeline.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"entityId": "00000000-0000-4000-8000-000000000000",
"body": "string",
"appearanceIcon": null,
"appearanceColor": null
}{
"id": null,
"authorUserId": null
}curl -X POST "https://om.opperescala.com/api/resources/comments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"entityId\": \"00000000-0000-4000-8000-000000000000\",
\"body\": \"string\",
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/resources/commentsUpdates a resource note.
{
"id": "00000000-0000-4000-8000-000000000000",
"appearanceIcon": null,
"appearanceColor": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/resources/comments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/resources/commentsDeletes a resource note.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/resources/comments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/resources/resource-typesReturns a paginated collection of resource types scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| withResourceCounts | query | No | any | — |
{
"items": [
{
"id": null,
"organization_id": null,
"tenant_id": null,
"name": null,
"description": null,
"appearance_icon": null,
"appearance_color": null,
"created_at": null,
"updated_at": null,
"resourceCount": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/resources/resource-types?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/resources/resource-typesCreates a resource type for resources resources.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"name": "string",
"description": null,
"appearanceIcon": null,
"appearanceColor": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/resources/resource-types" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"name\": \"string\",
\"description\": null,
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/resources/resource-typesUpdates a resource type by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"description": null,
"appearanceIcon": null,
"appearanceColor": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/resources/resource-types" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"description\": null,
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/resources/resource-typesDeletes a resource type by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/resources/resource-types" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/resources/resourcesReturns a paginated collection of resources scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
| resourceTypeId | query | No | any | — |
| isActive | query | No | any | — |
| tagIds | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": null,
"organization_id": null,
"tenant_id": null,
"name": null,
"description": null,
"resource_type_id": null,
"capacity": null,
"capacity_unit_value": null,
"capacity_unit_name": null,
"capacity_unit_color": null,
"capacity_unit_icon": null,
"appearance_icon": null,
"appearance_color": null,
"is_active": null,
"availability_rule_set_id": null,
"custom_fieldset_code": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/resources/resources?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/resources/resourcesCreates a resource scoped to the selected organization.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"name": "string",
"description": null,
"resourceTypeId": null,
"capacity": null,
"capacityUnitValue": null,
"appearanceIcon": null,
"appearanceColor": null,
"availabilityRuleSetId": null,
"customFieldsetCode": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/resources/resources" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"name\": \"string\",
\"description\": null,
\"resourceTypeId\": null,
\"capacity\": null,
\"capacityUnitValue\": null,
\"appearanceIcon\": null,
\"appearanceColor\": null,
\"availabilityRuleSetId\": null,
\"customFieldsetCode\": null
}"/resources/resourcesUpdates a resource by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"description": null,
"resourceTypeId": null,
"capacity": null,
"capacityUnitValue": null,
"appearanceIcon": null,
"appearanceColor": null,
"availabilityRuleSetId": null,
"customFieldsetCode": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/resources/resources" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"description\": null,
\"resourceTypeId\": null,
\"capacity\": null,
\"capacityUnitValue\": null,
\"appearanceIcon\": null,
\"appearanceColor\": null,
\"availabilityRuleSetId\": null,
\"customFieldsetCode\": null
}"/resources/resourcesDeletes a resource by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/resources/resources" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/resources/resources/tags/assignAssigns a tag to a resources resource.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"tagId": "00000000-0000-4000-8000-000000000000",
"resourceId": "00000000-0000-4000-8000-000000000000"
}{
"id": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/resources/resources/tags/assign" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tagId\": \"00000000-0000-4000-8000-000000000000\",
\"resourceId\": \"00000000-0000-4000-8000-000000000000\"
}"/resources/resources/tags/unassignRemoves a tag from a resources resource.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"tagId": "00000000-0000-4000-8000-000000000000",
"resourceId": "00000000-0000-4000-8000-000000000000"
}{
"id": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/resources/resources/tags/unassign" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tagId\": \"00000000-0000-4000-8000-000000000000\",
\"resourceId\": \"00000000-0000-4000-8000-000000000000\"
}"/resources/tagsReturns a paginated collection of resource tags scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": null,
"slug": null,
"label": null,
"color": null,
"description": null,
"organization_id": null,
"tenant_id": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/resources/tags?page=1&pageSize=100" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/resources/tagsCreates a tag for resources resources and services.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"label": "string",
"color": null,
"description": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/resources/tags" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"label\": \"string\",
\"color\": null,
\"description\": null
}"/sales/adjustment-kindsReturns a paginated collection of sales adjustment kinds that belong to the current organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"value": "string",
"label": null,
"color": null,
"icon": null,
"organizationId": null,
"tenantId": null,
"createdAt": "string",
"updatedAt": "string"
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/sales/adjustment-kinds?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sales/adjustment-kindsCreates an adjustment kind.
{}{
"id": null
}curl -X POST "https://om.opperescala.com/api/sales/adjustment-kinds" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/sales/adjustment-kindsUpdates an adjustment kind.
{}{
"id": "00000000-0000-4000-8000-000000000000"
}curl -X PUT "https://om.opperescala.com/api/sales/adjustment-kinds" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/sales/adjustment-kindsDeletes an adjustment kind.
{}{
"id": "00000000-0000-4000-8000-000000000000"
}curl -X DELETE "https://om.opperescala.com/api/sales/adjustment-kinds" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{}"/sales/channelsManage sales channels to segment orders and pricing across marketplaces or stores.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| id | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
| isActive | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| withDeleted | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"code": null,
"description": null,
"statusEntryId": null,
"isActive": true,
"organizationId": null,
"tenantId": null,
"createdAt": "string",
"updatedAt": "string"
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/sales/channels?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sales/channelsCreates a new sales channel.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"name": "string",
"code": "string"
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/sales/channels" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"name\": \"string\",
\"code\": \"string\"
}"/sales/channelsUpdates an existing sales channel by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"code": "string"
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/sales/channels" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"code\": \"string\"
}"/sales/channelsDeletes a sales channel identified by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/sales/channels" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/sales/credit-memosReturns a paginated collection of creditmemos that belong to the current organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| id | query | No | any | — |
| orderId | query | No | any | — |
| invoiceId | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"creditMemoNumber": "string",
"status": null,
"reason": null,
"issueDate": null,
"currencyCode": "string"
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/sales/credit-memos?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sales/credit-memosCreate a new credit memo
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"currencyCode": "string"
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/sales/credit-memos" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"currencyCode\": \"string\"
}"/sales/credit-memosUpdate a credit memo
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"creditMemoId": "00000000-0000-4000-8000-000000000000"
}curl -X PUT "https://om.opperescala.com/api/sales/credit-memos" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/sales/credit-memosDelete a credit memo
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"creditMemoId": "00000000-0000-4000-8000-000000000000"
}curl -X DELETE "https://om.opperescala.com/api/sales/credit-memos" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/sales/dashboard/widgets/new-ordersFetches recently created sales orders for the dashboard widget with a configurable date period.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| limit | query | No | any | — |
| datePeriod | query | No | any | — |
| customFrom | query | No | any | — |
| customTo | query | No | any | — |
| tenantId | query | No | any | — |
| organizationId | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"orderNumber": "string",
"status": null,
"fulfillmentStatus": null,
"paymentStatus": null,
"customerName": null,
"customerEntityId": null,
"netAmount": "string",
"grossAmount": "string",
"currency": null,
"createdAt": "string"
}
],
"total": 1,
"dateRange": {
"from": "string",
"to": "string"
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/sales/dashboard/widgets/new-orders?limit=5&datePeriod=last24h" \ -H "Accept: application/json"
/sales/dashboard/widgets/new-quotesFetches recently created sales quotes for the dashboard widget with a configurable date period.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| limit | query | No | any | — |
| datePeriod | query | No | any | — |
| customFrom | query | No | any | — |
| customTo | query | No | any | — |
| tenantId | query | No | any | — |
| organizationId | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"quoteNumber": "string",
"status": null,
"customerName": null,
"customerEntityId": null,
"validFrom": null,
"validUntil": null,
"netAmount": "string",
"grossAmount": "string",
"currency": null,
"createdAt": "string",
"convertedOrderId": null
}
],
"total": 1,
"dateRange": {
"from": "string",
"to": "string"
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/sales/dashboard/widgets/new-quotes?limit=5&datePeriod=last24h" \ -H "Accept: application/json"
/sales/delivery-windowsDefine delivery windows to communicate lead times and cut-off rules for sales orders.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| isActive | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| withDeleted | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"code": null,
"description": null,
"leadTimeDays": null,
"cutoffTime": null,
"timezone": null,
"isActive": true,
"metadata": null,
"organizationId": null,
"tenantId": null,
"createdAt": "string",
"updatedAt": "string"
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/sales/delivery-windows?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sales/delivery-windowsCreates a new delivery window.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"name": "string",
"code": "string"
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/sales/delivery-windows" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"name\": \"string\",
\"code\": \"string\"
}"/sales/delivery-windowsUpdates an existing delivery window by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/sales/delivery-windows" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/sales/delivery-windowsDeletes a delivery window identified by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/sales/delivery-windows" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/sales/document-addressesReturns a paginated collection of document addresss that belong to the current organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| documentId | query | Yes | any | — |
| documentKind | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"document_id": "00000000-0000-4000-8000-000000000000",
"document_kind": "order",
"customer_address_id": null,
"name": null,
"purpose": null,
"company_name": null,
"address_line1": "string",
"address_line2": null,
"building_number": null,
"flat_number": null,
"city": null,
"region": null,
"postal_code": null,
"country": null,
"latitude": null,
"longitude": null,
"created_at": "string",
"updated_at": "string"
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/sales/document-addresses?page=1&pageSize=50&documentId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/sales/document-addressesCreates a sales document address linked to an order or quote.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"documentId": "00000000-0000-4000-8000-000000000000",
"documentKind": "order",
"name": null,
"purpose": null,
"companyName": null,
"addressLine1": "string",
"addressLine2": null,
"city": null,
"region": null,
"postalCode": null,
"country": null,
"buildingNumber": null,
"flatNumber": null,
"latitude": null,
"longitude": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/sales/document-addresses" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"documentId\": \"00000000-0000-4000-8000-000000000000\",
\"documentKind\": \"order\",
\"name\": null,
\"purpose\": null,
\"companyName\": null,
\"addressLine1\": \"string\",
\"addressLine2\": null,
\"city\": null,
\"region\": null,
\"postalCode\": null,
\"country\": null,
\"buildingNumber\": null,
\"flatNumber\": null,
\"latitude\": null,
\"longitude\": null
}"/shipping-carriers/cancel"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/shipping-carriers/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/shipping-carriers/points"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/shipping-carriers/points" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/shipping-carriers/providers"string"
curl -X GET "https://om.opperescala.com/api/shipping-carriers/providers" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/shipping-carriers/rates"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/shipping-carriers/rates" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/shipping-carriers/shipments"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/shipping-carriers/shipments" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/shipping-carriers/tracking"string"
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/shipping-carriers/tracking" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/shipping-carriers/tracking/refresh"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/shipping-carriers/tracking/refresh" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/shipping-carriers/webhook/{provider}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| provider | path | Yes | any | — |
"string"
"string"
"string"
"string"
curl -X POST "https://om.opperescala.com/api/shipping-carriers/webhook/:provider" \ -H "Accept: application/json"
/staff/activitiesReturns a paginated collection of teammemberactivitys scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| entityId | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"member_id": null,
"activity_type": null,
"subject": null,
"body": null,
"occurred_at": null,
"author_user_id": null,
"appearance_icon": null,
"appearance_color": null,
"organization_id": null,
"tenant_id": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/staff/activities?page=1&pageSize=50" \ -H "Accept: application/json"
/staff/activitiesAdds an activity to a team member timeline.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"entityId": "00000000-0000-4000-8000-000000000000",
"activityType": "string",
"appearanceIcon": null,
"appearanceColor": null
}{
"id": null,
"authorUserId": null
}curl -X POST "https://om.opperescala.com/api/staff/activities" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"entityId\": \"00000000-0000-4000-8000-000000000000\",
\"activityType\": \"string\",
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/staff/activitiesUpdates a team member activity.
{
"id": "00000000-0000-4000-8000-000000000000",
"appearanceIcon": null,
"appearanceColor": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/staff/activities" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/staff/activitiesDeletes a team member activity.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/staff/activities" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/staff/addressesReturns a paginated collection of teammemberaddresss scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| entityId | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"member_id": null,
"name": null,
"purpose": null,
"company_name": null,
"address_line1": null,
"address_line2": null,
"building_number": null,
"flat_number": null,
"city": null,
"region": null,
"postal_code": null,
"country": null,
"latitude": null,
"longitude": null,
"is_primary": null,
"organization_id": null,
"tenant_id": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/staff/addresses?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/staff/addressesAdds a team member address.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"entityId": "00000000-0000-4000-8000-000000000000",
"addressLine1": "string"
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/staff/addresses" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"entityId\": \"00000000-0000-4000-8000-000000000000\",
\"addressLine1\": \"string\"
}"/staff/addressesUpdates a team member address.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/staff/addresses" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/staff/addressesDeletes a team member address.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/staff/addresses" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/staff/commentsReturns a paginated collection of teammembercomments scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| entityId | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"member_id": null,
"body": null,
"author_user_id": null,
"appearance_icon": null,
"appearance_color": null,
"organization_id": null,
"tenant_id": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/staff/comments?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/staff/commentsAdds a note to a team member timeline.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"entityId": "00000000-0000-4000-8000-000000000000",
"body": "string",
"appearanceIcon": null,
"appearanceColor": null
}{
"id": null,
"authorUserId": null
}curl -X POST "https://om.opperescala.com/api/staff/comments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"entityId\": \"00000000-0000-4000-8000-000000000000\",
\"body\": \"string\",
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/staff/commentsUpdates a team member note.
{
"id": "00000000-0000-4000-8000-000000000000",
"appearanceIcon": null,
"appearanceColor": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/staff/comments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"appearanceIcon\": null,
\"appearanceColor\": null
}"/staff/commentsDeletes a team member note.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/staff/comments" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/staff/job-historiesReturns a paginated collection of teammemberjobhistorys scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| entityId | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"member_id": null,
"name": null,
"company_name": null,
"description": null,
"start_date": null,
"end_date": null,
"organization_id": null,
"tenant_id": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/staff/job-histories?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/staff/job-historiesAdds a team member job history entry.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"entityId": "00000000-0000-4000-8000-000000000000",
"name": "string",
"companyName": null,
"description": null,
"startDate": "2025-01-01T00:00:00.000Z",
"endDate": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/staff/job-histories" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"entityId\": \"00000000-0000-4000-8000-000000000000\",
\"name\": \"string\",
\"companyName\": null,
\"description\": null,
\"startDate\": \"2025-01-01T00:00:00.000Z\",
\"endDate\": null
}"/staff/job-historiesUpdates a team member job history entry.
{
"id": "00000000-0000-4000-8000-000000000000",
"companyName": null,
"description": null,
"endDate": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/staff/job-histories" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"companyName\": null,
\"description\": null,
\"endDate\": null
}"/staff/job-historiesDeletes a team member job history entry.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/staff/job-histories" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/staff/leave-requestsReturns a paginated collection of leave requests scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| status | query | No | any | — |
| memberId | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": null,
"organization_id": null,
"tenant_id": null,
"member_id": null,
"start_date": null,
"end_date": null,
"timezone": null,
"status": null,
"unavailability_reason_entry_id": null,
"unavailability_reason_value": null,
"note": null,
"decision_comment": null,
"submitted_by_user_id": null,
"decided_by_user_id": null,
"decided_at": null,
"created_at": null,
"updated_at": null,
"member": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/staff/leave-requests?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/staff/leave-requestsCreates a leave request for a staff member.
{
"tenantId": "00000000-0000-4000-8000-000000000000",
"organizationId": "00000000-0000-4000-8000-000000000000",
"memberId": "00000000-0000-4000-8000-000000000000",
"timezone": "string",
"startDate": "2025-01-01T00:00:00.000Z",
"endDate": "2025-01-01T00:00:00.000Z",
"unavailabilityReasonEntryId": null,
"unavailabilityReasonValue": null,
"note": null,
"submittedByUserId": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/staff/leave-requests" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"memberId\": \"00000000-0000-4000-8000-000000000000\",
\"timezone\": \"string\",
\"startDate\": \"2025-01-01T00:00:00.000Z\",
\"endDate\": \"2025-01-01T00:00:00.000Z\",
\"unavailabilityReasonEntryId\": null,
\"unavailabilityReasonValue\": null,
\"note\": null,
\"submittedByUserId\": null
}"/staff/leave-requestsUpdates a leave request by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"unavailabilityReasonEntryId": null,
"unavailabilityReasonValue": null,
"note": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/staff/leave-requests" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"unavailabilityReasonEntryId\": null,
\"unavailabilityReasonValue\": null,
\"note\": null
}"/staff/leave-requestsDeletes a leave request by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/staff/leave-requests" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/staff/portal/time-reportsReturns the closed, non-deleted `staff_time_reports` rows whose `customer_id` matches the portal session’s own customer entity, inside that session’s tenant and organization. Draft reports are never listed. The response carries hours only — no rate, cost, amount or currency — because `staff.timesheets.rates.view` is a staff feature a portal identity cannot hold.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"reference": "string",
"title": "string",
"periodFrom": "string",
"periodTo": "string",
"closedAt": null,
"totalBillableMinutes": 1,
"totalNonbillableMinutes": 1
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/staff/portal/time-reports?page=1&pageSize=20" \ -H "Accept: application/json"
/staff/portal/time-reports/{id}Loads the report by id **together with** the tenant, organization, customer and closed-status predicates, so a report belonging to another customer of the same organization answers 404. Returns the frozen minute totals per project; no rate, cost, amount or currency is present in the response.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"id": "00000000-0000-4000-8000-000000000000",
"reference": "string",
"title": "string",
"periodFrom": "string",
"periodTo": "string",
"closedAt": null,
"totalBillableMinutes": 1,
"totalNonbillableMinutes": 1,
"projects": [
{
"timeProjectId": null,
"projectName": null,
"billableMinutes": 1,
"nonbillableMinutes": 1
}
]
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}{
"ok": false,
"error": "string"
}curl -X GET "https://om.opperescala.com/api/staff/portal/time-reports/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/translations/{entityType}/{entityId}Returns the full translation record for a single entity.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| entityType | path | Yes | any | — |
| entityId | path | Yes | any | — |
"string"
"string"
"string"
curl -X GET "https://om.opperescala.com/api/translations/string/string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/translations/{entityType}/{entityId}Full replacement of translations JSONB for an entity.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| entityType | path | Yes | any | — |
| entityId | path | Yes | any | — |
"string"
"string"
"string"
curl -X PUT "https://om.opperescala.com/api/translations/string/string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/translations/{entityType}/{entityId}Removes all translations for an entity.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| entityType | path | Yes | any | — |
| entityId | path | Yes | any | — |
No response body.
"string"
curl -X DELETE "https://om.opperescala.com/api/translations/string/string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/warranty_claimsReturns a paginated collection of warrantyclaims scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | No | any | — |
| status | query | No | any | — |
| status[] | query | No | any | — |
| claimType | query | No | any | — |
| channel | query | No | any | — |
| priority | query | No | any | — |
| customerId | query | No | any | — |
| orderId | query | No | any | — |
| sourceClaimId | query | No | any | — |
| assigneeUserId | query | No | any | — |
| unassignedOnly | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
| search | query | No | any | — |
| overdueOnly | query | No | any | — |
| slaAtRiskOnly | query | No | any | — |
| needsAttention | query | No | any | — |
| attentionOnly | query | No | any | — |
| submittedFrom | query | No | any | — |
| submittedTo | query | No | any | — |
| createdFrom | query | No | any | — |
| createdTo | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": null,
"claimNumber": null,
"claimType": null,
"status": null,
"channel": null,
"priority": null,
"customerId": null,
"customerName": null,
"orderId": null,
"orderNumber": null,
"awaitingStaffReply": true,
"assigneeUserId": null,
"assigneeName": null,
"totalClaimedAmount": null,
"totalApprovedAmount": null,
"totalRecoveredAmount": null,
"slaDueAt": null,
"slaPausedAt": null,
"createdAt": null,
"updatedAt": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/warranty_claims?page=1&pageSize=20" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/warranty_claimsCreates a warranty, return, core-return, or vendor-recovery claim.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"claimType": "warranty",
"customerId": null,
"customerName": null,
"externalRef": null,
"intakeMessageRef": null,
"contactEmail": null,
"vendorName": null,
"vendorRef": null,
"orderId": null,
"orderNumber": null,
"salesReturnId": null,
"replacementOrderId": null,
"advanceShippedAt": null,
"reasonCode": null,
"rejectionReasonCode": null,
"resolutionSummary": null,
"notes": null,
"currencyCode": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/warranty_claims" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"claimType\": \"warranty\",
\"customerId\": null,
\"customerName\": null,
\"externalRef\": null,
\"intakeMessageRef\": null,
\"contactEmail\": null,
\"vendorName\": null,
\"vendorRef\": null,
\"orderId\": null,
\"orderNumber\": null,
\"salesReturnId\": null,
\"replacementOrderId\": null,
\"advanceShippedAt\": null,
\"reasonCode\": null,
\"rejectionReasonCode\": null,
\"resolutionSummary\": null,
\"notes\": null,
\"currencyCode\": null
}"/warranty_claimsUpdates editable claim header fields for the current claim status.
{
"id": "00000000-0000-4000-8000-000000000000",
"customerId": null,
"customerName": null,
"orderId": null,
"reasonCode": null,
"notes": null,
"replacementOrderId": null,
"advanceShippedAt": null,
"salesReturnId": null,
"creditMemoId": null,
"vendorName": null,
"vendorRef": null,
"resolutionSummary": null
}{
"ok": true,
"id": null
}curl -X PUT "https://om.opperescala.com/api/warranty_claims" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"customerId\": null,
\"customerName\": null,
\"orderId\": null,
\"reasonCode\": null,
\"notes\": null,
\"replacementOrderId\": null,
\"advanceShippedAt\": null,
\"salesReturnId\": null,
\"creditMemoId\": null,
\"vendorName\": null,
\"vendorRef\": null,
\"resolutionSummary\": null
}"/warranty_claimsSoft-deletes a draft or cancelled claim.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/warranty_claims" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/warranty_claims/ai/assess{
"claimId": "00000000-0000-4000-8000-000000000000",
"attachmentId": "00000000-0000-4000-8000-000000000000",
"kind": "damage",
"updatedAt": null
}{
"status": "ok"
}curl -X POST "https://om.opperescala.com/api/warranty_claims/ai/assess" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"claimId\": \"00000000-0000-4000-8000-000000000000\",
\"attachmentId\": \"00000000-0000-4000-8000-000000000000\",
\"kind\": \"damage\",
\"updatedAt\": null
}"/warranty_claims/ai/draft-reply{
"claimId": "00000000-0000-4000-8000-000000000000"
}{
"ok": true,
"draft": "string"
}{
"ok": false,
"notConfigured": true,
"error": "string"
}curl -X POST "https://om.opperescala.com/api/warranty_claims/ai/draft-reply" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"claimId\": \"00000000-0000-4000-8000-000000000000\"
}"/warranty_claims/ai/suggest| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| claimId | query | Yes | any | — |
{
"claim": {
"id": "00000000-0000-4000-8000-000000000000",
"claimNumber": "string",
"claimType": "warranty",
"status": "string",
"customerName": null,
"submittedAt": null,
"slaDueAt": null
},
"eligibility": {
"status": "fast_track_candidate",
"reason": {
"messageKey": "string"
}
},
"priority": {
"currentPriority": "low",
"suggestedPriority": "low",
"ageHours": null,
"slaDueAt": null,
"overdue": true,
"reason": {
"messageKey": "string"
}
},
"lines": [
{
"lineId": "00000000-0000-4000-8000-000000000000",
"lineNo": 1,
"sku": null,
"productName": null,
"serialNumber": null,
"qtyClaimed": 1,
"eligibility": {
"status": "in_warranty",
"purchaseDate": null,
"warrantyMonths": null,
"warrantyExpiresAt": null,
"reason": {
"messageKey": "string"
}
},
"suggestedDisposition": "restock",
"suggestedPath": "replace",
"reason": {
"messageKey": "string"
},
"restockingFeePercent": null
}
],
"risk": {
"level": "none",
"signals": [
{
"id": "duplicate_serial",
"level": "low",
"messageKey": "string"
}
]
},
"generatedAt": "string"
}curl -X GET "https://om.opperescala.com/api/warranty_claims/ai/suggest?claimId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/warranty_claims/ai/suggest{
"claimId": "00000000-0000-4000-8000-000000000000"
}{
"claim": {
"id": "00000000-0000-4000-8000-000000000000",
"claimNumber": "string",
"claimType": "warranty",
"status": "string",
"customerName": null,
"submittedAt": null,
"slaDueAt": null
},
"eligibility": {
"status": "fast_track_candidate",
"reason": {
"messageKey": "string"
}
},
"priority": {
"currentPriority": "low",
"suggestedPriority": "low",
"ageHours": null,
"slaDueAt": null,
"overdue": true,
"reason": {
"messageKey": "string"
}
},
"lines": [
{
"lineId": "00000000-0000-4000-8000-000000000000",
"lineNo": 1,
"sku": null,
"productName": null,
"serialNumber": null,
"qtyClaimed": 1,
"eligibility": {
"status": "in_warranty",
"purchaseDate": null,
"warrantyMonths": null,
"warrantyExpiresAt": null,
"reason": {
"messageKey": "string"
}
},
"suggestedDisposition": "restock",
"suggestedPath": "replace",
"reason": {
"messageKey": "string"
},
"restockingFeePercent": null
}
],
"risk": {
"level": "none",
"signals": [
{
"id": "duplicate_serial",
"level": "low",
"messageKey": "string"
}
]
},
"generatedAt": "string"
}curl -X POST "https://om.opperescala.com/api/warranty_claims/ai/suggest" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"claimId\": \"00000000-0000-4000-8000-000000000000\"
}"/warranty_claims/assign{
"id": "00000000-0000-4000-8000-000000000000",
"assigneeUserId": null
}{
"ok": true,
"claimId": "00000000-0000-4000-8000-000000000000"
}curl -X POST "https://om.opperescala.com/api/warranty_claims/assign" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"assigneeUserId\": null
}"/warranty_claims/assigneesResolves up to 100 explicitly supplied user ids to their display name, scoped to the caller's tenant and selected or visible organizations. Requires `ids`; it cannot enumerate the user directory, and it returns neither role assignments nor organization membership.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| ids | query | Yes | any | — |
{
"items": [
{
"id": "string",
"name": null
}
]
}curl -X GET "https://om.opperescala.com/api/warranty_claims/assignees?ids=string" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/warranty_claims/credit-memoAmounts are prorated from source order-line totals. Version 1 does not prorate order-level adjustments.
{
"claimId": "00000000-0000-4000-8000-000000000000",
"updatedAt": null
}{
"creditMemoId": "00000000-0000-4000-8000-000000000000",
"skippedLineIds": [
"00000000-0000-4000-8000-000000000000"
],
"grandTotalGrossAmount": "string",
"currencyCode": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/warranty_claims/credit-memo" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"claimId\": \"00000000-0000-4000-8000-000000000000\",
\"updatedAt\": null
}"/warranty_claims/entitlement| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| serialNumber | query | No | any | — |
| orderId | query | No | any | — |
| productId | query | No | any | — |
| variantId | query | No | any | — |
| sku | query | No | any | — |
| purchaseDate | query | No | any | — |
| excludeClaimId | query | No | any | — |
{
"warrantyStatus": "in_warranty",
"coverageType": null,
"expiresAt": null,
"source": null
}curl -X GET "https://om.opperescala.com/api/warranty_claims/entitlement" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/warranty_claims/events| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| claimId | query | Yes | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"claimId": null,
"kind": "string",
"visibility": "string",
"body": null,
"payload": null,
"actorUserId": null,
"actorCustomerId": null,
"createdAt": null
}
]
}curl -X GET "https://om.opperescala.com/api/warranty_claims/events?claimId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/warranty_claims/events{
"claimId": "00000000-0000-4000-8000-000000000000",
"body": "string",
"visibility": "internal"
}{
"ok": true,
"claimId": "00000000-0000-4000-8000-000000000000"
}curl -X POST "https://om.opperescala.com/api/warranty_claims/events" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"claimId\": \"00000000-0000-4000-8000-000000000000\",
\"body\": \"string\",
\"visibility\": \"internal\"
}"/warranty_claims/linesReturns a paginated collection of warrantyclaimlines scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| claimId | query | Yes | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": null,
"claimId": null,
"lineNo": null,
"sku": null,
"productName": null,
"lineStatus": null,
"qtyClaimed": null,
"qtyApproved": null,
"creditAmount": null,
"createdAt": null,
"updatedAt": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/warranty_claims/lines?claimId=00000000-0000-4000-8000-000000000000&page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/warranty_claims/linesCreates a line on a warranty claim and recomputes claim totals.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"claimId": "00000000-0000-4000-8000-000000000000",
"productId": null,
"variantId": null,
"sku": null,
"productName": null,
"orderLineId": null,
"serialNumber": null,
"lotNumber": null,
"purchaseDate": null,
"warrantyMonths": null,
"warrantyExpiresAt": null,
"faultCode": null,
"faultDescription": null,
"qtyApproved": null,
"qtyReceived": null,
"conditionOnReceipt": null,
"inspectionNotes": null,
"disposition": null,
"creditAmount": null,
"restockingFee": null,
"coreChargeAmount": null,
"coreCreditAmount": null,
"vendorName": null,
"conditionGrade": null,
"assessmentPayload": null
}{
"id": null,
"claimId": null
}curl -X POST "https://om.opperescala.com/api/warranty_claims/lines" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"claimId\": \"00000000-0000-4000-8000-000000000000\",
\"productId\": null,
\"variantId\": null,
\"sku\": null,
\"productName\": null,
\"orderLineId\": null,
\"serialNumber\": null,
\"lotNumber\": null,
\"purchaseDate\": null,
\"warrantyMonths\": null,
\"warrantyExpiresAt\": null,
\"faultCode\": null,
\"faultDescription\": null,
\"qtyApproved\": null,
\"qtyReceived\": null,
\"conditionOnReceipt\": null,
\"inspectionNotes\": null,
\"disposition\": null,
\"creditAmount\": null,
\"restockingFee\": null,
\"coreChargeAmount\": null,
\"coreCreditAmount\": null,
\"vendorName\": null,
\"conditionGrade\": null,
\"assessmentPayload\": null
}"/warranty_claims/linesUpdates a warranty claim line and recomputes claim totals.
{
"id": "00000000-0000-4000-8000-000000000000",
"productId": null,
"variantId": null,
"sku": null,
"productName": null,
"orderLineId": null,
"serialNumber": null,
"lotNumber": null,
"purchaseDate": null,
"warrantyMonths": null,
"warrantyExpiresAt": null,
"faultCode": null,
"faultDescription": null,
"qtyApproved": null,
"qtyReceived": null,
"conditionOnReceipt": null,
"inspectionNotes": null,
"disposition": null,
"creditAmount": null,
"restockingFee": null,
"coreChargeAmount": null,
"coreCreditAmount": null,
"vendorName": null
}{
"ok": true,
"id": null,
"claimId": null
}curl -X PUT "https://om.opperescala.com/api/warranty_claims/lines" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"productId\": null,
\"variantId\": null,
\"sku\": null,
\"productName\": null,
\"orderLineId\": null,
\"serialNumber\": null,
\"lotNumber\": null,
\"purchaseDate\": null,
\"warrantyMonths\": null,
\"warrantyExpiresAt\": null,
\"faultCode\": null,
\"faultDescription\": null,
\"qtyApproved\": null,
\"qtyReceived\": null,
\"conditionOnReceipt\": null,
\"inspectionNotes\": null,
\"disposition\": null,
\"creditAmount\": null,
\"restockingFee\": null,
\"coreChargeAmount\": null,
\"coreCreditAmount\": null,
\"vendorName\": null
}"/warranty_claims/linesSoft-deletes a warranty claim line and recomputes claim totals.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/warranty_claims/lines" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/warranty_claims/receiving{
"lineId": "00000000-0000-4000-8000-000000000000",
"action": "release",
"updatedAt": null
}{
"ok": true,
"lineId": "00000000-0000-4000-8000-000000000000",
"claimId": "00000000-0000-4000-8000-000000000000"
}curl -X POST "https://om.opperescala.com/api/warranty_claims/receiving" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"lineId\": \"00000000-0000-4000-8000-000000000000\",
\"action\": \"release\",
\"updatedAt\": null
}"/warranty_claims/registrationsReturns a paginated collection of warrantyregistrations scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | No | any | — |
| serialNumber | query | No | any | — |
| customerId | query | No | any | — |
| coverageType | query | No | any | — |
| source | query | No | any | — |
| expiry | query | No | any | — |
| search | query | No | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
{
"items": [
{
"id": null,
"organizationId": null,
"tenantId": null,
"serialNumber": null,
"productId": null,
"variantId": null,
"sku": null,
"productName": null,
"customerId": null,
"orderId": null,
"purchaseDate": null,
"warrantyMonths": null,
"warrantyExpiresAt": null,
"coverageType": null,
"source": null,
"proofAttachmentId": null,
"notes": null,
"createdAt": null,
"updatedAt": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/warranty_claims/registrations?page=1&pageSize=20" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/warranty_claims/external/claims| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | query | No | any | — |
| claimNumber | query | No | any | — |
| externalRef | query | No | any | — |
{
"ok": true,
"claim": {
"id": "00000000-0000-4000-8000-000000000000",
"claimNumber": "string",
"externalRef": null,
"status": "string",
"claimType": "string",
"channel": "string",
"priority": "string",
"createdAt": null,
"updatedAt": null,
"submittedAt": null,
"resolvedAt": null,
"closedAt": null,
"totalClaimedAmount": null,
"totalApprovedAmount": null,
"currencyCode": null,
"resolutionSummary": null
},
"lines": [
{
"id": "00000000-0000-4000-8000-000000000000",
"lineNo": 1,
"productId": null,
"sku": null,
"productName": null,
"serialNumber": null,
"qtyClaimed": null,
"qtyApproved": null,
"lineStatus": "string",
"disposition": null,
"warrantyStatus": null
}
],
"events": [
{
"id": "00000000-0000-4000-8000-000000000000",
"kind": "string",
"body": null,
"createdAt": null
}
]
}curl -X GET "https://om.opperescala.com/api/warranty_claims/external/claims" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/warranty_claims/external/claims{
"externalRef": "string",
"orderId": null,
"orderNumber": null,
"customerId": null,
"contactName": null,
"contactEmail": null,
"reasonCode": null,
"notes": null,
"lines": [
{
"productId": null,
"sku": null,
"productName": null,
"serialNumber": null,
"faultCode": null,
"faultDescription": "string",
"purchaseDate": null,
"warrantyMonths": null
}
]
}{
"ok": true,
"id": "00000000-0000-4000-8000-000000000000",
"claimNumber": "string",
"status": "string",
"externalRef": null,
"lines": [
{
"id": "00000000-0000-4000-8000-000000000000",
"warrantyStatus": null
}
]
}{
"ok": true,
"id": "00000000-0000-4000-8000-000000000000",
"claimNumber": "string",
"status": "string",
"externalRef": null,
"lines": [
{
"id": "00000000-0000-4000-8000-000000000000",
"warrantyStatus": null
}
]
}curl -X POST "https://om.opperescala.com/api/warranty_claims/external/claims" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"externalRef\": \"string\",
\"orderId\": null,
\"orderNumber\": null,
\"customerId\": null,
\"contactName\": null,
\"contactEmail\": null,
\"reasonCode\": null,
\"notes\": null,
\"lines\": [
{
\"productId\": null,
\"sku\": null,
\"productName\": null,
\"serialNumber\": null,
\"faultCode\": null,
\"faultDescription\": \"string\",
\"purchaseDate\": null,
\"warrantyMonths\": null
}
]
}"/warranty_claims/portal/attachments| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| claimId | query | Yes | any | — |
| page | query | No | any | — |
| pageSize | query | No | any | — |
{
"items": [
{
"id": "string",
"url": "string",
"downloadUrl": "string",
"fileName": "string",
"fileSize": 1,
"mimeType": null,
"partitionCode": "string",
"content": null,
"thumbnailUrl": "string",
"tags": [
"string"
],
"assignments": [
{
"type": "string",
"id": "string",
"href": null,
"label": null
}
],
"createdAt": null
}
]
}curl -X GET "https://om.opperescala.com/api/warranty_claims/portal/attachments?claimId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/warranty_claims/portal/attachmentsclaimId=00000000-0000-4000-8000-000000000000 file=string
{
"ok": true,
"item": {
"id": "string",
"url": "string",
"downloadUrl": "string",
"fileName": "string",
"fileSize": 1,
"mimeType": null,
"partitionCode": "string",
"content": null,
"thumbnailUrl": "string",
"tags": [
"string"
],
"assignments": [
{
"type": "string",
"id": "string",
"href": null,
"label": null
}
],
"createdAt": null,
"entityType": "string"
}
}curl -X POST "https://om.opperescala.com/api/warranty_claims/portal/attachments" \
-H "Accept: application/json" \
-H "Content-Type: multipart/form-data" \
-d "{
\"claimId\": \"00000000-0000-4000-8000-000000000000\",
\"file\": \"string\"
}"/warranty_claims/portal/attachmentsclaimId=00000000-0000-4000-8000-000000000000 file=string attachmentId=00000000-0000-4000-8000-000000000000
{
"ok": true,
"item": {
"id": "string",
"url": "string",
"downloadUrl": "string",
"fileName": "string",
"fileSize": 1,
"mimeType": null,
"partitionCode": "string",
"content": null,
"thumbnailUrl": "string",
"tags": [
"string"
],
"assignments": [
{
"type": "string",
"id": "string",
"href": null,
"label": null
}
],
"createdAt": null,
"entityType": "string"
}
}curl -X PUT "https://om.opperescala.com/api/warranty_claims/portal/attachments" \
-H "Accept: application/json" \
-H "Content-Type: multipart/form-data" \
-d "{
\"claimId\": \"00000000-0000-4000-8000-000000000000\",
\"file\": \"string\",
\"attachmentId\": \"00000000-0000-4000-8000-000000000000\"
}"/warranty_claims/portal/attachments| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| attachmentId | query | Yes | any | — |
{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/warranty_claims/portal/attachments?attachmentId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/warranty_claims/portal/claims| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| status | query | No | any | — |
| stateGroup | query | No | any | — |
| serialNumber | query | No | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"claimNumber": "string",
"claimType": "string",
"status": "string",
"orderId": null,
"orderNumber": null,
"reasonCode": null,
"resolutionSummary": null,
"createdAt": null,
"updatedAt": null,
"lines": {
"count": 1,
"creditTotal": "string",
"statuses": {
"key": 1
}
}
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/warranty_claims/portal/claims?page=1&pageSize=20" \ -H "Accept: application/json"
/warranty_claims/portal/claims{
"orderId": null,
"orderReference": null,
"reasonCode": "string",
"notes": null,
"lines": [
{
"orderLineId": null,
"productId": null,
"sku": null,
"productName": null,
"serialNumber": null,
"faultCode": null,
"faultDescription": "string",
"purchaseDate": null,
"warrantyMonths": null
}
]
}{
"ok": true,
"claimId": "00000000-0000-4000-8000-000000000000"
}curl -X POST "https://om.opperescala.com/api/warranty_claims/portal/claims" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"orderId\": null,
\"orderReference\": null,
\"reasonCode\": \"string\",
\"notes\": null,
\"lines\": [
{
\"orderLineId\": null,
\"productId\": null,
\"sku\": null,
\"productName\": null,
\"serialNumber\": null,
\"faultCode\": null,
\"faultDescription\": \"string\",
\"purchaseDate\": null,
\"warrantyMonths\": null
}
]
}"/warranty_claims/portal/claims/{id}| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"item": {
"id": "00000000-0000-4000-8000-000000000000",
"claimNumber": "string",
"claimType": "string",
"status": "string",
"channel": "string",
"priority": "string",
"customerId": null,
"customerName": null,
"orderId": null,
"orderNumber": null,
"reasonCode": null,
"rejectionReasonCode": null,
"resolutionSummary": null,
"slaDueAt": null,
"submittedAt": null,
"resolvedAt": null,
"closedAt": null,
"createdAt": null,
"updatedAt": null,
"lines": [
{
"id": "00000000-0000-4000-8000-000000000000",
"lineNo": 1,
"productId": null,
"sku": null,
"productName": null,
"orderLineId": null,
"serialNumber": null,
"faultCode": null,
"faultDescription": null,
"qtyClaimed": "string",
"qtyApproved": null,
"disposition": null,
"lineStatus": "string",
"creditAmount": null,
"createdAt": null,
"updatedAt": null
}
]
}
}curl -X GET "https://om.opperescala.com/api/warranty_claims/portal/claims/:id" \ -H "Accept: application/json"
/warranty_claims/portal/claims/{id}/submit| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"claimId": "00000000-0000-4000-8000-000000000000",
"status": "string"
}curl -X POST "https://om.opperescala.com/api/warranty_claims/portal/claims/:id/submit" \ -H "Accept: application/json"
/warranty_claims/portal/claims/{id}/withdraw| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"ok": true,
"claimId": "00000000-0000-4000-8000-000000000000",
"status": "cancelled"
}curl -X POST "https://om.opperescala.com/api/warranty_claims/portal/claims/:id/withdraw" \ -H "Accept: application/json"
/warranty_claims/portal/events| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| claimId | query | Yes | any | — |
{
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"claimId": null,
"kind": "string",
"visibility": "customer",
"body": null,
"payload": null,
"actorCustomerId": null,
"createdAt": null
}
]
}curl -X GET "https://om.opperescala.com/api/warranty_claims/portal/events?claimId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/warranty_claims/portal/events{
"claimId": "00000000-0000-4000-8000-000000000000",
"body": "string"
}{
"ok": true,
"claimId": "00000000-0000-4000-8000-000000000000"
}curl -X POST "https://om.opperescala.com/api/warranty_claims/portal/events" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"claimId\": \"00000000-0000-4000-8000-000000000000\",
\"body\": \"string\"
}"/warranty_claims/portal/options{
"ok": true,
"result": {
"reasons": [
{
"value": "string",
"label": "string"
}
],
"faultCodes": [
{
"value": "string",
"label": "string"
}
]
}
}curl -X GET "https://om.opperescala.com/api/warranty_claims/portal/options" \ -H "Accept: application/json"
/warranty_claims/portal/orders| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| search | query | No | any | — |
| page | query | No | any | — |
{
"ok": true,
"items": [
{
"id": "00000000-0000-4000-8000-000000000000",
"orderNumber": "string",
"placedAt": null,
"currencyCode": null,
"grandTotalGrossAmount": null
}
],
"total": 1,
"page": 1,
"pageSize": 1
}curl -X GET "https://om.opperescala.com/api/warranty_claims/portal/orders?page=1" \ -H "Accept: application/json"
/warranty_claims/portal/orders/lines| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| orderId | query | Yes | any | — |
{
"ok": true,
"order": {
"id": "00000000-0000-4000-8000-000000000000",
"placedAt": null
},
"items": [
{
"orderLineId": "00000000-0000-4000-8000-000000000000",
"productId": null,
"variantId": null,
"sku": null,
"name": null,
"quantity": null,
"estimatedWarrantyStatus": "in_warranty",
"purchaseDate": null,
"warrantyMonths": null
}
]
}curl -X GET "https://om.opperescala.com/api/warranty_claims/portal/orders/lines?orderId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/warranty_claims/portal/troubleshooting| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| claimType | query | No | any | — |
| reasonCode | query | No | any | — |
{
"guide": null
}curl -X GET "https://om.opperescala.com/api/warranty_claims/portal/troubleshooting" \ -H "Accept: application/json"
/wms/dashboard/operationalAggregated KPIs, expiry watch lot rows (`expiryLots`), monthly movement trends, and recent activity for the WMS operational dashboard.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| warehouseId | query | No | any | — |
{
"lastUpdatedAt": "string",
"warehouseId": null,
"kpis": [
{
"id": "lowStock",
"count": 1,
"deltaSinceYesterday": null,
"sparkline": [
1
]
}
],
"expiryLots": [
{
"id": "00000000-0000-4000-8000-000000000000",
"lotNumber": "string",
"sku": "string",
"expiresAt": "string",
"availableQuantity": 1,
"category": "expiringSoon"
}
],
"monthlyTrends": [
{
"month": "string",
"receive": 1,
"allocate": 1
}
],
"recentActivity": [
{
"id": "00000000-0000-4000-8000-000000000000",
"movementType": "string",
"quantity": 1,
"variantSku": null,
"variantId": "00000000-0000-4000-8000-000000000000",
"referenceType": null,
"referenceId": null,
"reason": null,
"locationLabel": "string",
"performedAt": "string"
}
]
}"string"
"string"
curl -X GET "https://om.opperescala.com/api/wms/dashboard/operational" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/wms/inventory-profilesReturns a paginated collection of inventory profiles scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| catalogProductId | query | No | any | — |
| catalogVariantId | query | No | any | — |
| defaultStrategy | query | No | any | — |
| trackLot | query | No | any | — |
| trackSerial | query | No | any | — |
| trackExpiration | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": null,
"organization_id": null,
"tenant_id": null,
"catalog_product_id": null,
"catalog_variant_id": null,
"product_title": null,
"product_sku": null,
"variant_name": null,
"variant_sku": null,
"default_uom": null,
"track_lot": null,
"track_serial": null,
"track_expiration": null,
"default_strategy": null,
"reorder_point": null,
"safety_stock": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/wms/inventory-profiles?page=1&pageSize=25" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/wms/inventory-profilesCreates a product inventory profile.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"catalogProductId": "00000000-0000-4000-8000-000000000000",
"catalogVariantId": null,
"defaultUom": "string",
"defaultStrategy": "fifo"
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/wms/inventory-profiles" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"catalogProductId\": \"00000000-0000-4000-8000-000000000000\",
\"catalogVariantId\": null,
\"defaultUom\": \"string\",
\"defaultStrategy\": \"fifo\"
}"/wms/inventory-profilesUpdates an inventory profile by id.
{
"id": "00000000-0000-4000-8000-000000000000",
"catalogVariantId": null
}{
"ok": true
}curl -X PUT "https://om.opperescala.com/api/wms/inventory-profiles" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\",
\"catalogVariantId\": null
}"/wms/inventory-profilesSoft-deletes an inventory profile by id.
{
"id": "00000000-0000-4000-8000-000000000000"
}{
"ok": true
}curl -X DELETE "https://om.opperescala.com/api/wms/inventory-profiles" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"id\": \"00000000-0000-4000-8000-000000000000\"
}"/wms/inventory/adjustApplies a manual inventory adjustment and appends a movement ledger row.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"warehouseId": "00000000-0000-4000-8000-000000000000",
"locationId": "00000000-0000-4000-8000-000000000000",
"catalogVariantId": "00000000-0000-4000-8000-000000000000",
"delta": 1,
"reason": "string",
"referenceType": "manual",
"referenceId": "00000000-0000-4000-8000-000000000000",
"performedBy": "00000000-0000-4000-8000-000000000000"
}{
"ok": true,
"movementId": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/wms/inventory/adjust" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"warehouseId\": \"00000000-0000-4000-8000-000000000000\",
\"locationId\": \"00000000-0000-4000-8000-000000000000\",
\"catalogVariantId\": \"00000000-0000-4000-8000-000000000000\",
\"delta\": 1,
\"reason\": \"string\",
\"referenceType\": \"manual\",
\"referenceId\": \"00000000-0000-4000-8000-000000000000\",
\"performedBy\": \"00000000-0000-4000-8000-000000000000\"
}"/wms/inventory/allocateConverts a reservation from reserved quantity into allocated quantity on the selected stock buckets.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"reservationId": "00000000-0000-4000-8000-000000000000"
}{
"ok": true,
"allocationState": "allocated"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/wms/inventory/allocate" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"reservationId\": \"00000000-0000-4000-8000-000000000000\"
}"/wms/inventory/balancesReturns paginated inventory balance buckets for the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| warehouseId | query | No | any | — |
| locationId | query | No | any | — |
| catalogVariantId | query | No | any | — |
| lotId | query | No | any | — |
| serialNumber | query | No | any | — |
| lowStock | query | No | any | — |
| search | query | No | any | — |
{
"items": [
{
"id": null,
"organization_id": null,
"tenant_id": null,
"warehouse_id": null,
"warehouse_name": null,
"warehouse_code": null,
"location_id": null,
"location_code": null,
"location_type": null,
"catalog_variant_id": null,
"catalog_product_id": null,
"variant_name": null,
"variant_sku": null,
"lot_id": null,
"serial_number": null,
"quantity_on_hand": null,
"quantity_reserved": null,
"quantity_allocated": null,
"quantity_available": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/wms/inventory/balances?page=1&pageSize=25" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/wms/inventory/cycle-countReconciles a counted quantity against the current on-hand balance and appends a cycle-count movement when a delta exists.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"warehouseId": "00000000-0000-4000-8000-000000000000",
"locationId": "00000000-0000-4000-8000-000000000000",
"catalogVariantId": "00000000-0000-4000-8000-000000000000",
"countedQuantity": 1,
"autoAdjust": true,
"reason": "string",
"referenceId": "00000000-0000-4000-8000-000000000000",
"performedBy": "00000000-0000-4000-8000-000000000000"
}{
"ok": true,
"adjustmentDelta": "string",
"movementId": null
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/wms/inventory/cycle-count" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"warehouseId\": \"00000000-0000-4000-8000-000000000000\",
\"locationId\": \"00000000-0000-4000-8000-000000000000\",
\"catalogVariantId\": \"00000000-0000-4000-8000-000000000000\",
\"countedQuantity\": 1,
\"autoAdjust\": true,
\"reason\": \"string\",
\"referenceId\": \"00000000-0000-4000-8000-000000000000\",
\"performedBy\": \"00000000-0000-4000-8000-000000000000\"
}"/wms/inventory/import/applyApplies validated inventory import rows via wms.inventory.adjust commands (idempotent skip when delta is zero).
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"importBatchId": "00000000-0000-4000-8000-000000000000",
"reason": "CSV import inventory receipt",
"mode": "additive",
"rows": [
{
"rowNumber": 1,
"warehouseId": "00000000-0000-4000-8000-000000000000",
"locationId": "00000000-0000-4000-8000-000000000000",
"catalogVariantId": "00000000-0000-4000-8000-000000000000",
"quantity": 1,
"delta": 1
}
]
}{
"ok": true,
"importBatchId": "00000000-0000-4000-8000-000000000000",
"summary": {
"applied": 1,
"skipped": 1,
"failed": 1
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/wms/inventory/import/apply" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"importBatchId\": \"00000000-0000-4000-8000-000000000000\",
\"reason\": \"CSV import inventory receipt\",
\"mode\": \"additive\",
\"rows\": [
{
\"rowNumber\": 1,
\"warehouseId\": \"00000000-0000-4000-8000-000000000000\",
\"locationId\": \"00000000-0000-4000-8000-000000000000\",
\"catalogVariantId\": \"00000000-0000-4000-8000-000000000000\",
\"quantity\": 1,
\"delta\": 1
}
]
}"/wms/inventory/import/templateReturns a CSV template for WMS inventory imports. By default the quantity column is added to existing on-hand stock; the "Reconcile to exact balance" import option treats it as the absolute target balance instead.
"string"
curl -X GET "https://om.opperescala.com/api/wms/inventory/import/template" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/wms/inventory/import/validateDry-run validation for inventory import CSV rows. By default (mode "additive"), quantity is added to existing on-hand stock; opt into mode "reconcile" to instead treat quantity as the absolute target balance (overwrites existing stock, including reducing it). Accepts JSON rows, JSON csv text, or multipart file upload.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"mode": "additive",
"rows": [
{}
]
}{
"ok": true,
"importBatchId": "00000000-0000-4000-8000-000000000000",
"summary": {
"totalRows": 1,
"validRows": 1,
"errorRows": 1,
"warningRows": 1,
"skipRows": 1
},
"rows": [
{
"rowNumber": 1,
"status": "valid",
"errors": [
"string"
],
"warnings": [
"string"
]
}
]
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/wms/inventory/import/validate" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"mode\": \"additive\",
\"rows\": [
{}
]
}"/wms/inventory/moveMoves stock from one location to another within a warehouse and appends a transfer movement.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"warehouseId": "00000000-0000-4000-8000-000000000000",
"fromLocationId": "00000000-0000-4000-8000-000000000000",
"toLocationId": "00000000-0000-4000-8000-000000000000",
"catalogVariantId": "00000000-0000-4000-8000-000000000000",
"quantity": 1,
"reason": "string",
"referenceType": "manual",
"referenceId": "00000000-0000-4000-8000-000000000000",
"performedBy": "00000000-0000-4000-8000-000000000000"
}{
"ok": true,
"movementId": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/wms/inventory/move" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"warehouseId\": \"00000000-0000-4000-8000-000000000000\",
\"fromLocationId\": \"00000000-0000-4000-8000-000000000000\",
\"toLocationId\": \"00000000-0000-4000-8000-000000000000\",
\"catalogVariantId\": \"00000000-0000-4000-8000-000000000000\",
\"quantity\": 1,
\"reason\": \"string\",
\"referenceType\": \"manual\",
\"referenceId\": \"00000000-0000-4000-8000-000000000000\",
\"performedBy\": \"00000000-0000-4000-8000-000000000000\"
}"/wms/inventory/movementsReturns paginated inventory ledger entries for the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| warehouseId | query | No | any | — |
| locationId | query | No | any | — |
| catalogVariantId | query | No | any | — |
| lotId | query | No | any | — |
| referenceType | query | No | any | — |
| referenceId | query | No | any | — |
| type | query | No | any | — |
| search | query | No | any | — |
{
"items": [
{
"id": null,
"organization_id": null,
"tenant_id": null,
"warehouse_id": null,
"warehouse_name": null,
"warehouse_code": null,
"location_from_id": null,
"location_from_code": null,
"location_from_type": null,
"location_to_id": null,
"location_to_code": null,
"location_to_type": null,
"catalog_variant_id": null,
"catalog_product_id": null,
"variant_name": null,
"variant_sku": null,
"lot_id": null,
"serial_number": null,
"quantity": null,
"type": null,
"reference_type": null,
"reference_id": null,
"performed_by": null,
"performed_at": null,
"received_at": null,
"reason": null,
"reason_code": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/wms/inventory/movements?page=1&pageSize=25" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/wms/inventory/receiveRecords inbound inventory receipt and appends a receipt movement ledger row.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"warehouseId": "00000000-0000-4000-8000-000000000000",
"locationId": "00000000-0000-4000-8000-000000000000",
"catalogVariantId": "00000000-0000-4000-8000-000000000000",
"quantity": 1,
"referenceType": "po",
"referenceId": "00000000-0000-4000-8000-000000000000",
"performedBy": "00000000-0000-4000-8000-000000000000"
}{
"ok": true,
"movementId": "00000000-0000-4000-8000-000000000000"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/wms/inventory/receive" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"warehouseId\": \"00000000-0000-4000-8000-000000000000\",
\"locationId\": \"00000000-0000-4000-8000-000000000000\",
\"catalogVariantId\": \"00000000-0000-4000-8000-000000000000\",
\"quantity\": 1,
\"referenceType\": \"po\",
\"referenceId\": \"00000000-0000-4000-8000-000000000000\",
\"performedBy\": \"00000000-0000-4000-8000-000000000000\"
}"/wms/inventory/releaseReleases a previously reserved or allocated inventory reservation.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"reservationId": "00000000-0000-4000-8000-000000000000",
"reason": "string"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/wms/inventory/release" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"reservationId\": \"00000000-0000-4000-8000-000000000000\",
\"reason\": \"string\"
}"/wms/inventory/reservationsReturns paginated inventory reservations for the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| warehouseId | query | No | any | — |
| catalogVariantId | query | No | any | — |
| lotId | query | No | any | — |
| sourceType | query | No | any | — |
| sourceId | query | No | any | — |
| status | query | No | any | — |
| search | query | No | any | — |
{
"items": [
{
"id": null,
"organization_id": null,
"tenant_id": null,
"warehouse_id": null,
"warehouse_name": null,
"warehouse_code": null,
"catalog_variant_id": null,
"catalog_product_id": null,
"variant_name": null,
"variant_sku": null,
"lot_id": null,
"serial_number": null,
"quantity": null,
"source_type": null,
"source_id": null,
"source_label": null,
"expires_at": null,
"status": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/wms/inventory/reservations?page=1&pageSize=25" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/wms/inventory/reserveCreates an inventory reservation and assigns available buckets using the configured stock strategy.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"warehouseId": "00000000-0000-4000-8000-000000000000",
"catalogVariantId": "00000000-0000-4000-8000-000000000000",
"quantity": 1,
"sourceType": "order",
"sourceId": "00000000-0000-4000-8000-000000000000"
}{
"ok": true,
"reservationId": "00000000-0000-4000-8000-000000000000",
"allocatedBuckets": [
{
"locationId": "00000000-0000-4000-8000-000000000000",
"lotId": null,
"quantity": "string"
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/wms/inventory/reserve" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"warehouseId\": \"00000000-0000-4000-8000-000000000000\",
\"catalogVariantId\": \"00000000-0000-4000-8000-000000000000\",
\"quantity\": 1,
\"sourceType\": \"order\",
\"sourceId\": \"00000000-0000-4000-8000-000000000000\"
}"/wms/locationsReturns a paginated collection of warehouse locations scoped to the authenticated organization.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| search | query | No | any | — |
| warehouseId | query | No | any | — |
| parentId | query | No | any | — |
| type | query | No | any | — |
| isActive | query | No | any | — |
| ids | query | No | any | Comma-separated list of record UUIDs to filter by (max 200). |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": null,
"organization_id": null,
"tenant_id": null,
"warehouse_id": null,
"warehouse_name": null,
"warehouse_code": null,
"parent_id": null,
"code": null,
"type": null,
"is_active": null,
"capacity_units": null,
"capacity_weight": null,
"created_at": null,
"updated_at": null
}
],
"total": 1,
"totalPages": 1
}curl -X GET "https://om.opperescala.com/api/wms/locations?page=1&pageSize=25" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/wms/locationsCreates a storage location within a warehouse hierarchy.
{
"organizationId": "00000000-0000-4000-8000-000000000000",
"tenantId": "00000000-0000-4000-8000-000000000000",
"warehouseId": "00000000-0000-4000-8000-000000000000",
"code": "string",
"type": "zone",
"parentId": null
}{
"id": null
}curl -X POST "https://om.opperescala.com/api/wms/locations" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"organizationId\": \"00000000-0000-4000-8000-000000000000\",
\"tenantId\": \"00000000-0000-4000-8000-000000000000\",
\"warehouseId\": \"00000000-0000-4000-8000-000000000000\",
\"code\": \"string\",
\"type\": \"zone\",
\"parentId\": null
}"/workflows/command-settingsReturns every command declared through registerWorkflowSafeCommands together with whether this tenant has switched it on. `configured: false` means the tenant has never saved the setting and the answers come from the grandfathered defaults.
{
"configured": true,
"items": [
{
"commandId": "string",
"requiredFeatures": [
"string"
],
"labelKey": null
}
]
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/workflows/command-settings" \ -H "Accept: application/json" \ -H "authorization: Bearer <token>"
/workflows/command-settingsReplaces the tenant's enabled set. Every submitted id must be present in the code-declared catalogue; an unknown id is rejected with 400 rather than stored. Stored ids whose declaring module is not loaded in this process are retained so a save can never silently untick them.
{
"enabledCommandIds": [
"string"
]
}{
"configured": true,
"items": [
{
"commandId": "string",
"requiredFeatures": [
"string"
],
"labelKey": null
}
],
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/workflows/command-settings" \
-H "Accept: application/json" \
-H "authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{
\"enabledCommandIds\": [
\"string\"
]
}"/workflows/commandsReturns the registered workflow-safe command catalogue consumed by the UPDATE_ENTITY command picker, each entry carrying whether the caller's tenant has enabled it. Entries with enabled:false, and commands outside the catalogue entirely, can still be authored but fail at runtime.
{
"items": [
{
"commandId": "string",
"requiredFeatures": [
"string"
],
"labelKey": null
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/workflows/commands" \ -H "Accept: application/json"
/workflows/definitionsGet a list of workflow definitions with optional filters. Supports pagination and search.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| workflowId | query | Yes | any | — |
| enabled | query | No | any | — |
| search | query | No | any | — |
| limit | query | No | any | — |
| offset | query | No | any | — |
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"workflowId": "checkout-flow",
"workflowName": "Checkout Flow",
"description": "Complete checkout workflow for processing orders",
"version": 1,
"definition": {
"steps": [
{
"stepId": "start",
"stepName": "Start",
"stepType": "START"
},
{
"stepId": "validate-cart",
"stepName": "Validate Cart",
"stepType": "AUTOMATED"
},
{
"stepId": "end",
"stepName": "End",
"stepType": "END"
}
],
"transitions": [
{
"transitionId": "start-to-validate",
"fromStepId": "start",
"toStepId": "validate-cart",
"trigger": "auto"
},
{
"transitionId": "validate-to-end",
"fromStepId": "validate-cart",
"toStepId": "end",
"trigger": "auto"
}
]
},
"enabled": true,
"tenantId": "123e4567-e89b-12d3-a456-426614174001",
"organizationId": "123e4567-e89b-12d3-a456-426614174002",
"createdAt": "2025-12-08T10:00:00.000Z",
"updatedAt": "2025-12-08T10:00:00.000Z"
}
],
"pagination": {
"total": 1,
"limit": 50,
"offset": 0,
"hasMore": false
}
}curl -X GET "https://om.opperescala.com/api/workflows/definitions?workflowId=string&limit=50&offset=0" \ -H "Accept: application/json"
/workflows/definitionsCreate a new workflow definition. The definition must include at least START and END steps with at least one transition connecting them.
{
"workflowId": "checkout-flow",
"workflowName": "Checkout Flow",
"description": "Complete checkout workflow for processing orders",
"version": 1,
"definition": {
"steps": [
{
"stepId": "start",
"stepName": "Start",
"stepType": "START"
},
{
"stepId": "validate-cart",
"stepName": "Validate Cart",
"stepType": "AUTOMATED",
"description": "Validate cart items and check inventory"
},
{
"stepId": "payment",
"stepName": "Process Payment",
"stepType": "AUTOMATED",
"description": "Charge payment method",
"retryPolicy": {
"maxAttempts": 3,
"backoffMs": 1000
}
},
{
"stepId": "end",
"stepName": "End",
"stepType": "END"
}
],
"transitions": [
{
"transitionId": "start-to-validate",
"fromStepId": "start",
"toStepId": "validate-cart",
"trigger": "auto"
},
{
"transitionId": "validate-to-payment",
"fromStepId": "validate-cart",
"toStepId": "payment",
"trigger": "auto"
},
{
"transitionId": "payment-to-end",
"fromStepId": "payment",
"toStepId": "end",
"trigger": "auto",
"activities": [
{
"activityName": "Send Order Confirmation",
"activityType": "SEND_EMAIL",
"config": {
"to": "{{context.customerEmail}}",
"subject": "Order Confirmation #{{context.orderId}}",
"template": "order_confirmation"
}
}
]
}
]
},
"enabled": true
}{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"workflowId": "checkout-flow",
"workflowName": "Checkout Flow",
"description": "Complete checkout workflow for processing orders",
"version": 1,
"definition": {
"steps": [
{
"stepId": "start",
"stepName": "Start",
"stepType": "START"
},
{
"stepId": "validate-cart",
"stepName": "Validate Cart",
"stepType": "AUTOMATED"
},
{
"stepId": "payment",
"stepName": "Process Payment",
"stepType": "AUTOMATED"
},
{
"stepId": "end",
"stepName": "End",
"stepType": "END"
}
],
"transitions": [
{
"transitionId": "start-to-validate",
"fromStepId": "start",
"toStepId": "validate-cart",
"trigger": "auto"
},
{
"transitionId": "validate-to-payment",
"fromStepId": "validate-cart",
"toStepId": "payment",
"trigger": "auto"
},
{
"transitionId": "payment-to-end",
"fromStepId": "payment",
"toStepId": "end",
"trigger": "auto"
}
]
},
"enabled": true,
"tenantId": "123e4567-e89b-12d3-a456-426614174001",
"organizationId": "123e4567-e89b-12d3-a456-426614174002",
"createdAt": "2025-12-08T10:00:00.000Z",
"updatedAt": "2025-12-08T10:00:00.000Z"
},
"message": "Workflow definition created successfully"
}{
"error": "Validation failed",
"details": [
{
"path": [
"definition",
"steps"
],
"code": "custom",
"message": "Workflow must have at least START and END steps"
}
]
}{
"error": "Workflow definition with ID \"checkout-flow\" and version 1 already exists"
}curl -X POST "https://om.opperescala.com/api/workflows/definitions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"workflowId\": \"string\",
\"workflowName\": \"string\",
\"description\": null,
\"version\": 1,
\"definition\": {
\"steps\": [
{
\"stepId\": \"string\",
\"stepName\": \"string\",
\"stepType\": \"START\"
}
],
\"transitions\": [
{
\"transitionId\": \"string\",
\"fromStepId\": \"string\",
\"toStepId\": \"string\",
\"trigger\": \"auto\",
\"condition\": null,
\"continueOnActivityFailure\": false,
\"priority\": 0
}
]
},
\"metadata\": null,
\"enabled\": true,
\"grantedFeatures\": null
}"/workflows/definitions/{id}Get a single workflow definition by ID. Returns the complete workflow structure including steps and transitions (with embedded activities).
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | UUID for DB definitions, or "code:<workflowId>" for code-based definitions |
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"workflowId": "checkout-flow",
"workflowName": "Checkout Flow",
"description": "Complete checkout workflow for processing orders",
"version": 1,
"definition": {
"steps": [
{
"stepId": "start",
"stepName": "Start",
"stepType": "START"
},
{
"stepId": "validate-cart",
"stepName": "Validate Cart",
"stepType": "AUTOMATED",
"description": "Validate cart items and check inventory"
},
{
"stepId": "payment",
"stepName": "Process Payment",
"stepType": "AUTOMATED",
"description": "Charge payment method",
"retryPolicy": {
"maxAttempts": 3,
"backoffMs": 1000
}
},
{
"stepId": "end",
"stepName": "End",
"stepType": "END"
}
],
"transitions": [
{
"transitionId": "start-to-validate",
"fromStepId": "start",
"toStepId": "validate-cart",
"trigger": "auto"
},
{
"transitionId": "validate-to-payment",
"fromStepId": "validate-cart",
"toStepId": "payment",
"trigger": "auto"
},
{
"transitionId": "payment-to-end",
"fromStepId": "payment",
"toStepId": "end",
"trigger": "auto",
"activities": [
{
"activityName": "Send Order Confirmation",
"activityType": "SEND_EMAIL",
"config": {
"to": "{{context.customerEmail}}",
"subject": "Order Confirmation #{{context.orderId}}",
"template": "order_confirmation"
}
}
]
}
]
},
"enabled": true,
"tenantId": "123e4567-e89b-12d3-a456-426614174001",
"organizationId": "123e4567-e89b-12d3-a456-426614174002",
"createdAt": "2025-12-08T10:00:00.000Z",
"updatedAt": "2025-12-08T10:00:00.000Z"
}
}{
"error": "Workflow definition not found"
}curl -X GET "https://om.opperescala.com/api/workflows/definitions/string" \ -H "Accept: application/json"
/workflows/definitions/{id}Update an existing workflow definition. Supports partial updates - only provided fields will be updated.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"definition": {
"steps": [
{
"stepId": "start",
"stepName": "Start",
"stepType": "START"
},
{
"stepId": "validate-cart",
"stepName": "Validate Cart",
"stepType": "AUTOMATED"
},
{
"stepId": "payment",
"stepName": "Process Payment",
"stepType": "AUTOMATED"
},
{
"stepId": "confirmation",
"stepName": "Order Confirmation",
"stepType": "AUTOMATED"
},
{
"stepId": "end",
"stepName": "End",
"stepType": "END"
}
],
"transitions": [
{
"transitionId": "start-to-validate",
"fromStepId": "start",
"toStepId": "validate-cart",
"trigger": "auto"
},
{
"transitionId": "validate-to-payment",
"fromStepId": "validate-cart",
"toStepId": "payment",
"trigger": "auto"
},
{
"transitionId": "payment-to-confirmation",
"fromStepId": "payment",
"toStepId": "confirmation",
"trigger": "auto"
},
{
"transitionId": "confirmation-to-end",
"fromStepId": "confirmation",
"toStepId": "end",
"trigger": "auto"
}
]
},
"enabled": true
}{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"workflowId": "checkout-flow",
"workflowName": "Checkout Flow",
"description": "Complete checkout workflow for processing orders",
"version": 1,
"definition": {
"steps": [
{
"stepId": "start",
"stepName": "Start",
"stepType": "START"
},
{
"stepId": "validate-cart",
"stepName": "Validate Cart",
"stepType": "AUTOMATED"
},
{
"stepId": "payment",
"stepName": "Process Payment",
"stepType": "AUTOMATED"
},
{
"stepId": "confirmation",
"stepName": "Order Confirmation",
"stepType": "AUTOMATED"
},
{
"stepId": "end",
"stepName": "End",
"stepType": "END"
}
],
"transitions": [
{
"transitionId": "start-to-validate",
"fromStepId": "start",
"toStepId": "validate-cart",
"trigger": "auto"
},
{
"transitionId": "validate-to-payment",
"fromStepId": "validate-cart",
"toStepId": "payment",
"trigger": "auto"
},
{
"transitionId": "payment-to-confirmation",
"fromStepId": "payment",
"toStepId": "confirmation",
"trigger": "auto"
},
{
"transitionId": "confirmation-to-end",
"fromStepId": "confirmation",
"toStepId": "end",
"trigger": "auto"
}
]
},
"enabled": true,
"tenantId": "123e4567-e89b-12d3-a456-426614174001",
"organizationId": "123e4567-e89b-12d3-a456-426614174002",
"createdAt": "2025-12-08T10:00:00.000Z",
"updatedAt": "2025-12-08T11:30:00.000Z"
},
"message": "Workflow definition updated successfully"
}{
"error": "Validation failed",
"details": [
{
"path": [
"definition"
],
"code": "invalid_type",
"message": "Invalid input: expected object, received string",
"expected": "object",
"got": "string"
}
]
}{
"error": "Workflow definition not found"
}{
"error": "Structural changes require a new version while instances are still running",
"code": "WORKFLOW_STRUCTURAL_EDIT_REQUIRES_NEW_VERSION",
"definitionId": "123e4567-e89b-12d3-a456-426614174000",
"activeInstanceCount": 3,
"activeStatuses": [
"RUNNING",
"PAUSED",
"WAITING_FOR_ACTIVITIES",
"FORKED",
"COMPENSATING"
],
"changes": [
{
"kind": "transitionRetargeted",
"id": "t_lz3k9_ab12cd34e"
}
],
"remedy": {
"action": "createVersion",
"method": "POST",
"endpoint": "/api/workflows/definitions/123e4567-e89b-12d3-a456-426614174000/publish"
}
}curl -X PUT "https://om.opperescala.com/api/workflows/definitions/00000000-0000-4000-8000-000000000000" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"description\": null,
\"metadata\": null,
\"effectiveFrom\": null,
\"effectiveTo\": null,
\"grantedFeatures\": null
}"/workflows/definitions/{id}Soft delete a workflow definition. Cannot be deleted if there are active workflow instances (RUNNING or WAITING status) using this definition.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"message": "Workflow definition deleted successfully"
}{
"error": "Workflow definition not found"
}{
"error": "Cannot delete workflow definition with 3 active instance(s)"
}curl -X DELETE "https://om.opperescala.com/api/workflows/definitions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json"
/workflows/definitions/{id}/callersReturns parent definitions that invoke this workflow as a sub-workflow and the mappings its current port contract would break.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | Workflow definition id |
{
"callers": [
{
"workflowId": "order-flow",
"version": 1,
"stepId": "sub",
"brokenMappings": [
"input:orderId"
]
}
]
}{
"error": "Workflow definition not found"
}curl -X GET "https://om.opperescala.com/api/workflows/definitions/string/callers" \ -H "Accept: application/json"
/workflows/definitions/{id}/context-schemaComputes what context paths are available at each step of the workflow definition, with type, presence (always/maybe), and producer source. Presence degrades to "maybe" at joins unless the entry arrives on every incoming route. Use ?stepId=<id> to narrow the response to one step.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | UUID for DB definitions, or "code:<workflowId>" for code-based definitions |
| stepId | query | No | any | Narrow the response to this step (404 when the step does not exist) |
{
"steps": {
"approve": {
"entries": [
{
"path": "orderId",
"type": "text",
"presence": "always",
"source": {
"kind": "contextSchema",
"label": "contextSchema.input"
}
},
{
"path": "discount",
"type": "number",
"presence": "maybe",
"source": {
"kind": "userTask",
"stepId": "review",
"label": "userTask:review"
}
}
]
}
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/workflows/definitions/string/context-schema" \ -H "Accept: application/json"
/workflows/definitions/{id}/customizeCreates a DB override for a code-based workflow definition, seeded from the current code registry values. The id param must be of the form "code:<workflowId>".
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | Must be of the form "code:<workflowId>" |
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"workflowId": "workflows.simple-approval",
"workflowName": "Simple Approval Workflow",
"source": "code_override"
},
"message": "Workflow definition customized successfully"
}{
"error": "Customize is only supported for code-based workflow definitions"
}{
"error": "Workflow definition not found"
}curl -X POST "https://om.opperescala.com/api/workflows/definitions/string/customize" \ -H "Accept: application/json"
/workflows/definitions/{id}/draftReturns the authenticated user's autosaved draft for the workflow definition. Drafts are private to the user who saved them.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | Workflow definition UUID (server drafts exist only for saved definitions) |
{
"data": {
"id": "string",
"definitionId": null,
"definition": {
"steps": [
{}
],
"transitions": [
{}
]
},
"metadata": null,
"baseUpdatedAt": null,
"createdAt": null,
"updatedAt": null
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/workflows/definitions/string/draft" \ -H "Accept: application/json"
/workflows/definitions/{id}/draftCreates or updates the authenticated user's draft for the workflow definition. The definition payload is validated shape-only (steps and transitions must be arrays of objects) so a mid-edit, structurally incomplete graph still saves; full validation runs when the draft is promoted via the definition PUT. Draft saves never participate in the definition's optimistic lock.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | Workflow definition UUID (server drafts exist only for saved definitions) |
{
"definition": {
"steps": [
{
"stepId": "start",
"stepName": "Start",
"stepType": "START"
}
],
"transitions": []
},
"baseUpdatedAt": "2026-07-27T10:00:00.000Z"
}{
"data": {
"id": "string",
"definitionId": null,
"definition": {
"steps": [
{}
],
"transitions": [
{}
]
},
"metadata": null,
"baseUpdatedAt": null,
"createdAt": null,
"updatedAt": null
},
"message": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X PUT "https://om.opperescala.com/api/workflows/definitions/string/draft" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"definition\": {
\"steps\": [
{}
],
\"transitions\": [
{}
]
},
\"metadata\": null,
\"baseUpdatedAt\": null
}"/workflows/definitions/{id}/draftDeletes the authenticated user's draft for the workflow definition. Idempotent: discarding a non-existent draft succeeds.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | Workflow definition UUID (server drafts exist only for saved definitions) |
{
"message": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X DELETE "https://om.opperescala.com/api/workflows/definitions/string/draft" \ -H "Accept: application/json"
/workflows/definitions/{id}/publishMints a frozen published version snapshotting the definition and its IO port contract. Returns affected sub-workflow callers; pass acknowledgeBreakingChanges=true to publish despite breaking changes.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | Workflow definition id |
"string"
{
"data": {
"id": "…",
"workflowId": "verify-policy",
"version": 2,
"lifecycle": "published"
},
"breakingChanges": [],
"message": "Workflow definition published successfully"
}{
"error": "Workflow definition not found"
}{
"error": "Publishing would break existing sub-workflow mappings",
"breakingChanges": [
{
"workflowId": "order-flow",
"version": 1,
"stepId": "sub",
"brokenMappings": [
"input:orderId"
]
}
]
}curl -X POST "https://om.opperescala.com/api/workflows/definitions/string/publish" \ -H "Accept: application/json"
/workflows/definitions/{id}/reset-to-codeDeletes the DB override for a code-based workflow definition, reverting it to the original code registry version. Cannot be reset if there are active instances.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | — |
{
"data": {
"id": "code:checkout-flow",
"workflowId": "checkout-flow",
"workflowName": "Checkout Flow",
"description": "Code-defined checkout workflow",
"version": 1,
"source": "code",
"isCodeBased": true
},
"message": "Workflow definition reset to code version"
}{
"error": "This workflow definition is not a code-based override and cannot be reset"
}{
"error": "Workflow definition not found"
}{
"error": "Cannot reset workflow definition with 3 active instance(s)"
}curl -X POST "https://om.opperescala.com/api/workflows/definitions/00000000-0000-4000-8000-000000000000/reset-to-code" \ -H "Accept: application/json"
/workflows/definitions/{id}/test-stepInterpolates the supplied activity config against the sample context (plus a synthetic workflow scope and the server env allowlist) and runs the activity type's would-do mock. Never executes the real activity. Activity types that declare no mock or opt out with "refuse" respond 200 with a structured refusal the editor renders.
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| id | path | Yes | any | UUID for DB definitions, or "code:<workflowId>" for code-based definitions |
{
"stepId": "notify",
"activityType": "SEND_EMAIL",
"config": {
"to": "{{context.customerEmail}}",
"subject": "Order {{context.orderId}} approved"
},
"context": {
"customerEmail": "jane@example.com",
"orderId": "ORD-42"
}
}{
"simulated": true,
"activityType": "SEND_EMAIL",
"output": {
"sent": false,
"simulated": true,
"wouldSendTo": "jane@example.com",
"subject": "Order ORD-42 approved"
},
"interpolatedConfig": {
"to": "jane@example.com",
"subject": "Order ORD-42 approved"
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/workflows/definitions/string/test-step" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"activityType\": \"string\",
\"config\": {}
}"/workflows/definitions/generateRuns the propose-only workflows.workflow_author agent against this installation's activity, command, function and event catalogs and returns a draft definition plus the Problems-panel evaluation for it. Persists nothing: the draft is returned to the Studio for a human to apply, save and enable. Refusals ("unavailable" when no AI provider or agent registry is present, "failed" when the model call errored, "malformedResponse"/"schemaError" when the output is not a workflow definition) respond 200 with a structured body.
{
"prompt": "string"
}{
"ok": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X POST "https://om.opperescala.com/api/workflows/definitions/generate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d "{
\"prompt\": \"string\"
}"/workflows/endpointsReturns a trimmed projection of the OpenAPI surface (path, method, summary, tag, parameters, and declared request/response schemas) consumed by the CALL_API endpoint picker. Endpoints outside this catalog can still be authored as free text. Responses without a declared schema omit responseSchema so consumers degrade to unknown typing.
{
"items": [
{
"path": "string",
"method": "string",
"summary": "string",
"tag": "string",
"params": [
{
"name": "string",
"in": "path",
"required": true,
"type": "string"
}
],
"hasRequestSchema": true
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/workflows/endpoints" \ -H "Accept: application/json"
/workflows/eventsGet a paginated list of all workflow events with filtering options
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | No | any | — |
| pageSize | query | No | any | — |
| eventType | query | No | any | — |
| workflowInstanceId | query | No | any | — |
| userId | query | No | any | — |
| occurredAtFrom | query | No | any | — |
| occurredAtTo | query | No | any | — |
| sortField | query | No | any | — |
| sortDir | query | No | any | — |
{
"items": [
{
"id": "string",
"workflowInstanceId": "00000000-0000-4000-8000-000000000000",
"stepInstanceId": null,
"eventType": "string",
"occurredAt": "string",
"userId": null,
"workflowInstance": null
}
],
"total": 1,
"page": 1,
"pageSize": 1,
"totalPages": 1
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}curl -X GET "https://om.opperescala.com/api/workflows/events?page=1&pageSize=50&sortField=occurredAt&sortDir=desc" \ -H "Accept: application/json"