API Categories

OpenAPI Explorer

Auto-generated OpenAPI definition for all enabled modules.

Default server: https://fixture.omnibus.buscrazy.net/api

Authentication & Accounts

Showing 20 of 35 endpoints

GET/auth/admin/nav

Auth required

Resolve backend chrome bootstrap payload

Returns the backend chrome payload available to the authenticated administrator after applying scope, RBAC, role defaults, and personal sidebar preferences.

Responses

200Backend chrome payload

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/auth/admin/nav" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/auth/autologin

Auto sign-in using env-configured demo credentials

When 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.

Responses

200Success response

Content-Type: application/json

"string"

307Redirect into the app (or to /login on failure)

Content-Type: text/html

string

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/auth/autologin" \
  -H "Accept: application/json"

POST/auth/feature-check

Auth required

Check feature grants for the current user

Evaluates which of the requested features are available to the signed-in user within the active tenant / organization context.

Request body (application/json)

{
  "features": [
    "string"
  ]
}

Responses

200Evaluation result

Content-Type: application/json

{
  "ok": true,
  "granted": [
    "string"
  ],
  "userId": "string"
}

400Invalid request — features array missing, too large, or contains invalid entries

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/auth/feature-check" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"features\": [
    \"string\"
  ]
}"

GET/auth/features

Auth required

List declared feature flags

Returns all static features contributed by the enabled modules along with their module source.

Responses

200Aggregated feature catalog

Content-Type: application/json

{
  "items": [
    {
      "id": "string",
      "title": "string",
      "module": "string"
    }
  ],
  "modules": [
    {
      "id": "string",
      "title": "string"
    }
  ]
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/auth/features" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/auth/locale

Set locale and redirect

Stores the selected locale in a cookie and redirects to a safe local path.

Parameters

Name	In	Required	Schema	Description
locale	query	Yes	any	—
redirect	query	No	any	—

Responses

200Success response

Content-Type: application/json

"string"

302Locale cookie set and request redirected

Content-Type: application/json

"string"

400Invalid locale

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/auth/locale?locale=en" \
  -H "Accept: application/json"

POST/auth/locale

Set locale

Stores the selected locale in a cookie and returns a JSON success response.

Request body (application/json)

{
  "locale": "en"
}

Responses

200Locale cookie set

Content-Type: application/json

{
  "ok": true
}

400Invalid locale or malformed request body

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/auth/locale" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"locale\": \"en\"
}"

POST/auth/login

Authenticate user credentials

Validates the submitted credentials and issues a bearer token cookie for subsequent API calls.

Request body (application/x-www-form-urlencoded)

email=user%40example.com&password=string

Responses

200Authentication succeeded

Content-Type: application/json

{
  "ok": true,
  "token": "string",
  "redirect": null
}

400Validation failed

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Invalid credentials

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403User lacks required role

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

429Too many login attempts

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/auth/login" \
  -H "Accept: application/json" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "email=user%40example.com&password=string"

POST/auth/logout

Auth required

Invalidate session and redirect

Clears authentication cookies and redirects the browser to the login page.

Responses

201Success response

Content-Type: application/json

"string"

302Redirect to login after successful logout

Content-Type: text/html

string

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/auth/logout" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/auth/profile

Auth required

Get current profile

Returns the email address, display name, and roles for the signed-in user. The display name is null when unset.

Responses

200Profile payload

Content-Type: application/json

{
  "email": "user@example.com",
  "name": null,
  "roles": [
    "string"
  ]
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404User not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/auth/profile" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/auth/profile

Auth required

Update current profile

Updates the email address or password for the signed-in user.

Request body (application/json)

{}

Responses

200Profile updated

Content-Type: application/json

{
  "ok": true,
  "email": "user@example.com"
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/auth/profile" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{}"

POST/auth/reset

Send reset email

Requests a password reset email for the given account. The endpoint always returns `ok: true` to avoid leaking account existence.

Request body (application/x-www-form-urlencoded)

email=user%40example.com

Responses

200Reset email dispatched (or ignored for unknown accounts)

Content-Type: application/json

{
  "ok": true
}

400Invalid request origin

Content-Type: application/json

{
  "error": "string"
}

429Too many password reset requests

Content-Type: application/json

{
  "error": "string"
}

500Password reset email origin is not configured

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/auth/reset" \
  -H "Accept: application/json" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "email=user%40example.com"

POST/auth/reset/confirm

Complete password reset

Validates the reset token and updates the user password.

Request body (application/x-www-form-urlencoded)

token=string&password=string

Responses

200Password reset succeeded

Content-Type: application/json

{
  "ok": true,
  "redirect": "string"
}

400Invalid token or payload

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

429Too many reset confirmation attempts

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/auth/reset/confirm" \
  -H "Accept: application/json" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "token=string&password=string"

GET/auth/roles

Auth required

List roles

Returns available roles within the current tenant. Super administrators receive visibility across tenants.

Parameters

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	—

Responses

200Role collection

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "string",
      "usersCount": 1,
      "tenantId": null,
      "tenantName": null,
      "updatedAt": null
    }
  ],
  "total": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/auth/roles?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/auth/roles

Auth required

Create role

Creates a new role anchored to the caller's tenant. Non-superadmins cannot target another tenant; supplying a foreign `tenantId` is rejected.

Request body (application/json)

{
  "name": "string"
}

Responses

201Role created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000"
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/auth/roles" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"name\": \"string\"
}"

PUT/auth/roles

Auth required

Update role

Updates mutable fields on an existing role.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Role updated

Content-Type: application/json

{
  "ok": true
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Role not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/auth/roles" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

DELETE/auth/roles

Auth required

Delete role

Deletes a role by identifier. Fails when users remain assigned.

Parameters

Name	In	Required	Schema	Description
id	query	Yes	any	Role identifier

Responses

200Role deleted

Content-Type: application/json

{
  "ok": true
}

400Role cannot be deleted

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Role not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/auth/roles?id=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/auth/roles/acl

Auth required

Fetch role ACL

Returns the feature and organization assignments associated with a role within the current tenant.

Parameters

Name	In	Required	Schema	Description
roleId	query	Yes	any	—
tenantId	query	No	any	—

Responses

200Role ACL entry

Content-Type: application/json

{
  "isSuperAdmin": true,
  "features": [
    "string"
  ],
  "organizations": null,
  "updatedAt": null
}

400Invalid role id

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Role not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/auth/roles/acl?roleId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/auth/roles/acl

Auth required

Update role ACL

Replaces the feature list, super admin flag, and optional organization assignments for a role.

Request body (application/json)

{
  "roleId": "00000000-0000-4000-8000-000000000000",
  "organizations": null
}

Responses

200Role ACL updated

Content-Type: application/json

{
  "ok": true,
  "sanitized": true
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Insufficient privileges to modify ACL

Content-Type: application/json

{
  "error": "string"
}

404Role not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

GET/auth/session/refresh

Refresh auth cookie from session token (browser)

Exchanges an existing `session_token` cookie for a fresh JWT auth cookie and redirects the browser.

Parameters

Name	In	Required	Schema	Description
redirect	query	No	any	Absolute or relative URL to redirect after refresh

Responses

200Success response

Content-Type: application/json

"string"

302Redirect to target location when session is valid

Content-Type: text/html

string

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/auth/session/refresh" \
  -H "Accept: application/json"

POST/auth/session/refresh

Refresh access token (API/mobile)

Exchanges a refresh token for a new JWT access token. Pass the refresh token obtained from login in the request body.

Request body (application/json)

{
  "refreshToken": "string"
}

Responses

200New access token issued

Content-Type: application/json

{
  "ok": true,
  "accessToken": "string",
  "expiresIn": 1
}

400Missing refresh token

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Invalid or expired token

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

429Too many refresh attempts

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/auth/session/refresh" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"refreshToken\": \"string\"
}"

Directory (Tenants & Organizations)

Showing 2 of 2 endpoints

GET/directory/organizations/lookup

Public organization lookup by slug

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/directory/organizations/lookup" \
  -H "Accept: application/json"

GET/directory/tenants/lookup

Public tenant lookup

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/directory/tenants/lookup" \
  -H "Accept: application/json"

Customer Relationship Management

Showing 2 of 2 endpoints

POST/customers/deals/bulk-update-owner

Auth required

Bulk reassign deal owner

Queues a background job that reassigns the listed deals to a new owner (or clears the owner when null).

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customers/deals/bulk-update-owner" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customers/deals/bulk-update-stage

Auth required

Bulk update deal pipeline stage

Queues a background job that moves the listed deals to the same pipeline stage. Returns a progress job id to poll for completion.

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customers/deals/bulk-update-stage" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Audit & Action Logs

Showing 5 of 5 endpoints

GET/audit_logs/audit-logs/access

Auth required

Retrieve access logs

Fetches paginated access audit logs scoped to the authenticated user. Tenant administrators can optionally expand the search to other actors or organizations.

Parameters

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

Responses

200Access logs returned successfully

Content-Type: application/json

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

400Invalid filters supplied

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Caller has no resolved tenant scope and is not a superadmin

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/audit_logs/audit-logs/access" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/audit_logs/audit-logs/actions

Auth required

Fetch action logs

Returns 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.

Parameters

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

Responses

200Action logs retrieved successfully

Content-Type: application/json

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

400Invalid filter values

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Caller has no resolved tenant scope and is not a superadmin

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/audit_logs/audit-logs/actions?includeRelated=false&includeTotal=false&undoableOnly=false" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/audit_logs/audit-logs/actions/export

Auth required

Export action logs as CSV

Returns a CSV attachment containing filtered action audit log entries. Tenant administrators can widen the scope to other actors or organizations.

Parameters

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

Responses

200CSV export generated successfully

Content-Type: application/json

{
  "file": "csv"
}

400Invalid filter values

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Caller has no resolved tenant scope and is not a superadmin

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/audit_logs/audit-logs/actions/export?includeRelated=false&undoableOnly=false" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/audit_logs/audit-logs/actions/redo

Auth required

Redo by action log id

Redoes the latest undone command owned by the caller. Requires the action to still be eligible for redo within tenant and organization scope.

Request body (application/json)

{
  "logId": "string"
}

Responses

200Redo executed successfully

Content-Type: application/json

{
  "ok": true,
  "logId": null,
  "undoToken": null
}

400Log not eligible for redo

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Redo blocked by scope checks

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/audit_logs/audit-logs/actions/redo" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"logId\": \"string\"
}"

POST/audit_logs/audit-logs/actions/undo

Auth required

Undo action by token

Replays the undo handler registered for a command. The provided undo token must match the latest undoable log entry accessible to the caller.

Request body (application/json)

{
  "undoToken": "string"
}

Responses

200Undo applied successfully

Content-Type: application/json

{
  "ok": true,
  "logId": "string"
}

400Invalid or unavailable undo token

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Undo blocked by organization or tenant scope

Content-Type: application/json

{
  "error": "string"
}

422Undo deliberately blocked by a beforeUndo command interceptor. The interceptor chooses the status (any 4xx/5xx) and may replace the body.

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/audit_logs/audit-logs/actions/undo" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"undoToken\": \"string\"
}"

Attachments

Showing 14 of 14 endpoints

GET/attachments

Auth required

List attachments for a record

Returns uploaded attachments for the given entity record, ordered by newest first.

Parameters

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	—

Responses

200Attachments found for the record

Content-Type: application/json

{
  "items": [
    {
      "id": "string",
      "url": "string",
      "fileName": "string",
      "fileSize": 1,
      "createdAt": "string",
      "mimeType": null,
      "content": null
    }
  ]
}

400Missing entity or record identifiers

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/attachments?entityId=string&recordId=string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/attachments

Auth required

Upload attachment

Uploads a new attachment using multipart form-data and stores metadata for later retrieval.

Request body (multipart/form-data)

entityId=string
recordId=string
file=string

Responses

200Attachment stored successfully

Content-Type: application/json

{
  "ok": true,
  "item": {
    "id": "string",
    "url": "string",
    "fileName": "string",
    "fileSize": 1,
    "content": null
  }
}

400Payload validation error

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Attachment violates field constraints

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/attachments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: multipart/form-data" \
  -d "{
  \"entityId\": \"string\",
  \"recordId\": \"string\",
  \"file\": \"string\"
}"

DELETE/attachments

Auth required

Delete attachment

Removes an uploaded attachment and deletes the stored asset.

Parameters

Name	In	Required	Schema	Description
id	query	Yes	any	—

Responses

200Attachment deleted

Content-Type: application/json

{
  "ok": true
}

400Missing attachment identifier

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Attachment not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/attachments?id=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/attachments/file/{id}

Download or serve attachment file

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.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200File content with appropriate MIME type

Content-Type: application/json

"string"

400Missing attachment ID

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized - authentication required for private partitions

Content-Type: application/json

{
  "error": "string"
}

403Forbidden - insufficient permissions

Content-Type: application/json

{
  "error": "string"
}

404Attachment or file not found

Content-Type: application/json

{
  "error": "string"
}

500Partition misconfigured

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/attachments/file/:id" \
  -H "Accept: application/json"

GET/attachments/image/{id}/{slug}

Serve image with optional resizing

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).

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
slug	path	No	any	—

Responses

200Binary image content (Content-Type: image/jpeg, image/png, etc.)

Content-Type: application/json

"string"

400Invalid parameters, missing ID, or non-image attachment

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized - authentication required for private partitions

Content-Type: application/json

{
  "error": "string"
}

403Forbidden - insufficient permissions

Content-Type: application/json

{
  "error": "string"
}

404Image not found

Content-Type: application/json

{
  "error": "string"
}

500Partition misconfigured or image rendering failed

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/attachments/image/:id/:slug" \
  -H "Accept: application/json"

GET/attachments/library

Auth required

List attachments

Returns paginated list of attachments with optional filtering by search term, partition, and tags. Includes available tags and partitions.

Parameters

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

Responses

200Attachments list with pagination and metadata

Content-Type: application/json

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

400Invalid query parameters

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/attachments/library?page=1&pageSize=25" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/attachments/library/{id}

Auth required

Get attachment details

Returns complete details of an attachment including metadata, tags, assignments, and custom fields.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Attachment details

Content-Type: application/json

{
  "item": {
    "id": "00000000-0000-4000-8000-000000000000",
    "fileName": "string",
    "fileSize": 1,
    "mimeType": "string",
    "partitionCode": "string",
    "partitionTitle": null,
    "tags": [
      "string"
    ],
    "assignments": [],
    "content": null,
    "customFields": null
  }
}

400Invalid attachment ID

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Attachment not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/attachments/library/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/attachments/library/{id}

Auth required

Update attachment metadata

Updates attachment tags, assignments, and custom fields. Emits CRUD side effects for indexing and events.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{}

Responses

200Attachment updated successfully

Content-Type: application/json

{
  "ok": true
}

400Invalid payload or attachment ID

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Attachment not found

Content-Type: application/json

{
  "error": "string"
}

500Failed to save attributes

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PATCH "https://fixture.omnibus.buscrazy.net/api/attachments/library/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{}"

DELETE/attachments/library/{id}

Auth required

Delete attachment

Permanently deletes an attachment file from storage and database. Emits CRUD side effects.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Attachment deleted successfully

Content-Type: application/json

{
  "ok": true
}

400Invalid attachment ID

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Attachment not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/attachments/library/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/attachments/partitions

Auth required

List all attachment partitions

Returns all configured attachment partitions with storage settings, OCR configuration, and access control settings.

Responses

200List of partitions

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/attachments/partitions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/attachments/partitions

Auth required

Create new partition

Creates a new attachment partition with specified storage and OCR settings. Requires unique partition code.

Request body (application/json)

{
  "code": "string",
  "title": "string",
  "description": null,
  "ocrModel": null,
  "storageDriver": "local",
  "configJson": null
}

Responses

201Partition created successfully

Content-Type: application/json

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

400Invalid payload or partition code

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Partitions locked in demo mode

Content-Type: application/json

{
  "error": "string"
}

409Partition code already exists

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/attachments/partitions

Auth required

Update partition

Updates an existing partition. Partition code cannot be changed. Title, description, OCR settings, and access control can be modified.

Request body (application/json)

{
  "code": "string",
  "title": "string",
  "description": null,
  "ocrModel": null,
  "storageDriver": "local",
  "configJson": null,
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Partition updated successfully

Content-Type: application/json

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

400Invalid payload or code change attempt

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Partitions locked in demo mode

Content-Type: application/json

{
  "error": "string"
}

404Partition not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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\"
}"

DELETE/attachments/partitions

Auth required

Delete partition

Deletes a partition. Default partitions cannot be deleted. Partitions with existing attachments cannot be deleted.

Responses

200Partition deleted successfully

Content-Type: application/json

{
  "ok": true
}

400Invalid ID or default partition deletion attempt

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Partitions locked in demo mode

Content-Type: application/json

{
  "error": "string"
}

404Partition not found

Content-Type: application/json

{
  "error": "string"
}

409Partition in use

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/attachments/partitions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/attachments/transfer

Auth required

Transfer attachments to different record

Transfers one or more attachments from one record to another within the same entity type. Updates attachment assignments and metadata to reflect the new record.

Request body (application/json)

{
  "entityId": "string",
  "attachmentIds": [
    "00000000-0000-4000-8000-000000000000"
  ],
  "toRecordId": "string"
}

Responses

200Attachments transferred successfully

Content-Type: application/json

{
  "ok": true,
  "updated": 1
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Attachments not found

Content-Type: application/json

{
  "error": "string"
}

500Attachment model missing

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

Product Catalog

Showing 1 of 1 endpoints

POST/catalog/bulk-delete

Auth required

Start bulk deleting catalog products

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/catalog/bulk-delete" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

API Keys

Showing 3 of 3 endpoints

GET/api_keys/keys

Auth required

List API keys

Returns paginated API keys visible to the current user, including per-key role assignments and organization context.

Parameters

Name	In	Required	Schema	Description
page	query	No	any	—
pageSize	query	No	any	—
search	query	No	any	—

Responses

200Collection of API keys

Content-Type: application/json

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

400Tenant context missing

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden by organization scope

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/api_keys/keys" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/api_keys/keys

Auth required

Create API key

Creates a new API key, returning the one-time secret value together with the generated key prefix and scope details.

Request body (application/json)

{
  "name": "string",
  "description": null,
  "tenantId": null,
  "organizationId": null,
  "roles": [],
  "expiresAt": null
}

Responses

201API key created successfully

Content-Type: application/json

{
  "id": "string",
  "name": "string",
  "keyPrefix": "string",
  "tenantId": null,
  "organizationId": null,
  "roles": [
    {
      "id": "string",
      "name": null
    }
  ]
}

400Invalid payload or missing tenant context

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Organization outside allowed scope

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/api_keys/keys

Auth required

Delete API key

Removes an API key by identifier. The key must belong to the current tenant and fall within the requester organization scope.

Parameters

Name	In	Required	Schema	Description
id	query	Yes	any	API key identifier to delete

Responses

200Key deleted successfully

Content-Type: application/json

{
  "success": true
}

400Missing or invalid identifier

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Organization outside allowed scope

Content-Type: application/json

{
  "error": "string"
}

404Key not found within scope

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/api_keys/keys?id=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Devices

Showing 6 of 6 endpoints

GET/devices

Auth required

List devices

Returns the authenticated user's registered devices (admins may list across users).

Parameters

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).

Responses

200Paginated devices

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "tenant_id": "00000000-0000-4000-8000-000000000000",
      "organization_id": null,
      "user_id": "00000000-0000-4000-8000-000000000000",
      "device_id": "string",
      "platform": "ios",
      "client_app_version": null,
      "os_version": null,
      "locale": null,
      "push_provider": null,
      "push_token_updated_at": null,
      "last_seen_at": null,
      "created_at": null,
      "updated_at": null
    }
  ],
  "total": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/devices?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/devices

Auth required

Create device

Registers (or idempotently upserts) the current user's device for the given deviceId. May include an initial push token.

Request body (application/json)

{
  "deviceId": "string",
  "platform": "ios",
  "clientAppVersion": null,
  "osVersion": null,
  "locale": null,
  "pushToken": null,
  "pushProvider": null
}

Responses

201Device created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "deviceId": "string",
  "revived": true
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/devices/{id}

Auth required

Update your device

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.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "clientAppVersion": null,
  "osVersion": null,
  "locale": null,
  "pushToken": null,
  "pushProvider": null
}

Responses

200Device updated

Content-Type: application/json

{
  "ok": true
}

400Invalid payload or id

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Not the device owner

Content-Type: application/json

{
  "error": "string"
}

404Device not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/devices/{id}

Auth required

Deactivate your device

Soft-deletes a device owned by the current user.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Device deactivated

Content-Type: application/json

{
  "ok": true
}

400Invalid id

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Not the device owner

Content-Type: application/json

{
  "error": "string"
}

404Device not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/devices/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/devices/admin/devices

Auth required

List devices (admin)

Returns the authenticated user's registered devices (admin) (admins may list across users).

Parameters

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).

Responses

200Paginated devices (admin)

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "tenant_id": "00000000-0000-4000-8000-000000000000",
      "organization_id": null,
      "user_id": "00000000-0000-4000-8000-000000000000",
      "device_id": "string",
      "platform": "ios",
      "client_app_version": null,
      "os_version": null,
      "locale": null,
      "push_provider": null,
      "push_token_updated_at": null,
      "last_seen_at": null,
      "created_at": null,
      "updated_at": null
    }
  ],
  "total": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/devices/admin/devices?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/devices/admin/devices

Auth required

Create device (admin)

Admin: register (idempotently upsert) a device on behalf of any user in the tenant.

Request body (application/json)

{
  "deviceId": "string",
  "platform": "ios",
  "clientAppVersion": null,
  "osVersion": null,
  "locale": null,
  "pushToken": null,
  "pushProvider": null,
  "userId": "00000000-0000-4000-8000-000000000000"
}

Responses

201Device (admin) created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "deviceId": "string",
  "revived": true
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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

Showing 3 of 3 endpoints

POST/onboarding/onboarding

Self-service onboarding submission

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/onboarding/onboarding" \
  -H "Accept: application/json"

GET/onboarding/onboarding/status

Onboarding preparation status

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/onboarding/onboarding/status" \
  -H "Accept: application/json"

GET/onboarding/onboarding/verify

Onboarding verification redirect

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/onboarding/onboarding/verify" \
  -H "Accept: application/json"

API Documentation

Showing 1 of 1 endpoints

GET/version

Deployed Open Mercato version

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/version" \
  -H "Accept: application/json"

Business Rules

Showing 18 of 18 endpoints

POST/business_rules/execute

Auth required

Execute rules for given context

Manually executes applicable business rules for the specified entity type, event, and data. Supports dry-run mode to test rules without executing actions.

Request body (application/json)

{
  "entityType": "string",
  "dryRun": false
}

Responses

200Rules executed successfully

Content-Type: application/json

{
  "allowed": true,
  "executedRules": [
    {
      "ruleId": "string",
      "ruleName": "string",
      "conditionResult": true,
      "executionTime": 1
    }
  ],
  "totalExecutionTime": 1
}

400Invalid request payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Execution error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/business_rules/execute" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"entityType\": \"string\",
  \"dryRun\": false
}"

POST/business_rules/execute/{ruleId}

Auth required

Execute a specific rule by its database UUID

Directly executes a specific business rule identified by its UUID, bypassing the normal entityType/eventType discovery mechanism. Useful for workflows and targeted rule execution.

Parameters

Name	In	Required	Schema	Description
ruleId	path	Yes	any	The database UUID of the business rule to execute

Request body (application/json)

{
  "dryRun": false
}

Responses

200Rule executed successfully

Content-Type: application/json

{
  "success": true,
  "ruleId": "string",
  "ruleName": "string",
  "conditionResult": true,
  "actionsExecuted": null,
  "executionTime": 1
}

400Invalid request payload or rule ID

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Rule not found

Content-Type: application/json

{
  "error": "string"
}

500Execution error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

GET/business_rules/logs

Auth required

List rule execution logs

Returns rule execution history for the current tenant and organization with filtering and pagination. Useful for audit trails and debugging.

Parameters

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	—

Responses

200Rule execution logs collection

Content-Type: application/json

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

400Invalid query parameters

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/business_rules/logs?page=1&pageSize=50&sortDir=desc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/business_rules/logs/{id}

Auth required

Get execution log detail

Returns detailed information about a specific rule execution, including full context and results.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Log entry details

Content-Type: application/json

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

400Invalid log id

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Log entry not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/business_rules/logs/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/business_rules/openmercato-call-options

Auth required

List OpenMercato call action options

Returns executable Open Mercato API endpoint options and safe API key profile metadata for business-rule actions.

Responses

200OpenMercato call options

Content-Type: application/json

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

400Tenant context missing

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Missing required features

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/business_rules/openmercato-call-options" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/business_rules/rules

Auth required

List business rules

Returns business rules for the current tenant and organization with filtering and pagination.

Parameters

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	—

Responses

200Business rules collection

Content-Type: application/json

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

400Invalid query parameters

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/business_rules/rules?page=1&pageSize=50&sortDir=desc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/business_rules/rules

Auth required

Create business rule

Creates a new business rule for the current tenant and organization.

Request body (application/json)

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

Responses

201Business rule created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000"
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/business_rules/rules

Auth required

Update business rule

Updates an existing business rule.

Request body (application/json)

{
  "description": null,
  "ruleCategory": null,
  "eventType": null,
  "enabled": true,
  "priority": 100,
  "version": 1,
  "effectiveFrom": null,
  "effectiveTo": null,
  "conditionExpression": null,
  "successActions": null,
  "failureActions": null,
  "id": "string"
}

Responses

200Business rule updated

Content-Type: application/json

{
  "ok": true
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Business rule not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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\"
}"

DELETE/business_rules/rules

Auth required

Delete business rule

Soft deletes a business rule by identifier.

Parameters

Name	In	Required	Schema	Description
id	query	Yes	any	Business rule identifier

Responses

200Business rule deleted

Content-Type: application/json

{
  "ok": true
}

400Invalid identifier

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Business rule not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/business_rules/rules?id=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/business_rules/rules/{id}

Auth required

Fetch business rule by ID

Returns complete details of a business rule including conditions and actions.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Business rule detail

Content-Type: application/json

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

400Invalid identifier

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Business rule not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/business_rules/rules/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/business_rules/sets

Auth required

List rule sets

Returns rule sets for the current tenant and organization with filtering and pagination.

Parameters

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	—

Responses

200Rule sets collection

Content-Type: application/json

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

400Invalid query parameters

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/business_rules/sets?page=1&pageSize=50&sortDir=asc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/business_rules/sets

Auth required

Create rule set

Creates a new rule set for organizing business rules.

Request body (application/json)

{
  "setId": "string",
  "setName": "string",
  "description": null,
  "enabled": true,
  "tenantId": "string",
  "organizationId": "string",
  "createdBy": null
}

Responses

201Rule set created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000"
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/business_rules/sets

Auth required

Update rule set

Updates an existing rule set.

Request body (application/json)

{
  "description": null,
  "enabled": true,
  "id": "string"
}

Responses

200Rule set updated

Content-Type: application/json

{
  "ok": true
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Rule set not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/business_rules/sets" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"description\": null,
  \"enabled\": true,
  \"id\": \"string\"
}"

DELETE/business_rules/sets

Auth required

Delete rule set

Soft deletes a rule set by identifier.

Parameters

Name	In	Required	Schema	Description
id	query	Yes	any	Rule set identifier

Responses

200Rule set deleted

Content-Type: application/json

{
  "ok": true
}

400Invalid identifier

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Rule set not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/business_rules/sets?id=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/business_rules/sets/{id}

Auth required

Get rule set detail

Returns detailed information about a specific rule set, including all member rules.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Rule set details

Content-Type: application/json

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

400Invalid rule set id

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Rule set not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/business_rules/sets/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/business_rules/sets/{id}/members

Auth required

Add rule to set

Adds a business rule to a rule set with specified sequence and enabled state.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "ruleId": "00000000-0000-4000-8000-000000000000",
  "sequence": 0,
  "enabled": true
}

Responses

201Member added

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000"
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Rule set or rule not found

Content-Type: application/json

{
  "error": "string"
}

409Rule already in set

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/business_rules/sets/{id}/members

Auth required

Update set member

Updates sequence or enabled state of a rule set member.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "memberId": "00000000-0000-4000-8000-000000000000"
}

Responses

200Member updated

Content-Type: application/json

{
  "ok": true
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Member not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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\"
}"

DELETE/business_rules/sets/{id}/members

Auth required

Remove rule from set

Removes a business rule from a rule set (hard delete).

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
memberId	query	Yes	any	Member identifier

Responses

200Member removed

Content-Type: application/json

{
  "ok": true
}

400Invalid identifier

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Member not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/business_rules/sets/:id/members?memberId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Feature Toggles

Showing 12 of 12 endpoints

GET/feature_toggles/check/boolean

Auth required

Check if feature is enabled

Checks if a feature toggle is enabled for the current context.

Parameters

Name	In	Required	Schema	Description
identifier	query	Yes	any	Feature toggle identifier

Responses

200Feature status

Content-Type: application/json

{
  "enabled": true,
  "source": "override",
  "toggleId": "string",
  "identifier": "string",
  "tenantId": "string"
}

400Bad Request

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Tenant not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/feature_toggles/check/boolean?identifier=string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/check/json

Auth required

Get json config

Gets the json configuration for a feature toggle.

Parameters

Name	In	Required	Schema	Description
identifier	query	Yes	any	Feature toggle identifier

Responses

200Json config

Content-Type: application/json

{
  "valueType": "json",
  "source": "override",
  "toggleId": "string",
  "identifier": "string",
  "tenantId": "string"
}

400Bad Request

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Tenant not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/feature_toggles/check/json?identifier=string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/check/number

Auth required

Get number config

Gets the number configuration for a feature toggle.

Parameters

Name	In	Required	Schema	Description
identifier	query	Yes	any	Feature toggle identifier

Responses

200Number config

Content-Type: application/json

{
  "valueType": "number",
  "value": 1,
  "source": "override",
  "toggleId": "string",
  "identifier": "string",
  "tenantId": "string"
}

400Bad Request

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Tenant not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/feature_toggles/check/number?identifier=string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/check/string

Auth required

Get string config

Gets the string configuration for a feature toggle.

Parameters

Name	In	Required	Schema	Description
identifier	query	Yes	any	Feature toggle identifier

Responses

200String config

Content-Type: application/json

{
  "valueType": "string",
  "value": "string",
  "source": "override",
  "toggleId": "string",
  "identifier": "string",
  "tenantId": "string"
}

400Bad Request

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Tenant not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/feature_toggles/check/string?identifier=string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/global

Auth required

List global feature toggles

Returns all global feature toggles with filtering and pagination. Requires superadmin role.

Parameters

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)

Responses

200Feature toggles collection

Content-Type: application/json

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

400Invalid query parameters

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden - superadmin role required

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/feature_toggles/global?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/feature_toggles/global

Auth required

Create global feature toggle

Creates a new global feature toggle. Requires superadmin role.

Request body (application/json)

{
  "identifier": "string",
  "name": "string",
  "description": null,
  "category": null,
  "type": "boolean",
  "defaultValue": null
}

Responses

201Feature toggle created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000"
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden - superadmin role required

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/feature_toggles/global

Auth required

Update global feature toggle

Updates an existing global feature toggle. Requires superadmin role.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "description": null,
  "category": null,
  "defaultValue": null
}

Responses

200Feature toggle updated

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000"
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden - superadmin role required

Content-Type: application/json

{
  "error": "string"
}

404Feature toggle not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/feature_toggles/global

Auth required

Delete global feature toggle

Soft deletes a global feature toggle by ID. Requires superadmin role.

Parameters

Name	In	Required	Schema	Description
id	query	Yes	any	Feature toggle identifier

Responses

200Feature toggle deleted

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000"
}

400Invalid identifier

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden - superadmin role required

Content-Type: application/json

{
  "error": "string"
}

404Feature toggle not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/feature_toggles/global?id=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/global/{id}

Auth required

Fetch feature toggle by ID

Returns complete details of a feature toggle.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Feature toggle detail

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "identifier": "string",
  "name": "string",
  "description": null,
  "category": null,
  "type": "boolean",
  "defaultValue": null,
  "createdAt": null,
  "updatedAt": null
}

400Invalid identifier

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Feature toggle not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/feature_toggles/global/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/global/{id}/override

Auth required

Fetch feature toggle override

Returns feature toggle override.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Feature toggle overrides

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "tenantName": "string",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "toggleType": "boolean",
  "updatedAt": null
}

400Invalid request

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Feature toggle not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/feature_toggles/global/:id/override" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/feature_toggles/overrides

Auth required

List overrides

Returns list of feature toggle overrides.

Parameters

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	—

Responses

200List of overrides

Content-Type: application/json

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

400Invalid query parameters

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/feature_toggles/overrides?page=1&pageSize=25" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/feature_toggles/overrides

Auth required

Change override state

Enable, disable or inherit a feature toggle for a specific tenant.

Request body (application/json)

{
  "toggleId": "00000000-0000-4000-8000-000000000000",
  "isOverride": true
}

Responses

200Override updated

Content-Type: application/json

{
  "ok": true,
  "overrideToggleId": null
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

404Not found

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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

Showing 15 of 15 endpoints

GET/search/embeddings

Auth required

Get embeddings configuration

Returns current embedding provider and model configuration.

Responses

200Embeddings settings

Content-Type: application/json

{
  "settings": {
    "openaiConfigured": true,
    "autoIndexingEnabled": true,
    "autoIndexingLocked": true,
    "lockReason": null,
    "embeddingConfig": null,
    "configuredProviders": [
      "openai"
    ],
    "indexedDimension": null,
    "reindexRequired": true,
    "documentCount": null
  }
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/search/embeddings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/search/embeddings

Auth required

Update embeddings configuration

Updates the embedding provider and model settings.

Request body (application/json)

{}

Responses

200Updated settings

Content-Type: application/json

{
  "settings": {
    "openaiConfigured": true,
    "autoIndexingEnabled": true,
    "autoIndexingLocked": true,
    "lockReason": null,
    "embeddingConfig": null,
    "configuredProviders": [
      "openai"
    ],
    "indexedDimension": null,
    "reindexRequired": true,
    "documentCount": null
  }
}

400Invalid request

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

409Auto-indexing disabled via environment

Content-Type: application/json

{
  "error": "string"
}

500Update failed

Content-Type: application/json

{
  "error": "string"
}

503Configuration service unavailable

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/search/embeddings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{}"

POST/search/embeddings/reindex

Auth required

Trigger vector reindex

Starts a vector embedding reindex operation.

Request body (application/json)

{}

Responses

200Reindex result

Content-Type: application/json

{
  "ok": true
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

409Reindex already in progress

Content-Type: application/json

{
  "error": "string",
  "lock": {
    "type": "fulltext",
    "action": "string",
    "startedAt": "string",
    "elapsedMinutes": 1,
    "processedCount": null,
    "totalCount": null
  }
}

500Reindex failed

Content-Type: application/json

{
  "error": "string"
}

503Search indexer unavailable

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/search/embeddings/reindex" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{}"

POST/search/embeddings/reindex/cancel

Auth required

Cancel vector reindex

Cancels an in-progress vector reindex operation.

Responses

200Cancel result

Content-Type: application/json

{
  "ok": true,
  "jobsRemoved": 1
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/search/embeddings/reindex/cancel" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/search/index

Auth required

List vector index entries

Returns paginated list of entries in the vector search index.

Parameters

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)

Responses

200Index entries

Content-Type: application/json

{
  "entries": [
    {
      "id": "string",
      "entityId": "string",
      "recordId": "string",
      "tenantId": "string",
      "organizationId": null
    }
  ],
  "limit": 1,
  "offset": 1
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Failed to fetch index

Content-Type: application/json

{
  "error": "string"
}

503Vector strategy unavailable

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/search/index" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/search/index

Auth required

Purge vector index

Purges entries from the vector search index. Requires confirmAll=true when purging all entities.

Parameters

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

Responses

200Purge result

Content-Type: application/json

{
  "ok": true
}

400Missing confirmAll parameter

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Purge failed

Content-Type: application/json

{
  "error": "string"
}

503Search indexer unavailable

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/search/index" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/search/reindex

Auth required

Trigger fulltext reindex

Starts a fulltext (Meilisearch) reindex operation. Can clear, recreate, or fully reindex.

Request body (application/json)

{}

Responses

200Reindex result

Content-Type: application/json

{
  "ok": true,
  "action": "clear",
  "entityId": null
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

409Reindex already in progress

Content-Type: application/json

{
  "error": "string",
  "lock": {
    "type": "fulltext",
    "action": "string",
    "startedAt": "string",
    "elapsedMinutes": 1,
    "processedCount": null,
    "totalCount": null
  }
}

500Reindex failed

Content-Type: application/json

{
  "error": "string"
}

503Search service unavailable

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/search/reindex" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{}"

POST/search/reindex/cancel

Auth required

Cancel fulltext reindex

Cancels an in-progress fulltext reindex operation.

Responses

200Cancel result

Content-Type: application/json

{
  "ok": true,
  "jobsRemoved": 1
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/search/reindex/cancel" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/search/search

Auth required

Search across all indexed entities

Performs 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.

Parameters

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

Responses

200Search results

Content-Type: application/json

{
  "results": [
    {
      "entityId": "string",
      "recordId": "string",
      "score": 1,
      "source": "fulltext"
    }
  ],
  "strategiesUsed": [
    "fulltext"
  ],
  "timing": 1,
  "query": "string",
  "limit": 1
}

400Missing query parameter

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Search failed

Content-Type: application/json

{
  "error": "string"
}

503Search service unavailable

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/search/search?q=string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/search/search/global

Auth required

Global search (Cmd+K)

Performs a global search using saved tenant strategies. Does NOT accept strategies from URL.

Parameters

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

Responses

200Search results

Content-Type: application/json

{
  "results": [
    {
      "entityId": "string",
      "recordId": "string",
      "score": 1,
      "source": "fulltext"
    }
  ],
  "strategiesUsed": [
    "fulltext"
  ],
  "strategiesEnabled": [
    "fulltext"
  ],
  "timing": 1,
  "query": "string",
  "limit": 1
}

400Missing query parameter

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Search failed

Content-Type: application/json

{
  "error": "string"
}

503Search service unavailable

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/search/search/global?q=string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/search/settings

Auth required

Get search settings and status

Returns search module configuration, available strategies, and reindex lock status.

Responses

200Search settings

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/search/settings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/search/settings/fulltext

Auth required

Get fulltext search configuration

Returns Meilisearch configuration status and index statistics.

Responses

200Fulltext settings

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/search/settings/fulltext" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/search/settings/global-search

Auth required

Get global search strategies

Returns the enabled strategies for Cmd+K global search.

Responses

200Global search settings

Content-Type: application/json

{
  "enabledStrategies": [
    "fulltext"
  ]
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/search/settings/global-search" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/search/settings/global-search

Auth required

Update global search strategies

Sets which strategies are enabled for Cmd+K global search.

Request body (application/json)

{
  "enabledStrategies": [
    "fulltext"
  ]
}

Responses

200Updated settings

Content-Type: application/json

{
  "ok": true,
  "enabledStrategies": [
    "fulltext"
  ]
}

400Invalid request

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Internal error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/search/settings/global-search" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"enabledStrategies\": [
    \"fulltext\"
  ]
}"

GET/search/settings/vector-store

Auth required

Get vector store configuration

Returns vector store configuration status.

Responses

200Vector store settings

Content-Type: application/json

{
  "currentDriver": "pgvector",
  "configured": true,
  "drivers": [
    {
      "id": "pgvector",
      "name": "string",
      "configured": true,
      "implemented": true,
      "available": null,
      "unavailableReason": null,
      "envVars": [
        {
          "name": "string",
          "set": true,
          "hint": "string"
        }
      ]
    }
  ]
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/search/settings/vector-store" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Currencies

Showing 14 of 14 endpoints

GET/currencies/currencies

Auth required

List currencies

Returns a paginated collection of currencies scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated currencies

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/currencies/currencies?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/currencies/currencies

Auth required

Create currency

Creates a new currency.

Request body (application/json)

{
  "organizationId": "string",
  "tenantId": "string",
  "code": "string",
  "name": "string",
  "symbol": null,
  "thousandsSeparator": null,
  "decimalSeparator": null
}

Responses

201Currency created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/currencies/currencies

Auth required

Update currency

Updates an existing currency by id.

Request body (application/json)

{
  "id": "string",
  "symbol": null,
  "thousandsSeparator": null,
  "decimalSeparator": null
}

Responses

200Currency updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/currencies/currencies

Auth required

Delete currency

Deletes a currency by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Currency deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/currencies/currencies" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/currencies/currencies/options

Auth required

List currency options

Returns currencies formatted for select inputs.

Parameters

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	—

Responses

200Option list

Content-Type: application/json

{
  "items": [
    {
      "value": "string",
      "label": "string"
    }
  ]
}

400Invalid query

Content-Type: application/json

{
  "items": []
}

401Unauthorized

Content-Type: application/json

{
  "items": []
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/currencies/currencies/options?limit=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/currencies/exchange-rates

Auth required

List exchangerates

Returns a paginated collection of exchangerates scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated exchangerates

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/currencies/exchange-rates?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/currencies/exchange-rates

Auth required

Create exchangerate

Creates a new exchange rate.

Request body (application/json)

{
  "organizationId": "string",
  "tenantId": "string",
  "fromCurrencyCode": "string",
  "toCurrencyCode": "string",
  "rate": "string",
  "type": null
}

Responses

201ExchangeRate created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/currencies/exchange-rates

Auth required

Update exchangerate

Updates an existing exchange rate by id.

Request body (application/json)

{
  "id": "string",
  "type": null
}

Responses

200ExchangeRate updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/currencies/exchange-rates" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"string\",
  \"type\": null
}"

DELETE/currencies/exchange-rates

Auth required

Delete exchangerate

Deletes an exchange rate by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200ExchangeRate deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/currencies/exchange-rates" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/currencies/fetch-configs

Auth required

List currency fetch configurations

Returns all currency fetch configurations scoped to the authenticated organization.

Responses

200A list of currency fetch configurations

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/currencies/fetch-configs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/currencies/fetch-configs

Auth required

Create currency fetch configuration

Creates a new currency fetch configuration.

Request body (application/json)

{
  "provider": "NBP",
  "isEnabled": false,
  "syncTime": null,
  "config": null
}

Responses

201Currency fetch configuration created successfully

Content-Type: application/json

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

400Bad request

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/currencies/fetch-configs

Auth required

Update currency fetch configuration

Updates an existing currency fetch configuration by id.

Request body (application/json)

{
  "syncTime": null,
  "config": null,
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Currency fetch configuration updated successfully

Content-Type: application/json

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

400Bad request

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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\"
}"

DELETE/currencies/fetch-configs

Auth required

Delete currency fetch configuration

Deletes a currency fetch configuration by id.

Parameters

Name	In	Required	Schema	Description
id	query	Yes	any	Currency fetch configuration identifier to delete

Responses

200Currency fetch configuration deleted successfully

Content-Type: application/json

{
  "success": true
}

400Bad request

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/currencies/fetch-configs?id=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/currencies/fetch-rates

Fetch currency rates

Fetches currency exchange rates from configured providers for a specific date.

Request body (application/json)

{}

Responses

200Currency rates fetched successfully

Content-Type: application/json

{
  "totalFetched": 1,
  "byProvider": {
    "key": {
      "count": 1
    }
  },
  "errors": [
    "string"
  ]
}

400Bad request

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "totalFetched": 1,
  "byProvider": {
    "key": {
      "count": 1
    }
  },
  "errors": [
    "string"
  ]
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/currencies/fetch-rates" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{}"

Events

Showing 2 of 2 endpoints

GET/events

Auth required

List declared events

Returns every declared event. Filters: category, module, excludeTriggerExcluded (default true).

Responses

200Declared events

Content-Type: application/json

{
  "data": [
    {
      "id": "string",
      "label": "string"
    }
  ],
  "total": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/events" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/events/stream

Auth required

GET /events/stream

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/events/stream" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Notifications

Showing 20 of 22 endpoints

GET/notifications

Auth required

List notifications

Returns a paginated collection of notifications.

Parameters

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).

Responses

200Paginated notifications

Content-Type: application/json

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

403Request could not be resolved to a tenant scope (code: tenant_scope_required)

Content-Type: application/json

{
  "error": "string",
  "code": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/notifications?page=1&pageSize=20" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/notifications

Auth required

Create notification

Creates a notification for a user.

Request body (application/json)

{
  "type": "string",
  "severity": "info",
  "recipientUserId": "00000000-0000-4000-8000-000000000000"
}

Responses

201Notification created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

POST/notifications/{id}/action

Auth required

POST /notifications/{id}/action

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/notifications/:id/action" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/notifications/{id}/dismiss

Auth required

PUT /notifications/{id}/dismiss

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/notifications/:id/dismiss" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/notifications/{id}/read

Auth required

PUT /notifications/{id}/read

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/notifications/:id/read" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/notifications/{id}/restore

Auth required

PUT /notifications/{id}/restore

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/notifications/:id/restore" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/notifications/admin/preferences

Auth required

GET /notifications/admin/preferences

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/notifications/admin/preferences" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/notifications/admin/preferences

Auth required

PUT /notifications/admin/preferences

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/notifications/admin/preferences" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/notifications/batch

Auth required

POST /notifications/batch

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/notifications/batch" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/notifications/channels

Auth required

GET /notifications/channels

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/notifications/channels" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/notifications/feature

Auth required

POST /notifications/feature

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/notifications/feature" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/notifications/mark-all-read

Auth required

PUT /notifications/mark-all-read

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/notifications/mark-all-read" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/notifications/preferences

Auth required

GET /notifications/preferences

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/notifications/preferences" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/notifications/preferences

Auth required

PUT /notifications/preferences

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/notifications/preferences" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/notifications/role

Auth required

POST /notifications/role

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/notifications/role" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/notifications/settings

Auth required

GET /notifications/settings

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/notifications/settings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/notifications/settings

Auth required

POST /notifications/settings

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/notifications/settings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/notifications/types

Auth required

GET /notifications/types

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/notifications/types" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/notifications/types

Auth required

PATCH /notifications/types

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PATCH "https://fixture.omnibus.buscrazy.net/api/notifications/types" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/notifications/types/{id}/channels/{channel}

Auth required

PUT /notifications/types/{id}/channels/{channel}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
channel	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/notifications/types/:id/channels/:channel" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Progress

Showing 6 of 6 endpoints

GET/progress/active

Auth required

GET /progress/active

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/progress/active" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/progress/jobs

Auth required

List progressjobs

Returns a paginated collection of progressjobs scoped to the authenticated tenant.

Parameters

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).

Responses

200Paginated progressjobs

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/progress/jobs?page=1&pageSize=20" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/progress/jobs

Auth required

Create progressjob

Creates a new progress job for tracking a long-running operation.

Request body (application/json)

{
  "jobType": "string",
  "name": "string",
  "cancellable": false
}

Responses

201ProgressJob created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/progress/jobs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"jobType\": \"string\",
  \"name\": \"string\",
  \"cancellable\": false
}"

GET/progress/jobs/{id}

Auth required

GET /progress/jobs/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/progress/jobs/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/progress/jobs/{id}

Auth required

PUT /progress/jobs/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/progress/jobs/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/progress/jobs/{id}

Auth required

DELETE /progress/jobs/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/progress/jobs/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Integrations

Showing 8 of 8 endpoints

GET/integrations

Auth required

List integrations

Returns a paginated collection of integrations.

Parameters

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).

Responses

200Paginated integrations

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/integrations?order=asc&page=1&pageSize=100" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/integrations/{id}

Auth required

Get integration detail

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/integrations/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/integrations/{id}/credentials

Auth required

Get or save integration credentials

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/integrations/:id/credentials" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/integrations/{id}/credentials

Auth required

Get or save integration credentials

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/integrations/:id/credentials" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/integrations/{id}/health

Auth required

Run health check for an integration

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/integrations/:id/health" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/integrations/{id}/state

Auth required

Update integration state

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/integrations/:id/state" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/integrations/{id}/version

Auth required

Change integration API version

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/integrations/:id/version" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/integrations/logs

Auth required

List integration logs

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/integrations/logs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Data Sync

Showing 17 of 17 endpoints

GET/data_sync/mappings

Auth required

List or create field mappings

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/data_sync/mappings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/data_sync/mappings

Auth required

List or create field mappings

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/data_sync/mappings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/data_sync/mappings/{id}

Auth required

Get, update, or delete a field mapping

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/data_sync/mappings/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/data_sync/mappings/{id}

Auth required

Get, update, or delete a field mapping

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/data_sync/mappings/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/data_sync/mappings/{id}

Auth required

Get, update, or delete a field mapping

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/data_sync/mappings/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/data_sync/options

Auth required

List data sync integration options

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/data_sync/options" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/data_sync/run

Auth required

Start a data sync run

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/data_sync/run" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/data_sync/runs

Auth required

List sync runs

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/data_sync/runs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/data_sync/runs/{id}

Auth required

Get sync run detail

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/data_sync/runs/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/data_sync/runs/{id}/cancel

Auth required

Cancel a running sync

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/data_sync/runs/:id/cancel" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/data_sync/runs/{id}/retry

Auth required

Retry a failed sync run

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/data_sync/runs/:id/retry" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/data_sync/schedules

Auth required

List or create sync schedules

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/data_sync/schedules" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/data_sync/schedules

Auth required

List or create sync schedules

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/data_sync/schedules" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/data_sync/schedules/{id}

Auth required

Manage a sync schedule

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/data_sync/schedules/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/data_sync/schedules/{id}

Auth required

Manage a sync schedule

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/data_sync/schedules/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/data_sync/schedules/{id}

Auth required

Manage a sync schedule

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/data_sync/schedules/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/data_sync/validate

Auth required

Validate sync connection

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/data_sync/validate" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Excel / CSV Import

Showing 3 of 3 endpoints

POST/sync_excel/import

Auth required

Start CSV import

Responses

201Import run started

Content-Type: application/json

{
  "runId": "00000000-0000-4000-8000-000000000000",
  "progressJobId": null,
  "status": "pending"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Upload not found

Content-Type: application/json

{
  "error": "string"
}

409Import overlap detected

Content-Type: application/json

{
  "error": "string"
}

422Invalid import payload

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/sync_excel/import" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/sync_excel/preview

Auth required

Fetch upload preview

Responses

200Stored upload preview

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Upload preview not found

Content-Type: application/json

{
  "error": "string"
}

422Invalid query

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/sync_excel/preview" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sync_excel/upload

Auth required

Upload CSV file

Request body (multipart/form-data)

string

Responses

200CSV uploaded and preview parsed

Content-Type: application/json

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

400Invalid multipart payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

413CSV upload exceeds the maximum upload size

Content-Type: application/json

{
  "error": "string"
}

422Unsupported entity type or file type

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/sync_excel/upload" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Messages

Showing 20 of 26 endpoints

GET/messages

Auth required

List messages

Parameters

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	—

Responses

200Message list

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/messages?folder=inbox&page=1&pageSize=20" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/messages

Auth required

Compose a message

Request body (application/json)

{
  "type": "default",
  "visibility": null,
  "recipients": [],
  "subject": "",
  "body": "",
  "bodyFormat": "text",
  "priority": "normal",
  "sendViaEmail": false,
  "isDraft": false
}

Responses

201Message created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "threadId": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

GET/messages/{id}

Auth required

Get message detail

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Message detail with actor-visible thread items only

Content-Type: application/json

{
  "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,
      "body": "string",
      "sentAt": null
    }
  ],
  "isRead": true,
  "conversationArchived": true,
  "conversationAllUnread": true
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/messages/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/messages/{id}

Auth required

Update draft message

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "visibility": null
}

Responses

200Draft updated

Content-Type: application/json

{
  "ok": true
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

409Only drafts can be edited, or the draft was modified concurrently (optimistic lock conflict)

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PATCH "https://fixture.omnibus.buscrazy.net/api/messages/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"visibility\": null
}"

DELETE/messages/{id}

Auth required

Delete message for current sender/recipient context

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Message deleted

Content-Type: application/json

{
  "ok": true
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

409Message was modified concurrently (optimistic lock conflict)

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/messages/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/messages/{id}/actions/{actionId}

Auth required

Execute message action

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
actionId	path	Yes	any	—

Request body (application/json)

"string"

Responses

200Action executed

Content-Type: application/json

{
  "ok": true,
  "actionId": "string"
}

403Access denied

Content-Type: application/json

"string"

404Action not found

Content-Type: application/json

"string"

409Action already taken, or the message was modified concurrently (optimistic lock conflict)

Content-Type: application/json

"string"

410Action expired

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/messages/:id/actions/:actionId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/messages/{id}/archive

Auth required

Archive message

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Message archived

Content-Type: application/json

{
  "ok": true
}

403Access denied or sender-only message cannot be archived

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/messages/:id/archive" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/messages/{id}/archive

Auth required

Unarchive message

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Message unarchived

Content-Type: application/json

{
  "ok": true
}

403Access denied or sender-only message cannot be unarchived

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/messages/:id/archive" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/messages/{id}/attachments

Auth required

List message attachments

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Attachments

Content-Type: application/json

{
  "attachments": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "fileName": "string",
      "fileSize": 1,
      "mimeType": "string",
      "url": "string"
    }
  ]
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/messages/:id/attachments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/messages/{id}/attachments

Auth required

Link attachments to draft message

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "attachmentIds": [
    "00000000-0000-4000-8000-000000000000"
  ]
}

Responses

200Attachments linked

Content-Type: application/json

{
  "ok": true
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

409Only draft messages can be edited

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/messages/:id/attachments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"attachmentIds\": [
    \"00000000-0000-4000-8000-000000000000\"
  ]
}"

DELETE/messages/{id}/attachments

Auth required

Unlink attachments from draft message

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{}

Responses

200Attachments unlinked

Content-Type: application/json

{
  "ok": true
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

409Only draft messages can be edited

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/messages/:id/attachments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{}"

GET/messages/{id}/confirmation

Auth required

Read message confirmation status

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Confirmation status

Content-Type: application/json

{
  "messageId": "00000000-0000-4000-8000-000000000000",
  "confirmed": true,
  "confirmedAt": null,
  "confirmedByUserId": null
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/messages/:id/confirmation" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/messages/{id}/conversation

Auth required

Delete conversation for current actor

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Conversation deleted

Content-Type: application/json

{
  "ok": true,
  "affectedCount": 1
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/messages/:id/conversation" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/messages/{id}/conversation/archive

Auth required

Archive conversation for current actor

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Conversation archived

Content-Type: application/json

{
  "ok": true,
  "affectedCount": 1
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/messages/:id/conversation/archive" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/messages/{id}/conversation/archive

Auth required

Unarchive conversation for current actor

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Conversation unarchived

Content-Type: application/json

{
  "ok": true,
  "affectedCount": 1
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/messages/:id/conversation/archive" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/messages/{id}/conversation/read

Auth required

Mark entire conversation as read for current actor

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Conversation marked read

Content-Type: application/json

{
  "ok": true,
  "affectedCount": 1
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/messages/:id/conversation/read" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/messages/{id}/conversation/read

Auth required

Mark entire conversation as unread for current actor

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Conversation marked unread

Content-Type: application/json

{
  "ok": true,
  "affectedCount": 1
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/messages/:id/conversation/read" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/messages/{id}/forward

Auth required

Forward a message and optionally include attachments from the forwarded conversation slice

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "recipients": [
    {
      "userId": "00000000-0000-4000-8000-000000000000",
      "type": "to"
    }
  ],
  "includeAttachments": true,
  "sendViaEmail": false
}

Responses

201Message forwarded

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000"
}

403Access denied

Content-Type: application/json

"string"

404Message not found

Content-Type: application/json

"string"

409Forward not allowed for message type

Content-Type: application/json

"string"

413Forward body exceeds maximum length

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

GET/messages/{id}/forward-preview

Auth required

Get forward preview for a message

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Forward preview generated

Content-Type: application/json

{
  "subject": "string",
  "body": "string"
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

413Forward body exceeds maximum length

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/messages/:id/forward-preview" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/messages/{id}/read

Auth required

Mark message as read

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Message marked read

Content-Type: application/json

{
  "ok": true
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Message not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/messages/:id/read" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Communication Channels

Showing 1 of 1 endpoints

DELETE/communication_channels/channels/{id}

Auth required

DELETE /communication_channels/channels/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/communication_channels/channels/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Push Notifications

Showing 1 of 1 endpoints

POST/push_notifications/custom-send

Auth required

POST /push_notifications/custom-send

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/push_notifications/custom-send" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

AI Assistant

Showing 20 of 40 endpoints

GET/ai_assistant/ai/actions/{id}

Auth required

Fetch the current state of an AI pending action by 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.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Serialized pending action. Never includes normalizedInput, createdByUserId, or idempotencyKey.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks the `ai_assistant.view` feature.

Content-Type: application/json

"string"

404No pending action with the given id is accessible to the caller.

Content-Type: application/json

"string"

500Internal runtime failure.

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/actions/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/ai_assistant/ai/actions/{id}/cancel

Auth required

Cancel an AI pending action without executing the wrapped tool.

Flips 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.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Cancellation complete (or idempotent replay); body includes the serialized pending action with status `cancelled`.

Content-Type: application/json

"string"

400Invalid cancel request body (unknown field, reason exceeds 500 chars, wrong type).

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks `ai_assistant.view`.

Content-Type: application/json

"string"

404Pending action not found in the caller scope.

Content-Type: application/json

"string"

409Pending action is not in `pending` status (already confirmed/failed/executing) or has expired.

Content-Type: application/json

"string"

500Unexpected server failure during cancel.

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/actions/:id/cancel" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/ai_assistant/ai/actions/{id}/confirm

Auth required

Confirm an AI pending action, re-running every server-side check before execution.

Re-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.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Confirmation complete; body includes the serialized pending action and the mutation result.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks `ai_assistant.view`, a required agent feature, tool whitelist, or accesses attachments outside their tenant.

Content-Type: application/json

"string"

404Pending action or agent not found in the caller scope.

Content-Type: application/json

"string"

409Pending action is not in `pending` status or has expired.

Content-Type: application/json

"string"

412Record version changed between propose and confirm, or the input schema no longer accepts the stored payload.

Content-Type: application/json

"string"

500Unexpected server failure during confirm.

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/actions/:id/confirm" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/agents

Auth required

List registered AI agents, filtered by the caller's features.

Returns `{ 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.

Responses

200Accessible agent summaries.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

500Internal failure while loading the agent registry.

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/agents" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/agents/{agentId}/loop-override

Auth required

Read the current loop-policy override for this agent, if any.

Returns `{ agentId, override }` where `override` is the agent-scoped loop-policy row from `ai_agent_runtime_overrides` (or `null`). Requires `ai_assistant.view`.

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

200Loop override payload.

Content-Type: application/json

"string"

400Invalid agent id.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks `ai_assistant.view`.

Content-Type: application/json

"string"

404Unknown agent id.

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/agents/:agentId/loop-override" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/ai_assistant/ai/agents/{agentId}/loop-override

Auth required

Set (or replace) the tenant-scoped loop-policy override for this agent.

Body: loop columns. All fields are nullable/optional; `null` explicitly clears that axis. Validates `loopStopWhenJson` items and `loopActiveToolsJson` membership. Requires `ai_assistant.settings.manage`.

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Request body (application/json)

{
  "loopDisabled": null,
  "loopMaxSteps": null,
  "loopMaxToolCalls": null,
  "loopMaxWallClockMs": null,
  "loopMaxTokens": null,
  "loopStopWhenJson": null,
  "loopActiveToolsJson": null
}

Responses

200Override persisted.

Content-Type: application/json

"string"

400Invalid agent id or validation error.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks `ai_assistant.settings.manage`.

Content-Type: application/json

"string"

404Unknown agent id.

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/ai_assistant/ai/agents/{agentId}/loop-override

Auth required

Remove the loop-policy columns from the agent-scoped runtime override row.

Nulls 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`.

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

200Loop override cleared (or already absent).

Content-Type: application/json

"string"

400Invalid agent id.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks `ai_assistant.settings.manage`.

Content-Type: application/json

"string"

404Unknown agent id.

Content-Type: application/json

"string"

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/agents/:agentId/loop-override" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/agents/{agentId}/models

Auth required

Get the providers and curated models available for the chat-UI picker for this agent

Returns 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`).

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

200Providers and curated models available for the agent picker. Empty `providers` array when `allowRuntimeOverride` is false. `degraded` is `false` and `degradedReason` is `null` on a fully resolved response; `degraded: true` with `degradedReason: "tenant_allowlist_unavailable"` means a tenant-scoped lookup failed, so `providers` may be missing the tenant allowlist and/or the per-agent override narrowing — one code covers the whole tenant-scoped block because no client can act differently per source. Clients SHOULD render the list but MUST NOT treat it as the tenant's authoritative entitlement (for example, do not prune a stored model selection against it).

Content-Type: application/json

"string"

401Unauthenticated.

Content-Type: application/json

"string"

403Caller lacks the agent's required features.

Content-Type: application/json

"string"

404Unknown agent id.

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/agents/:agentId/models" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/agents/{agentId}/mutation-policy

Auth required

Read the effective mutationPolicy for an agent — code-declared value plus any tenant override.

Returns `{ 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`.

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

200Effective mutationPolicy payload.

Content-Type: application/json

"string"

400Invalid agent id.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks `ai_assistant.view`.

Content-Type: application/json

"string"

404Unknown agent id.

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/agents/:agentId/mutation-policy" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/ai_assistant/ai/agents/{agentId}/mutation-policy

Auth required

Set (or replace) the tenant-scoped mutationPolicy override for this agent.

Body: `{ 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`.

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Request body (application/json)

{
  "mutationPolicy": "read-only"
}

Responses

200Override persisted.

Content-Type: application/json

"string"

400Invalid agent id, malformed body, or escalation attempt.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks `ai_assistant.settings.manage`.

Content-Type: application/json

"string"

404Unknown agent id.

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

DELETE/ai_assistant/ai/agents/{agentId}/mutation-policy

Auth required

Remove the tenant-scoped mutationPolicy override for this agent.

Deletes 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`.

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

200Override cleared (or already absent).

Content-Type: application/json

"string"

400Invalid agent id.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks `ai_assistant.settings.manage`.

Content-Type: application/json

"string"

404Unknown agent id.

Content-Type: application/json

"string"

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/agents/:agentId/mutation-policy" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/agents/{agentId}/prompt-override

Read the latest prompt-section override for an agent plus recent version history.

Returns `{ 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`.

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Responses

200Latest override + recent version history.

Content-Type: application/json

"string"

400Invalid agent id.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks `ai_assistant.settings.manage`.

Content-Type: application/json

"string"

404Unknown agent id.

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/agents/:agentId/prompt-override" \
  -H "Accept: application/json"

POST/ai_assistant/ai/agents/{agentId}/prompt-override

Save a new prompt-section override version for the agent.

Persists 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`.

Parameters

Name	In	Required	Schema	Description
agentId	path	Yes	any	—

Request body (application/json)

{}

Responses

200Override persisted. Returns `{ ok: true, version, updatedAt }`.

Content-Type: application/json

"string"

400Invalid agent id, malformed body, or reserved policy key.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks `ai_assistant.settings.manage`.

Content-Type: application/json

"string"

404Unknown agent id.

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/agents/:agentId/prompt-override" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{}"

POST/ai_assistant/ai/chat

Auth required

Stream a chat turn for a registered AI agent

Dispatches 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`.

Parameters

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	—

Request body (application/json)

{
  "messages": [
    {
      "role": "user",
      "content": "string"
    }
  ]
}

Responses

200Streaming text/event-stream response compatible with AI SDK chat transports.

Content-Type: text/event-stream

string

400Invalid query param, malformed payload, or message count above the cap. Typed codes: `runtime_override_disabled` (agent has allowRuntimeOverride:false), `provider_unknown` (provider id not registered), `provider_not_configured` (provider registered but no API key in env), `baseurl_not_allowlisted` (baseUrl not in AI_RUNTIME_BASEURL_ALLOWLIST).

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks agent-level or tool-level required features.

Content-Type: application/json

"string"

404Unknown agent id.

Content-Type: application/json

"string"

409Agent/tool/execution-mode policy violation.

Content-Type: application/json

"string"

500Internal runtime failure.

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
    }
  ]
}"

GET/ai_assistant/ai/conversations

Auth required

List AI chat conversations visible to the caller.

Returns `{ 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.

Responses

200Caller-owned conversation summaries.

Content-Type: application/json

"string"

400Invalid query parameters.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks the `ai_assistant.view` feature.

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/conversations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/ai_assistant/ai/conversations

Auth required

Idempotently create a new AI chat conversation.

If 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.

Responses

200Existing conversation (idempotent path).

Content-Type: application/json

"string"

201Newly created conversation.

Content-Type: application/json

"string"

400Invalid request body.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks the `ai_assistant.view` feature.

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/conversations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/conversations/{conversationId}

Auth required

Fetch a conversation summary and recent transcript.

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.

Parameters

Name	In	Required	Schema	Description
conversationId	path	Yes	any	—

Responses

200Conversation transcript page for the authenticated owner.

Content-Type: application/json

"string"

400Invalid path or query parameters.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks the `ai_assistant.view` feature.

Content-Type: application/json

"string"

404No conversation accessible to the caller.

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/conversations/:conversationId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/ai_assistant/ai/conversations/{conversationId}

Auth required

Update an existing conversation.

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.

Parameters

Name	In	Required	Schema	Description
conversationId	path	Yes	any	—

Responses

200Updated conversation summary.

Content-Type: application/json

"string"

400Invalid request body.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks the `ai_assistant.view` feature.

Content-Type: application/json

"string"

404No conversation accessible to the caller.

Content-Type: application/json

"string"

Example

curl -X PATCH "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/conversations/:conversationId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/ai_assistant/ai/conversations/{conversationId}

Auth required

Soft-delete a conversation and its messages.

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.

Parameters

Name	In	Required	Schema	Description
conversationId	path	Yes	any	—

Responses

200Soft-delete acknowledgment.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks the `ai_assistant.view` feature.

Content-Type: application/json

"string"

404No conversation accessible to the caller.

Content-Type: application/json

"string"

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/conversations/:conversationId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/ai_assistant/ai/conversations/{conversationId}/participants

Auth required

List active participants of a conversation.

Returns 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.

Parameters

Name	In	Required	Schema	Description
conversationId	path	Yes	any	—

Responses

200List of active participants.

Content-Type: application/json

"string"

401Unauthenticated caller.

Content-Type: application/json

"string"

403Caller lacks required features.

Content-Type: application/json

"string"

404Conversation not found or not accessible.

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/ai_assistant/ai/conversations/:conversationId/participants" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Entity Translations

Showing 2 of 2 endpoints

GET/translations/locales

List supported translation locales

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/translations/locales" \
  -H "Accept: application/json"

PUT/translations/locales

Update supported translation locales

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/translations/locales" \
  -H "Accept: application/json"

Scheduler

Showing 8 of 8 endpoints

GET/scheduler/jobs

Auth required

List scheduledjobs

Returns a paginated collection of scheduledjobs scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated scheduledjobs

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/scheduler/jobs?page=1&pageSize=20" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/scheduler/jobs

Auth required

Create scheduledjob

Creates a new scheduled job with cron or interval-based scheduling.

Request body (application/json)

{
  "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,
  "sourceType": "user",
  "sourceModule": null
}

Responses

201ScheduledJob created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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,
  \"sourceType\": \"user\",
  \"sourceModule\": null
}"

PUT/scheduler/jobs

Auth required

Update scheduledjob

Updates an existing scheduled job by ID.

Request body (application/json)

{
  "id": "string",
  "description": null,
  "targetQueue": null,
  "targetCommand": null,
  "targetPayload": null,
  "requireFeature": null
}

Responses

200ScheduledJob updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/scheduler/jobs

Auth required

Delete scheduledjob

Deletes a scheduled job by ID.

Request body (application/json)

{
  "id": "string"
}

Responses

200ScheduledJob deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/scheduler/jobs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"string\"
}"

GET/scheduler/jobs/{id}/executions

Get execution history for a schedule

Fetch recent executions from BullMQ for a scheduled job. Requires QUEUE_STRATEGY=async.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
pageSize	query	No	any	—

Responses

200Execution history

Content-Type: application/json

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

400Local strategy not supported

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Schedule not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/scheduler/jobs/:id/executions?pageSize=20" \
  -H "Accept: application/json"

GET/scheduler/queue-jobs/{jobId}

Get BullMQ job details and logs

Fetch detailed information and logs for a queue job. Requires QUEUE_STRATEGY=async.

Parameters

Name	In	Required	Schema	Description
jobId	path	Yes	any	—
queue	query	Yes	any	—

Responses

200Job details and logs

Content-Type: application/json

{
  "id": "string",
  "name": "string",
  "state": "waiting",
  "progress": null,
  "returnvalue": null,
  "failedReason": null,
  "stacktrace": null,
  "attemptsMade": 1,
  "processedOn": null,
  "finishedOn": null,
  "logs": [
    "string"
  ]
}

400Invalid request or local strategy not supported

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Job not found

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/scheduler/queue-jobs/:jobId?queue=string" \
  -H "Accept: application/json"

GET/scheduler/targets

List available queues and commands

Returns all registered queue names (from module workers) and explicitly scheduler-safe command IDs that can be used as schedule targets.

Responses

200Available targets

Content-Type: application/json

{
  "queues": [
    {
      "value": "string",
      "label": "string"
    }
  ],
  "commands": [
    {
      "value": "string",
      "label": "string"
    }
  ]
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/scheduler/targets" \
  -H "Accept: application/json"

POST/scheduler/trigger

Manually trigger a schedule

Executes a scheduled job immediately, bypassing the scheduled time. Only works with async queue strategy.

Request body (application/json)

{
  "id": "string"
}

Responses

200Schedule triggered successfully

Content-Type: application/json

{
  "ok": true,
  "jobId": "string",
  "message": "string"
}

400Invalid request or local strategy not supported

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Access denied

Content-Type: application/json

{
  "error": "string"
}

404Schedule not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/scheduler/trigger" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"string\"
}"

Checkout

Showing 18 of 18 endpoints

GET/checkout/links

Auth required

GET /checkout/links

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/checkout/links" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/checkout/links

Auth required

POST /checkout/links

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/checkout/links" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/links/{id}

Auth required

GET /checkout/links/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/checkout/links/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/checkout/links/{id}

Auth required

PUT /checkout/links/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/checkout/links/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/checkout/links/{id}

Auth required

DELETE /checkout/links/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/checkout/links/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/pay/{slug}

GET /checkout/pay/{slug}

Parameters

Name	In	Required	Schema	Description
slug	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/checkout/pay/:slug" \
  -H "Accept: application/json"

GET/checkout/pay/{slug}/status/{transactionId}

GET /checkout/pay/{slug}/status/{transactionId}

Parameters

Name	In	Required	Schema	Description
slug	path	Yes	any	—
transactionId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/checkout/pay/:slug/status/:transactionId" \
  -H "Accept: application/json"

POST/checkout/pay/{slug}/submit

POST /checkout/pay/{slug}/submit

Parameters

Name	In	Required	Schema	Description
slug	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

429Too many payment attempts

Content-Type: application/json

{
  "error": "string"
}

503Rate limiting could not be enforced, so the payment was rejected

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/checkout/pay/:slug/submit" \
  -H "Accept: application/json"

POST/checkout/pay/{slug}/verify-password

POST /checkout/pay/{slug}/verify-password

Parameters

Name	In	Required	Schema	Description
slug	path	Yes	any	—

Responses

201Success response

Content-Type: application/json

"string"

429Too many password attempts

Content-Type: application/json

{
  "error": "string"
}

503Rate limiting could not be enforced, so the attempt was rejected

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/checkout/pay/:slug/verify-password" \
  -H "Accept: application/json"

GET/checkout/templates

Auth required

GET /checkout/templates

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/checkout/templates" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/checkout/templates

Auth required

POST /checkout/templates

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/checkout/templates" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/templates/{id}

Auth required

GET /checkout/templates/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/checkout/templates/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/checkout/templates/{id}

Auth required

PUT /checkout/templates/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/checkout/templates/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/checkout/templates/{id}

Auth required

DELETE /checkout/templates/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Success

No response body.

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/checkout/templates/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/templates/{id}/preview

Auth required

GET /checkout/templates/{id}/preview

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/checkout/templates/:id/preview" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/transactions

Auth required

GET /checkout/transactions

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/checkout/transactions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/transactions/{id}

Auth required

GET /checkout/transactions/{id}

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/checkout/transactions/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/checkout/transactions/by-gateway/{gatewayTransactionId}

Auth required

GET /checkout/transactions/by-gateway/{gatewayTransactionId}

Parameters

Name	In	Required	Schema	Description
gatewayTransactionId	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/checkout/transactions/by-gateway/:gatewayTransactionId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Akeneo Product Sync

Showing 6 of 6 endpoints

GET/sync_akeneo/custom-fields

Auth required

Inspect and create Akeneo-backed custom fields

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/sync_akeneo/custom-fields" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sync_akeneo/custom-fields

Auth required

Inspect and create Akeneo-backed custom fields

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/sync_akeneo/custom-fields" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sync_akeneo/delete-products

Auth required

Start deleting all Akeneo-imported products for the current organization

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/sync_akeneo/delete-products" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/sync_akeneo/discovery

Auth required

Load Akeneo discovery metadata for field mapping

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/sync_akeneo/discovery" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/sync_akeneo/first-import

Auth required

GET /sync_akeneo/first-import

Responses

200Success response

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/sync_akeneo/first-import" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sync_akeneo/first-import

Auth required

POST /sync_akeneo/first-import

Responses

201Success response

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/sync_akeneo/first-import" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Webhooks

Showing 20 of 24 endpoints

GET/webhooks

Auth required

List webhooks

Returns paginated webhooks for the current tenant and organization.

Parameters

Name	In	Required	Schema	Description
page	query	No	any	—
pageSize	query	No	any	—
search	query	No	any	—
isActive	query	No	any	—

Responses

200Webhook collection

Content-Type: application/json

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

400Tenant context missing

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/webhooks" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/webhooks

Auth required

Create webhook

Creates a new webhook endpoint. A signing secret (whsec_ prefixed) is auto-generated and returned once.

Request body (application/json)

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

Responses

201Webhook created

Content-Type: application/json

{
  "id": "string",
  "name": "string",
  "url": "string",
  "secret": "string",
  "subscribedEvents": [
    "string"
  ],
  "isActive": true
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

GET/webhooks/{id}

Auth required

Get webhook

Returns webhook configuration, masked secret metadata, and delivery settings.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Webhook detail

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Webhook not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/webhooks/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/webhooks/{id}

Auth required

Update webhook

Updates a single webhook configuration.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "description": null,
  "httpMethod": "POST",
  "customHeaders": null,
  "deliveryStrategy": "http",
  "strategyConfig": null,
  "maxRetries": 10,
  "timeoutMs": 15000,
  "rateLimitPerMinute": 0,
  "autoDisableThreshold": 100,
  "integrationId": null
}

Responses

200Webhook updated

Content-Type: application/json

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

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Webhook not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/webhooks/00000000-0000-4000-8000-000000000000" \
  -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
}"

DELETE/webhooks/{id}

Auth required

Delete webhook

Soft-deletes a webhook endpoint.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Webhook deleted

Content-Type: application/json

{
  "success": true
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Webhook not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/webhooks/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/webhooks/{id}/rotate-secret

Auth required

Rotate secret

Returns the new secret once. Store it immediately; future reads only expose a masked value.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Secret rotated

Content-Type: application/json

{
  "success": true,
  "secret": "string",
  "previousSecretSetAt": null
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Webhook not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/webhooks/00000000-0000-4000-8000-000000000000/rotate-secret" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/webhooks/{id}/test

Auth required

Test webhook

Creates a synthetic event payload and delivers it immediately without using the queue.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{}

Responses

200Test delivery result

Content-Type: application/json

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

400Invalid request payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Webhook not found

Content-Type: application/json

{
  "error": "string"
}

409Webhook integration disabled

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/webhooks/00000000-0000-4000-8000-000000000000/test" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{}"

GET/webhooks/deliveries

Auth required

List delivery logs

Returns paginated webhook delivery attempts with filtering by webhook, event type, and status.

Parameters

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	—

Responses

200Delivery log collection

Content-Type: application/json

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

400Tenant context missing

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/webhooks/deliveries?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/webhooks/deliveries/{id}

Auth required

Get delivery

Returns a single delivery attempt by ID.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Delivery detail

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Delivery not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/webhooks/deliveries/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/webhooks/deliveries/{id}/retry

Auth required

Retry delivery

Resets retry scheduling fields and enqueues the delivery again.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Delivery re-enqueued

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Delivery not found

Content-Type: application/json

{
  "error": "string"
}

409Webhook integration disabled

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/webhooks/deliveries/00000000-0000-4000-8000-000000000000/retry" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/webhooks/events

Auth required

List webhook events

Returns all declared non-webhook events, sorted by event id.

Responses

200Available events

Content-Type: application/json

{
  "data": [
    {
      "id": "string",
      "label": "string"
    }
  ],
  "total": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/webhooks/events" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/webhooks/inbound/{endpointId}

Receive inbound webhook

The endpoint id resolves to a registered webhook source first (module-level handler dispatch), otherwise to a legacy adapter provider key.

Parameters

Name	In	Required	Schema	Description
endpointId	path	Yes	any	—

Responses

200Inbound webhook accepted

Content-Type: application/json

{
  "ok": true
}

400Verification failed or stale webhook timestamp

Content-Type: application/json

{
  "error": "string"
}

401Signature verification failed (source flow)

Content-Type: application/json

{
  "error": "string"
}

404Endpoint not found

Content-Type: application/json

{
  "error": "string"
}

413Webhook payload too large

Content-Type: application/json

{
  "error": "string"
}

429Rate limit exceeded

Content-Type: application/json

{
  "error": "string"
}

503Webhook integration disabled

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/webhooks/inbound/string" \
  -H "Accept: application/json"

GET/webhooks/webhook-deliveries

Auth required

List delivery logs

Returns paginated webhook delivery attempts with filtering by webhook, event type, and status.

Parameters

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	—

Responses

200Delivery log collection

Content-Type: application/json

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

400Tenant context missing

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/webhooks/webhook-deliveries?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/webhooks/webhook-deliveries/{id}

Auth required

Get delivery

Returns a single delivery attempt by ID.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Delivery detail

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Delivery not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/webhooks/webhook-deliveries/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/webhooks/webhook-deliveries/{id}/retry

Auth required

Retry delivery

Resets retry scheduling fields and enqueues the delivery again.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Delivery re-enqueued

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Delivery not found

Content-Type: application/json

{
  "error": "string"
}

409Webhook integration disabled

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/webhooks/webhook-deliveries/00000000-0000-4000-8000-000000000000/retry" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/webhooks/webhooks

Auth required

List webhooks

Returns paginated webhooks for the current tenant and organization.

Parameters

Name	In	Required	Schema	Description
page	query	No	any	—
pageSize	query	No	any	—
search	query	No	any	—
isActive	query	No	any	—

Responses

200Webhook collection

Content-Type: application/json

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

400Tenant context missing

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/webhooks/webhooks" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/webhooks/webhooks

Auth required

Create webhook

Creates a new webhook endpoint. A signing secret (whsec_ prefixed) is auto-generated and returned once.

Request body (application/json)

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

Responses

201Webhook created

Content-Type: application/json

{
  "id": "string",
  "name": "string",
  "url": "string",
  "secret": "string",
  "subscribedEvents": [
    "string"
  ],
  "isActive": true
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/webhooks/webhooks

Auth required

Update webhook

Updates an existing webhook configuration.

Request body (application/json)

{
  "description": null,
  "httpMethod": "POST",
  "customHeaders": null,
  "deliveryStrategy": "http",
  "strategyConfig": null,
  "maxRetries": 10,
  "timeoutMs": 15000,
  "rateLimitPerMinute": 0,
  "autoDisableThreshold": 100,
  "integrationId": null
}

Responses

200Webhook updated

Content-Type: application/json

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

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

404Not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/webhooks/webhooks

Auth required

Delete webhook

Soft-deletes a webhook endpoint.

Parameters

Name	In	Required	Schema	Description
id	query	Yes	any	Webhook ID to delete

Responses

200Deleted

Content-Type: application/json

{
  "success": true
}

403Forbidden

Content-Type: application/json

{
  "error": "string"
}

404Not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/webhooks/webhooks?id=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/webhooks/webhooks/{id}

Auth required

Get webhook

Returns webhook configuration, masked secret metadata, and delivery settings.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Webhook detail

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Webhook not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/webhooks/webhooks/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Customer Portal

Showing 19 of 19 endpoints

GET/customer_accounts/portal/events/stream

Subscribe to portal events via SSE (Portal Event Bridge)

Long-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.

Responses

200Event stream (text/event-stream)

Content-Type: application/json

"string"

401Not authenticated

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/events/stream" \
  -H "Accept: application/json"

POST/customer_accounts/portal/feature-check

Check customer portal feature access

Checks which of the requested features the authenticated customer user has. Used by portal menu injection for feature-gating.

Request body (application/json)

{
  "features": [
    "string"
  ]
}

Responses

200Feature check result

Content-Type: application/json

{
  "ok": true,
  "granted": [
    "string"
  ]
}

400Invalid request

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/feature-check" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"features\": [
    \"string\"
  ]
}"

POST/customer_accounts/portal/logout

Customer logout

Revokes the current session and clears authentication cookies.

Responses

200Logged out

Content-Type: application/json

{
  "ok": true
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/logout" \
  -H "Accept: application/json"

GET/customer_accounts/portal/nav

Portal sidebar navigation

Returns 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.

Responses

200Portal sidebar groups

Content-Type: application/json

{
  "ok": true,
  "orgSlug": "string",
  "groups": [
    {
      "id": "main",
      "items": [
        {
          "id": "string",
          "label": "string",
          "href": "string",
          "order": 1
        }
      ]
    }
  ],
  "grantedFeatures": [
    "string"
  ],
  "isPortalAdmin": true
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404Organization not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/nav" \
  -H "Accept: application/json"

GET/customer_accounts/portal/notifications

List customer notifications

Returns paginated notifications for the authenticated customer user. Dismissed notifications are excluded by default unless ?status=dismissed is specified.

Responses

200Notification list

Content-Type: application/json

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

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/notifications" \
  -H "Accept: application/json"

PUT/customer_accounts/portal/notifications/{id}/dismiss

Dismiss notification

Dismisses a single notification for the authenticated customer user.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Notification dismissed

Content-Type: application/json

{
  "ok": true
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404Notification not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/notifications/00000000-0000-4000-8000-000000000000/dismiss" \
  -H "Accept: application/json"

PUT/customer_accounts/portal/notifications/{id}/read

Mark notification as read

Marks a single notification as read for the authenticated customer user.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Notification marked as read

Content-Type: application/json

{
  "ok": true
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404Notification not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/notifications/00000000-0000-4000-8000-000000000000/read" \
  -H "Accept: application/json"

PUT/customer_accounts/portal/notifications/mark-all-read

Mark all notifications as read

Marks all unread notifications as read for the authenticated customer user.

Responses

200All notifications marked as read

Content-Type: application/json

{
  "ok": true,
  "count": 1
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/notifications/mark-all-read" \
  -H "Accept: application/json"

GET/customer_accounts/portal/notifications/unread-count

Get unread notification count

Returns the number of unread notifications for the authenticated customer user.

Responses

200Unread count

Content-Type: application/json

{
  "ok": true,
  "unreadCount": 1
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/notifications/unread-count" \
  -H "Accept: application/json"

POST/customer_accounts/portal/password-change

Change customer password

Changes the authenticated customer user password after verifying the current password. Revokes all existing sessions.

Request body (application/json)

{
  "currentPassword": "string",
  "newPassword": "string"
}

Responses

200Password changed

Content-Type: application/json

{
  "ok": true
}

400Current password incorrect or validation failed

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/password-change" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"currentPassword\": \"string\",
  \"newPassword\": \"string\"
}"

GET/customer_accounts/portal/profile

Get customer profile

Returns the authenticated customer user profile with roles and permissions.

Responses

200Profile data

Content-Type: application/json

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

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/profile" \
  -H "Accept: application/json"

PUT/customer_accounts/portal/profile

Update customer profile

Updates the authenticated customer user profile.

Request body (application/json)

{}

Responses

200Profile updated

Content-Type: application/json

{
  "ok": true,
  "user": {
    "id": "00000000-0000-4000-8000-000000000000",
    "email": "string",
    "displayName": "string"
  }
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/profile" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{}"

GET/customer_accounts/portal/sessions

List customer sessions

Returns active sessions for the authenticated customer user.

Responses

200Session list

Content-Type: application/json

{
  "ok": true,
  "sessions": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "ipAddress": null,
      "userAgent": null,
      "lastUsedAt": null,
      "createdAt": "string",
      "expiresAt": "string",
      "isCurrent": true
    }
  ]
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/sessions" \
  -H "Accept: application/json"

POST/customer_accounts/portal/sessions-refresh

Refresh customer JWT from session token

Uses the session cookie to issue a fresh JWT access token.

Responses

200Token refreshed

Content-Type: application/json

{
  "ok": true,
  "resolvedFeatures": [
    "string"
  ]
}

401Invalid session

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/sessions-refresh" \
  -H "Accept: application/json"

DELETE/customer_accounts/portal/sessions/{id}

Revoke a customer session

Revokes a specific session (not the current one).

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Session revoked

Content-Type: application/json

{
  "ok": true
}

400Cannot revoke current session

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404Session not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/sessions/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json"

GET/customer_accounts/portal/users

List company portal users

Lists portal users associated with the same company. Paginated (default pageSize 25, max 100).

Parameters

Name	In	Required	Schema	Description
page	query	No	any	—
pageSize	query	No	any	—

Responses

200Paginated user list

Content-Type: application/json

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

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/users" \
  -H "Accept: application/json"

POST/customer_accounts/portal/users-invite

Invite a user to the company portal

Creates an invitation for a new user to join the company portal.

Request body (application/json)

{
  "email": "user@example.com",
  "roleIds": [
    "00000000-0000-4000-8000-000000000000"
  ]
}

Responses

201Invitation created

Content-Type: application/json

{
  "ok": true,
  "invitation": {
    "id": "00000000-0000-4000-8000-000000000000",
    "email": "string",
    "expiresAt": "string"
  }
}

400Validation failed

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions or non-assignable role

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

429Too many invitation requests

Content-Type: application/json

{
  "error": "string"
}

502Invitation email could not be sent

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
  ]
}"

DELETE/customer_accounts/portal/users/{id}

Delete a company portal user

Soft deletes a portal user and revokes all their sessions.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200User deleted

Content-Type: application/json

{
  "ok": true
}

400Cannot delete self

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404User not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/customer_accounts/portal/users/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json"

PUT/customer_accounts/portal/users/{id}/roles

Update portal user roles

Assigns new roles to a company portal user.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "roleIds": [
    "00000000-0000-4000-8000-000000000000"
  ]
}

Responses

200Roles updated

Content-Type: application/json

{
  "ok": true
}

400Validation failed

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404User not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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\"
  ]
}"

DBBS Units

Showing 10 of 10 endpoints

GET/dbbs_units/links

Auth required

List unit associations

Returns a paginated collection of unit associations.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
search	query	No	any	—
page	query	No	any	—
pageSize	query	No	any	—
unitId	query	No	any	—
ids	query	No	any	Comma-separated list of record UUIDs to filter by (max 200).

Responses

200Paginated unit associations

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "unit_id": "00000000-0000-4000-8000-000000000000",
      "target_id": "00000000-0000-4000-8000-000000000000",
      "target_type": "order"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_units/links?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_units/links

Auth required

Create unit association

Creates a new unit association.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "unitId": "00000000-0000-4000-8000-000000000000",
  "targetType": "opportunity",
  "targetId": "00000000-0000-4000-8000-000000000000"
}

Responses

201Unit association created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "replayed": true
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_units/links" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"unitId\": \"00000000-0000-4000-8000-000000000000\",
  \"targetType\": \"opportunity\",
  \"targetId\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/dbbs_units/order-context

Auth required

Read fresh managed order context and scoped capabilities

Parameters

Name	In	Required	Schema	Description
orderId	query	Yes	any	—

Responses

200Native order context; null managed line means select a managed bus order

Content-Type: application/json

{
  "order": {
    "id": "00000000-0000-4000-8000-000000000000",
    "number": null,
    "status": null,
    "currencyCode": "string",
    "updatedAt": "string"
  },
  "managedLine": null,
  "activeReservation": null,
  "parts": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": null,
      "productId": null,
      "productVariantId": null,
      "quantity": "string",
      "unitPriceNet": "string",
      "currencyCode": "string"
    }
  ],
  "capabilities": {
    "reserve": true,
    "operate": true,
    "approve": true,
    "recover": true
  },
  "statusEntries": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "value": "confirmed"
    }
  ]
}

401Authentication required

Content-Type: application/json

"string"

403Feature denied

Content-Type: application/json

"string"

404Order unavailable in selected scope

Content-Type: application/json

"string"

409Managed identity conflict

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_units/order-context?orderId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dbbs_units/order-operations

Auth required

List managed order operations

Returns a paginated collection of managed order operations.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
search	query	No	any	—
page	query	No	any	—
pageSize	query	No	any	—
orderId	query	No	any	—
ids	query	No	any	Comma-separated list of record UUIDs to filter by (max 200).

Responses

200Paginated managed order operations

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "status": "pending"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_units/order-operations?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_units/order-operations

Auth required

Create managed order operation

Creates a new managed order operation.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "orderId": "00000000-0000-4000-8000-000000000000",
  "expectedOrderUpdatedAt": "string",
  "kind": "confirm",
  "statusEntryId": "00000000-0000-4000-8000-000000000000",
  "expectedReservationId": "00000000-0000-4000-8000-000000000000"
}

Responses

201Managed order operation created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "status": "pending",
  "replayed": true,
  "workflowId": null,
  "resultLineId": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_units/order-operations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"orderId\": \"00000000-0000-4000-8000-000000000000\",
  \"expectedOrderUpdatedAt\": \"string\",
  \"kind\": \"confirm\",
  \"statusEntryId\": \"00000000-0000-4000-8000-000000000000\",
  \"expectedReservationId\": \"00000000-0000-4000-8000-000000000000\"
}"

POST/dbbs_units/reservation-recovery

Auth required

Abandon a reconciled failed reservation

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "expectedUpdatedAt": "string",
  "reason": "target_unavailable"
}

Responses

201Recorded terminal abandonment or exact replay

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "status": "abandoned",
  "replayed": true
}

400Invalid input

Content-Type: application/json

"string"

401Authentication required

Content-Type: application/json

"string"

403Feature denied

Content-Type: application/json

"string"

404Request unavailable in selected scope

Content-Type: application/json

"string"

409Version, replay or reconciliation conflict

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_units/reservation-recovery" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\",
  \"expectedUpdatedAt\": \"string\",
  \"reason\": \"target_unavailable\"
}"

GET/dbbs_units/reservations

Auth required

List reservation requests

Returns a paginated collection of reservation requests.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
search	query	No	any	—
page	query	No	any	—
pageSize	query	No	any	—
orderId	query	No	any	—
ids	query	No	any	Comma-separated list of record UUIDs to filter by (max 200).

Responses

200Paginated reservation requests

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "status": "pending"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_units/reservations?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_units/reservations

Auth required

Create reservation request

Creates a new reservation request.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "mode": "reserve",
  "orderId": "00000000-0000-4000-8000-000000000000",
  "targetUnitId": "00000000-0000-4000-8000-000000000000",
  "warehouseId": "00000000-0000-4000-8000-000000000000",
  "quantity": 1
}

Responses

201Reservation request created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "status": "pending",
  "replayed": true,
  "workflowId": null,
  "resultReservationId": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_units/reservations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"mode\": \"reserve\",
  \"orderId\": \"00000000-0000-4000-8000-000000000000\",
  \"targetUnitId\": \"00000000-0000-4000-8000-000000000000\",
  \"warehouseId\": \"00000000-0000-4000-8000-000000000000\",
  \"quantity\": 1
}"

GET/dbbs_units/units

Auth required

List units

Returns a paginated collection of units.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
search	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).

Responses

200Paginated units

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "vin": "string",
      "quantity": 1
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_units/units?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_units/units

Auth required

Create unit

Creates a new unit.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "vin": "string",
  "productId": "00000000-0000-4000-8000-000000000000",
  "variantId": "00000000-0000-4000-8000-000000000000",
  "quantity": 1
}

Responses

201Unit created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "replayed": true
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_units/units" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"vin\": \"string\",
  \"productId\": \"00000000-0000-4000-8000-000000000000\",
  \"variantId\": \"00000000-0000-4000-8000-000000000000\",
  \"quantity\": 1
}"

DBBS Finance

Showing 3 of 3 endpoints

GET/dbbs_finance/health

Auth required

Check private socket configuration readiness, not ledger health

Responses

200Readiness result

Content-Type: application/json

{
  "status": "degraded",
  "details": {
    "reason": "string"
  }
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_finance/health" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_finance/postings

Auth required

Post approved financial request with stable event identity

Request body (application/json)

{
  "event": "string",
  "kind": "invoice",
  "date": "string",
  "main_account": 1,
  "other_account": 1,
  "amount": "string",
  "allocations": [
    {
      "unit": "string",
      "lender": null,
      "department": "string",
      "amount": "string"
    }
  ]
}

Responses

200Posted or exact replay

Content-Type: application/json

{
  "event": "string",
  "transaction_id": 1,
  "amount": "string",
  "status": "posted"
}

400Invalid request

Content-Type: application/json

"string"

401Authentication required

Content-Type: application/json

"string"

403Feature denied

Content-Type: application/json

"string"

409Provider rejected

Content-Type: application/json

"string"

503Unknown outcome: retry same event and payload

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_finance/postings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"event\": \"string\",
  \"kind\": \"invoice\",
  \"date\": \"string\",
  \"main_account\": 1,
  \"other_account\": 1,
  \"amount\": \"string\",
  \"allocations\": [
    {
      \"unit\": \"string\",
      \"lender\": null,
      \"department\": \"string\",
      \"amount\": \"string\"
    }
  ]
}"

GET/dbbs_finance/reports

Auth required

Read bounded DBBS-owned posting reconciliation by day, week or month

Parameters

Name	In	Required	Schema	Description
start	query	Yes	any	—
end	query	Yes	any	—
grain	query	No	any	—

Responses

200Conserved scoped posting totals (not all native ledger entries)

Content-Type: application/json

{
  "start": "string",
  "end": "string",
  "grain": "day",
  "items": [
    {
      "period": "string",
      "account_id": 1,
      "unit_label": null,
      "side": "DEBIT",
      "unit": "string",
      "lender": null,
      "department": "string",
      "amount": "string"
    }
  ],
  "debit": "string",
  "credit": "string",
  "coverage": "DBBS-owned postings only",
  "conserved": true
}

400Invalid date range or query

Content-Type: application/json

"string"

401Authentication required

Content-Type: application/json

"string"

403Feature denied

Content-Type: application/json

"string"

409Provider rejected or conservation failed

Content-Type: application/json

"string"

503Provider unavailable

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_finance/reports?start=string&end=string&grain=day" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Omnibus Finance Planning

Showing 8 of 8 endpoints

POST/dbbs_omnibus_finance/actions

Auth required

Transition a versioned synthetic finance plan with per-action permission; no posting or provider execution

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "id": "00000000-0000-4000-8000-000000000000",
  "expectedUpdatedAt": "string",
  "action": "validate"
}

Responses

200Original durable operation result

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "receivable_plan",
  "state": "string",
  "revision": 1,
  "updatedAt": "string",
  "payload": {
    "classification": "synthetic",
    "source": {
      "system": "synthetic",
      "company": "string",
      "version": "string",
      "cutoff": "string",
      "complete": true
    },
    "kind": "receivable_plan",
    "customerRef": "string",
    "currency": "USD",
    "receiptAmount": "string",
    "allocationMode": "explicit",
    "policyRef": null,
    "openItems": [
      {
        "id": "string",
        "amount": "string",
        "date": "string",
        "reference": "string"
      }
    ],
    "allocations": [
      {
        "itemId": "string",
        "amount": "string"
      }
    ],
    "reference": "string"
  }
}

400Invalid input or scope

Content-Type: application/json

"string"

403Action permission denied

Content-Type: application/json

"string"

404Scoped record absent

Content-Type: application/json

"string"

409State, version, policy or replay conflict

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_finance/actions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"id\": \"00000000-0000-4000-8000-000000000000\",
  \"expectedUpdatedAt\": \"string\",
  \"action\": \"validate\"
}"

GET/dbbs_omnibus_finance/documents

Auth required

List finance planning documents

Returns a paginated collection of finance planning documents.

Parameters

Name	In	Required	Schema	Description
kind	query	Yes	any	—
id	query	No	any	—
state	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).

Responses

200Paginated finance planning documents

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "receivable_plan",
      "state": "string",
      "revision": 1,
      "updatedAt": "string",
      "payload": {
        "classification": "synthetic",
        "source": {
          "system": "synthetic",
          "company": "string",
          "version": "string",
          "cutoff": "string",
          "complete": true
        },
        "kind": "receivable_plan",
        "customerRef": "string",
        "currency": "USD",
        "receiptAmount": "string",
        "allocationMode": "explicit",
        "policyRef": null,
        "openItems": [
          {
            "id": "string",
            "amount": "string",
            "date": "string",
            "reference": "string"
          }
        ],
        "allocations": [
          {
            "itemId": "string",
            "amount": "string"
          }
        ],
        "reference": "string"
      }
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_finance/documents?kind=receivable_plan&page=1&pageSize=50&sortField=updatedAt&sortDir=desc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_finance/documents

Auth required

Create finance planning document

Creates a new finance planning document.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "payload": {
    "classification": "synthetic",
    "source": {
      "system": "synthetic",
      "company": "string",
      "version": "string",
      "cutoff": "string",
      "complete": true
    },
    "kind": "receivable_plan",
    "customerRef": "string",
    "currency": "USD",
    "receiptAmount": "string",
    "allocationMode": "explicit",
    "policyRef": null,
    "openItems": [
      {
        "id": "string",
        "amount": "string",
        "date": "string",
        "reference": "string"
      }
    ],
    "allocations": [
      {
        "itemId": "string",
        "amount": "string"
      }
    ],
    "reference": "string"
  }
}

Responses

201Finance planning document created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "receivable_plan",
  "state": "string",
  "revision": 1,
  "updatedAt": "string",
  "payload": {
    "classification": "synthetic",
    "source": {
      "system": "synthetic",
      "company": "string",
      "version": "string",
      "cutoff": "string",
      "complete": true
    },
    "kind": "receivable_plan",
    "customerRef": "string",
    "currency": "USD",
    "receiptAmount": "string",
    "allocationMode": "explicit",
    "policyRef": null,
    "openItems": [
      {
        "id": "string",
        "amount": "string",
        "date": "string",
        "reference": "string"
      }
    ],
    "allocations": [
      {
        "itemId": "string",
        "amount": "string"
      }
    ],
    "reference": "string"
  }
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_finance/documents" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"payload\": {
    \"classification\": \"synthetic\",
    \"source\": {
      \"system\": \"synthetic\",
      \"company\": \"string\",
      \"version\": \"string\",
      \"cutoff\": \"string\",
      \"complete\": true
    },
    \"kind\": \"receivable_plan\",
    \"customerRef\": \"string\",
    \"currency\": \"USD\",
    \"receiptAmount\": \"string\",
    \"allocationMode\": \"explicit\",
    \"policyRef\": null,
    \"openItems\": [
      {
        \"id\": \"string\",
        \"amount\": \"string\",
        \"date\": \"string\",
        \"reference\": \"string\"
      }
    ],
    \"allocations\": [
      {
        \"itemId\": \"string\",
        \"amount\": \"string\"
      }
    ],
    \"reference\": \"string\"
  }
}"

PUT/dbbs_omnibus_finance/documents

Auth required

Update finance planning document

Updates an existing finance planning document by id.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "id": "00000000-0000-4000-8000-000000000000",
  "expectedUpdatedAt": "string",
  "payload": {
    "classification": "synthetic",
    "source": {
      "system": "synthetic",
      "company": "string",
      "version": "string",
      "cutoff": "string",
      "complete": true
    },
    "kind": "receivable_plan",
    "customerRef": "string",
    "currency": "USD",
    "receiptAmount": "string",
    "allocationMode": "explicit",
    "policyRef": null,
    "openItems": [
      {
        "id": "string",
        "amount": "string",
        "date": "string",
        "reference": "string"
      }
    ],
    "allocations": [
      {
        "itemId": "string",
        "amount": "string"
      }
    ],
    "reference": "string"
  }
}

Responses

200Finance planning document updated

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "receivable_plan",
  "state": "string",
  "revision": 1,
  "updatedAt": "string",
  "payload": {
    "classification": "synthetic",
    "source": {
      "system": "synthetic",
      "company": "string",
      "version": "string",
      "cutoff": "string",
      "complete": true
    },
    "kind": "receivable_plan",
    "customerRef": "string",
    "currency": "USD",
    "receiptAmount": "string",
    "allocationMode": "explicit",
    "policyRef": null,
    "openItems": [
      {
        "id": "string",
        "amount": "string",
        "date": "string",
        "reference": "string"
      }
    ],
    "allocations": [
      {
        "itemId": "string",
        "amount": "string"
      }
    ],
    "reference": "string"
  }
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_finance/documents" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"id\": \"00000000-0000-4000-8000-000000000000\",
  \"expectedUpdatedAt\": \"string\",
  \"payload\": {
    \"classification\": \"synthetic\",
    \"source\": {
      \"system\": \"synthetic\",
      \"company\": \"string\",
      \"version\": \"string\",
      \"cutoff\": \"string\",
      \"complete\": true
    },
    \"kind\": \"receivable_plan\",
    \"customerRef\": \"string\",
    \"currency\": \"USD\",
    \"receiptAmount\": \"string\",
    \"allocationMode\": \"explicit\",
    \"policyRef\": null,
    \"openItems\": [
      {
        \"id\": \"string\",
        \"amount\": \"string\",
        \"date\": \"string\",
        \"reference\": \"string\"
      }
    ],
    \"allocations\": [
      {
        \"itemId\": \"string\",
        \"amount\": \"string\"
      }
    ],
    \"reference\": \"string\"
  }
}"

GET/dbbs_omnibus_finance/history

Auth required

Read immutable planning revisions after current scoped record authorization

Parameters

Name	In	Required	Schema	Description
documentId	query	Yes	any	—
afterRevision	query	No	any	—
limit	query	No	any	—

Responses

200Ordered immutable revisions with bounded cursor

Content-Type: application/json

"string"

403Domain/archive permission denied

Content-Type: application/json

"string"

404Scoped record absent

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_finance/history?documentId=00000000-0000-4000-8000-000000000000&afterRevision=0&limit=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dbbs_omnibus_finance/projections

Auth required

Read the existing scoped finance projection; coverage remains DBBS-owned postings only

Parameters

Name	In	Required	Schema	Description
start	query	Yes	any	—
end	query	Yes	any	—
grain	query	No	any	—

Responses

200Conserved native-boundary projection, never all-ledger parity

Content-Type: application/json

{
  "start": "string",
  "end": "string",
  "grain": "day",
  "items": [
    {
      "period": "string",
      "account_id": 1,
      "unit_label": null,
      "side": "DEBIT",
      "unit": "string",
      "lender": null,
      "department": "string",
      "amount": "string"
    }
  ],
  "debit": "string",
  "credit": "string",
  "coverage": "DBBS-owned postings only",
  "conserved": true
}

400Invalid bounded date criteria

Content-Type: application/json

"string"

403Native finance or report read permission denied

Content-Type: application/json

"string"

409Provider rejected or unbalanced

Content-Type: application/json

"string"

503Provider unconfigured or outcome unknown

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_finance/projections?start=string&end=string&grain=day" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_finance/report-runs

Auth required

Produce an immutable synthetic report run; output availability never means delivery

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "definitionId": "00000000-0000-4000-8000-000000000000",
  "expectedDefinitionRevision": 1,
  "criteria": {
    "start": "string",
    "end": "string",
    "grain": "day",
    "department": null
  },
  "mode": "original",
  "originalRunId": null,
  "source": {
    "system": "synthetic",
    "company": "string",
    "version": "string",
    "cutoff": "string",
    "complete": true
  },
  "rows": [
    {
      "id": "string",
      "date": "string",
      "department": "string",
      "amount": null,
      "quantity": null
    }
  ]
}

Responses

201Original immutable run with definition revision, criteria and source lineage

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "receivable_plan",
  "state": "string",
  "revision": 1,
  "updatedAt": "string",
  "payload": {
    "classification": "synthetic",
    "source": {
      "system": "synthetic",
      "company": "string",
      "version": "string",
      "cutoff": "string",
      "complete": true
    },
    "kind": "receivable_plan",
    "customerRef": "string",
    "currency": "USD",
    "receiptAmount": "string",
    "allocationMode": "explicit",
    "policyRef": null,
    "openItems": [
      {
        "id": "string",
        "amount": "string",
        "date": "string",
        "reference": "string"
      }
    ],
    "allocations": [
      {
        "itemId": "string",
        "amount": "string"
      }
    ],
    "reference": "string"
  }
}

400Malformed definition or rows

Content-Type: application/json

"string"

403Output permission denied

Content-Type: application/json

"string"

409Definition/version/formula/provenance mismatch

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_finance/report-runs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"definitionId\": \"00000000-0000-4000-8000-000000000000\",
  \"expectedDefinitionRevision\": 1,
  \"criteria\": {
    \"start\": \"string\",
    \"end\": \"string\",
    \"grain\": \"day\",
    \"department\": null
  },
  \"mode\": \"original\",
  \"originalRunId\": null,
  \"source\": {
    \"system\": \"synthetic\",
    \"company\": \"string\",
    \"version\": \"string\",
    \"cutoff\": \"string\",
    \"complete\": true
  },
  \"rows\": [
    {
      \"id\": \"string\",
      \"date\": \"string\",
      \"department\": \"string\",
      \"amount\": null,
      \"quantity\": null
    }
  ]
}"

GET/dbbs_omnibus_finance/requests

Auth required

Recover the original committed result after response loss without executing again

Parameters

Name	In	Required	Schema	Description
requestId	query	Yes	any	—

Responses

200Original result for authenticated original actor

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "receivable_plan",
  "state": "string",
  "revision": 1,
  "updatedAt": "string",
  "payload": {
    "classification": "synthetic",
    "source": {
      "system": "synthetic",
      "company": "string",
      "version": "string",
      "cutoff": "string",
      "complete": true
    },
    "kind": "receivable_plan",
    "customerRef": "string",
    "currency": "USD",
    "receiptAmount": "string",
    "allocationMode": "explicit",
    "policyRef": null,
    "openItems": [
      {
        "id": "string",
        "amount": "string",
        "date": "string",
        "reference": "string"
      }
    ],
    "allocations": [
      {
        "itemId": "string",
        "amount": "string"
      }
    ],
    "reference": "string"
  }
}

404No committed scoped actor receipt

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_finance/requests?requestId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Auth

Showing 1 of 1 endpoints

GET/auth/users/consents

Auth required

List user consents

Returns all consent records for a given user, with integrity verification status.

Parameters

Name	In	Required	Schema	Description
userId	query	Yes	any	—

Responses

200Consent list returned

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/auth/users/consents?userId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Catalog

Showing 20 of 37 endpoints

GET/catalog/categories

Auth required

List categories

Returns a paginated collection of categories scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated categories

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/catalog/categories?view=manage&page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/catalog/categories

Auth required

Create category

Creates a new product category.

Request body (application/json)

{
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "name": "string",
  "slug": null,
  "parentId": null
}

Responses

201Category created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/catalog/categories

Auth required

Update category

Updates an existing category by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "slug": null,
  "parentId": null
}

Responses

200Category updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/catalog/categories

Auth required

Delete category

Deletes a category by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Category deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/catalog/categories" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/catalog/dictionaries/{key}

Auth required

Get dictionary entries by key

Returns dictionary entries for a specific key (e.g., currency, unit).

Parameters

Name	In	Required	Schema	Description
key	path	Yes	any	—

Responses

200Dictionary entries

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "entries": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "value": "string",
      "label": "string",
      "color": null,
      "icon": null
    }
  ]
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/catalog/dictionaries/:key" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/catalog/offers

Auth required

List offers

Returns a paginated collection of offers scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated offers

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/catalog/offers?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/catalog/offers

Auth required

Create offer

Creates a new offer linking a product to a sales channel.

Request body (application/json)

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

Responses

201Offer created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

PUT/catalog/offers

Auth required

Update offer

Updates an existing offer by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "defaultMediaId": null,
  "defaultMediaUrl": null
}

Responses

200Offer updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/catalog/offers

Auth required

Delete offer

Deletes an offer by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Offer deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/catalog/offers" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/catalog/option-schemas

Auth required

List option schemas

Returns a paginated collection of option schemas scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated option schemas

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/catalog/option-schemas?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/catalog/option-schemas

Auth required

Create option schema

Creates a new option schema template for product configurations.

Request body (application/json)

{
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "name": "string",
  "schema": {
    "options": [
      {
        "code": "string",
        "label": "string",
        "inputType": "select"
      }
    ]
  }
}

Responses

201Option Schema created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
      }
    ]
  }
}"

PUT/catalog/option-schemas

Auth required

Update option schema

Updates an existing option schema by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Option Schema updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/catalog/option-schemas" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

DELETE/catalog/option-schemas

Auth required

Delete option schema

Deletes an option schema by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Option Schema deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/catalog/option-schemas" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/catalog/price-kinds

Auth required

List price kinds

Returns a paginated collection of price kinds scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated price kinds

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/catalog/price-kinds?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/catalog/price-kinds

Auth required

Create price kind

Creates a new price kind for categorizing product prices.

Request body (application/json)

{
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "code": "string",
  "title": "string",
  "displayMode": "excluding-tax"
}

Responses

201Price Kind created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

PUT/catalog/price-kinds

Auth required

Update price kind

Updates an existing price kind by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "displayMode": "excluding-tax"
}

Responses

200Price Kind updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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\"
}"

DELETE/catalog/price-kinds

Auth required

Delete price kind

Deletes a price kind by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Price Kind deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/catalog/price-kinds" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/catalog/prices

Auth required

List prices

Returns a paginated collection of prices scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated prices

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/catalog/prices?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/catalog/prices

Auth required

Create price

Creates a new price entry for a product or variant.

Request body (application/json)

{
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "currencyCode": "string",
  "priceKindId": "00000000-0000-4000-8000-000000000000",
  "taxRateId": null
}

Responses

201Price created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/catalog/prices

Auth required

Update price

Updates an existing price by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "taxRateId": null
}

Responses

200Price updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

CommunicationChannels

Showing 20 of 21 endpoints

DELETE/communication_channels/admin/channels/{id}

Auth required

Admin delete (soft-delete) a tenant-wide communication channel

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

204Channel deleted

No response body.

400Invalid channel id

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

404Channel not found or not a tenant-wide channel

Content-Type: application/json

"string"

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/communication_channels/admin/channels/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/communication_channels/channels

Auth required

List communication channels for the current tenant

Responses

200Channel list (paginated)

Content-Type: application/json

"string"

400Invalid query parameters

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/communication_channels/channels" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/communication_channels/channels/{id}

Auth required

Get a single communication channel by id

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Channel detail

Content-Type: application/json

"string"

400Invalid channel id

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

404Channel not found

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/communication_channels/channels/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/communication_channels/channels/{id}/health

Auth required

Snapshot of channel delivery health (last 24h)

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Health snapshot

Content-Type: application/json

"string"

400Invalid channel id

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

404Channel not found

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/communication_channels/channels/:id/health" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/channels/{id}/import-history

Auth required

Queue a backlog import for a channel (Spec B § Phase B6)

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "sinceDays": 30,
  "maxMessages": 1000
}

Responses

202Import job queued; returns { progressJobId }

Content-Type: application/json

"string"

400Invalid channel id or unsupported provider

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

404Channel not found / not accessible

Content-Type: application/json

"string"

409Channel is not connected (requires reauth / error)

Content-Type: application/json

"string"

429Another import is already running for this channel

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

POST/communication_channels/channels/{id}/poll-now

Auth required

Manually trigger a poll cycle for a channel (demo / operator override)

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

202Poll job enqueued

Content-Type: application/json

"string"

400Invalid channel id

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

404Channel not found

Content-Type: application/json

"string"

409Channel disabled, not connected, or push-driven (never polled)

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/communication_channels/channels/:id/poll-now" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/channels/{id}/push/register

Auth required

Force-register push delivery for a channel (Spec C § Phase C5)

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

202Push registration attempted; check result.pushStatus

Content-Type: application/json

"string"

400Invalid id or unsupported provider

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

403Missing push.manage feature

Content-Type: application/json

"string"

404Channel not found

Content-Type: application/json

"string"

409Provider does not support push (IMAP)

Content-Type: application/json

"string"

502Provider returned an error during registration

Content-Type: application/json

"string"

503Webhook base URL or Pub/Sub topic not configured

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/communication_channels/channels/:id/push/register" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/channels/{id}/set-primary

Auth required

Mark a per-user channel as primary

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Channel set as primary (or already primary)

Content-Type: application/json

"string"

400Invalid channel id

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

404Channel not found or not owned by current user

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/communication_channels/channels/:id/set-primary" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/channels/{id}/test-send

Auth required

Diagnostic — send a test message through the channel without persisting

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Test send result

Content-Type: application/json

"string"

400Invalid channel id

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

403Not allowed to manage this channel

Content-Type: application/json

"string"

404Channel or adapter not found

Content-Type: application/json

"string"

409Channel not connected

Content-Type: application/json

"string"

422Invalid request body

Content-Type: application/json

"string"

502Provider error

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/communication_channels/channels/:id/test-send" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/channels/connect/credentials

Auth required

Connect a credential-based per-user channel (IMAP/SMTP)

Responses

201Channel connected

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

403Provider is tenant-scoped — use the tenant connect route

Content-Type: application/json

"string"

404Unknown provider

Content-Type: application/json

"string"

409Mailbox already connected via another provider

Content-Type: application/json

"string"

422Invalid body or credential validation failed

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/communication_channels/channels/connect/credentials" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/channels/connect/tenant-credentials

Auth required

Connect a tenant-wide credential-based channel (push: FCM/APNs/Expo)

Responses

201Channel connected

Content-Type: application/json

"string"

400Provider is not tenant-scoped

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

404Unknown provider

Content-Type: application/json

"string"

422Invalid body or credential validation failed

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/communication_channels/channels/connect/tenant-credentials" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/communication_channels/me/channels

Auth required

List the current user's connected channels

Responses

200List of user-owned channels

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/communication_channels/me/channels" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/messages/{messageId}/reactions

Auth required

Add a reaction to a channel-linked message

Parameters

Name	In	Required	Schema	Description
messageId	path	Yes	any	—

Responses

201Reaction added

Content-Type: application/json

"string"

400Invalid messageId

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

403Channel is owned by another user

Content-Type: application/json

"string"

409Message not channel-linked or duplicate reaction

Content-Type: application/json

"string"

422Invalid request body

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/communication_channels/messages/:messageId/reactions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/communication_channels/messages/{messageId}/reactions/{reactionId}

Auth required

Remove a reaction from a channel-linked message

Parameters

Name	In	Required	Schema	Description
messageId	path	Yes	any	—
reactionId	path	Yes	any	—

Responses

204Reaction removed

No response body.

400Invalid params

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

403Channel is owned by another user

Content-Type: application/json

"string"

404Reaction not found or not owned by current user

Content-Type: application/json

"string"

409Message not channel-linked

Content-Type: application/json

"string"

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/communication_channels/messages/:messageId/reactions/:reactionId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/communication_channels/oauth/{provider}/callback

Auth required

OAuth callback — exchange code, persist credentials, create per-user channel

Parameters

Name	In	Required	Schema	Description
provider	path	Yes	any	—

Responses

200Success response

Content-Type: application/json

"string"

302Redirect back to returnUrl with flash query params

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/communication_channels/oauth/:provider/callback" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/oauth/{provider}/initiate

Auth required

Start a per-user channel OAuth flow

Parameters

Name	In	Required	Schema	Description
provider	path	Yes	any	—

Responses

200Authorize URL + state cookie set

Content-Type: application/json

"string"

400Invalid provider or unsupported (no OAuth)

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

422Invalid request body

Content-Type: application/json

"string"

502Adapter failed to build authorize URL

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/communication_channels/oauth/:provider/initiate" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/send-as-user

Auth required

Send a message through the current user's own channel

Responses

202Message persisted; outbound delivery enqueued

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

403Cannot send through a channel you don't own

Content-Type: application/json

"string"

404Channel not found

Content-Type: application/json

"string"

409Channel in a non-deliverable transitional status

Content-Type: application/json

"string"

422Invalid body, or channel requires_reauth / disconnected

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/communication_channels/send-as-user" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/test-seed

Auth required

Test-only: seed a connected channel or emit an inbound message (env-gated)

Responses

201Channel seeded / inbound message emitted

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

404Test channel seeding disabled (production default), or the requested channel does not belong to the caller

Content-Type: application/json

"string"

422Invalid request body

Content-Type: application/json

"string"

500Seed failed

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/communication_channels/test-seed" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/communication_channels/threads/{threadId}/assign

Auth required

Reassign a channel-linked conversation to a different owner

Parameters

Name	In	Required	Schema	Description
threadId	path	Yes	any	—

Responses

200Conversation reassigned (or unchanged)

Content-Type: application/json

"string"

400Invalid threadId

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

404Conversation not channel-linked

Content-Type: application/json

"string"

422Invalid request body

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/communication_channels/threads/:threadId/assign" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/communication_channels/webhook/{provider}

Process an inbound channel webhook (Slack, WhatsApp, Email, ...)

Parameters

Name	In	Required	Schema	Description
provider	path	Yes	any	—

Responses

202Webhook accepted for async processing

Content-Type: application/json

"string"

401Signature verification failed against every candidate channel

Content-Type: application/json

"string"

404Unknown provider

Content-Type: application/json

"string"

413Webhook payload too large

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/communication_channels/webhook/:provider" \
  -H "Accept: application/json"

Configs

Showing 8 of 8 endpoints

GET/configs/cache

Auth required

Get cache statistics

Returns detailed cache statistics including total entries and breakdown by cache segments. Requires cache service to be available.

Responses

200Cache statistics

Content-Type: application/json

{
  "generatedAt": "string",
  "totalKeys": 1,
  "segments": [
    {
      "segment": "string",
      "resource": null,
      "method": null,
      "path": null,
      "keyCount": 1,
      "keys": [
        "string"
      ]
    }
  ]
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Failed to resolve cache stats

Content-Type: application/json

{
  "error": "string"
}

503Cache service unavailable

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/configs/cache" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/configs/cache

Auth required

Purge cache

Purges cache entries. Supports two actions: purgeAll (clears entire cache) or purgeSegment (clears specific segment). Returns updated cache statistics after purge.

Request body (application/json)

{
  "action": "purgeAll"
}

Responses

200Cache segment cleared successfully

Content-Type: application/json

{
  "action": "purgeSegment",
  "segment": "string",
  "deleted": 1,
  "stats": {
    "generatedAt": "string",
    "totalKeys": 1,
    "segments": [
      {
        "segment": "string",
        "resource": null,
        "method": null,
        "path": null,
        "keyCount": 1,
        "keys": [
          "string"
        ]
      }
    ]
  }
}

400Invalid request - missing segment identifier for purgeSegment action

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Failed to purge cache

Content-Type: application/json

{
  "error": "string"
}

503Cache service unavailable

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/configs/cache" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"action\": \"purgeAll\"
}"

GET/configs/module-telemetry

Auth required

Get module resource usage telemetry

Returns in-process module resource attribution for API routes, event subscribers, and queue workers.

Responses

200Module resource usage report

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/configs/module-telemetry" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/configs/module-telemetry

Auth required

Clear module telemetry data

Development-only endpoint that clears in-memory module telemetry and local process telemetry files.

Responses

200Module telemetry cleared

Content-Type: application/json

{
  "cleared": true
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden outside development mode

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/configs/module-telemetry" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/configs/system-status

Auth required

Get system health status

Returns comprehensive system health information including environment details, version, resource usage, and service connectivity status.

Responses

200System status snapshot

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Failed to load system status

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/configs/system-status" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/configs/system-status

Auth required

Clear system cache

Purges the entire cache for the current tenant. Useful for troubleshooting or forcing fresh data loading.

Responses

200Cache cleared successfully

Content-Type: application/json

{
  "cleared": true
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Failed to purge cache

Content-Type: application/json

{
  "error": "string"
}

503Cache service unavailable

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/configs/system-status" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/configs/upgrade-actions

Auth required

List pending upgrade actions

Returns 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.

Responses

200List of pending upgrade actions

Content-Type: application/json

{
  "version": "string",
  "actions": [
    {
      "id": "string",
      "version": "string",
      "message": "string",
      "ctaLabel": "string",
      "successMessage": "string",
      "loadingLabel": "string"
    }
  ]
}

400Missing organization or tenant context

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Failed to load upgrade actions

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/configs/upgrade-actions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/configs/upgrade-actions

Auth required

Execute upgrade action

Executes 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.

Request body (application/json)

{
  "actionId": "string"
}

Responses

200Upgrade action executed successfully

Content-Type: application/json

{
  "status": "string",
  "message": "string",
  "version": "string"
}

400Invalid request body or missing context

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Upgrade actions are disabled

Content-Type: application/json

{
  "error": "string"
}

500Failed to execute upgrade action

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/configs/upgrade-actions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"actionId\": \"string\"
}"

CustomerAccounts

Showing 8 of 8 endpoints

GET/customer_accounts/admin/domain-mappings

Auth required

List domain mappings

Returns all custom-domain mappings for the current tenant, optionally filtered by organization.

Responses

200OK

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/domain-mappings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customer_accounts/admin/domain-mappings

Auth required

Register a custom domain

Registers a new custom domain mapping for an organization. Verifies via DNS asynchronously.

Request body (application/json)

{
  "hostname": "string",
  "organizationId": "00000000-0000-4000-8000-000000000000"
}

Responses

201Created

Content-Type: application/json

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

400Validation error

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

409Conflict

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

DELETE/customer_accounts/admin/domain-mappings

Auth required

Remove a custom domain

Removes the domain mapping identified by ?id=. Cache and Traefik routing drain within TTL.

Responses

200OK

Content-Type: application/json

{
  "ok": true
}

400Bad request

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/domain-mappings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customer_accounts/admin/domain-mappings/{id}/health-check

Auth required

Trigger TLS health check

Runs an HTTPS probe to verify Traefik has provisioned a certificate. On success: transitions the mapping to active.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200OK

Content-Type: application/json

{
  "ok": true,
  "domainMapping": {
    "id": "00000000-0000-4000-8000-000000000000",
    "hostname": "string",
    "status": "string",
    "tlsRetryCount": 1,
    "tlsFailureReason": null
  }
}

401Unauthorized

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404Not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/domain-mappings/:id/health-check" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customer_accounts/admin/domain-mappings/{id}/verify

Auth required

Trigger DNS verification

Runs DNS verification (CNAME → A → reverse-resolve fallback) for the domain mapping. Returns diagnostics on failure.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200OK — see status

Content-Type: application/json

{
  "ok": true,
  "domainMapping": {
    "id": "00000000-0000-4000-8000-000000000000",
    "hostname": "string",
    "status": "string",
    "verifiedAt": null,
    "lastDnsCheckAt": null,
    "dnsFailureReason": null
  },
  "diagnostics": null
}

401Unauthorized

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404Not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/domain-mappings/:id/verify" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/customer_accounts/domain-check

Verify a hostname is allowed for TLS provisioning

Called by Traefik before issuing a Let's Encrypt certificate. Requires the X-Domain-Check-Secret header to match DOMAIN_CHECK_SECRET.

Responses

200Hostname allowed

Content-Type: application/json

{
  "ok": true
}

403Forbidden

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404Hostname not registered or not yet verified

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

503Server misconfiguration

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/domain-check" \
  -H "Accept: application/json"

GET/customer_accounts/domain-resolve

Single-host resolve for the Node middleware

Internal endpoint used by the portal middleware to populate its in-memory cache. Requires X-Domain-Resolve-Secret header.

Responses

200OK

Content-Type: application/json

{
  "ok": true,
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "orgSlug": null,
  "status": "active"
}

400Bad request

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404Not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

503Server misconfiguration

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/domain-resolve" \
  -H "Accept: application/json"

GET/customer_accounts/domain-resolve/all

Batch warm-up for the Node middleware

Returns every active domain mapping in a single payload so the middleware can populate its cache on process start. Requires X-Domain-Resolve-Secret header.

Responses

200OK

Content-Type: application/json

{
  "ok": true,
  "domains": [
    {
      "hostname": "string",
      "tenantId": "00000000-0000-4000-8000-000000000000",
      "organizationId": "00000000-0000-4000-8000-000000000000",
      "orgSlug": null,
      "status": "active"
    }
  ]
}

403Forbidden

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

429Too many requests

Content-Type: application/json

{
  "error": "string"
}

503Server misconfiguration

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/domain-resolve/all" \
  -H "Accept: application/json"

Customer Accounts Admin

Showing 16 of 16 endpoints

GET/customer_accounts/admin/roles

List customer roles (admin)

Returns all customer roles for the tenant.

Responses

200Role list

Content-Type: application/json

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

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/roles" \
  -H "Accept: application/json"

POST/customer_accounts/admin/roles

Create customer role (admin)

Creates a new customer role with an empty ACL.

Request body (application/json)

{
  "name": "string",
  "slug": "string"
}

Responses

201Role created

Content-Type: application/json

{
  "ok": true,
  "role": {
    "id": "00000000-0000-4000-8000-000000000000",
    "name": "string",
    "slug": "string",
    "description": null,
    "isDefault": true,
    "isSystem": true,
    "customerAssignable": true,
    "createdAt": "string"
  }
}

400Validation failed

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

409Slug already exists

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/roles" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"name\": \"string\",
  \"slug\": \"string\"
}"

GET/customer_accounts/admin/roles/{id}

Get customer role detail (admin)

Returns full customer role details including ACL features.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Role detail with ACL

Content-Type: application/json

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

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404Role not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/roles/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json"

PUT/customer_accounts/admin/roles/{id}

Update customer role (admin)

Updates a customer role. System roles are protected from name changes.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{}

Responses

200Role updated

Content-Type: application/json

{
  "ok": true
}

400Validation failed or system role restriction

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404Role not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/roles/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{}"

DELETE/customer_accounts/admin/roles/{id}

Delete customer role (admin)

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.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Role deleted

Content-Type: application/json

{
  "ok": true
}

400Default role or has assigned users

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404Role not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/roles/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json"

PUT/customer_accounts/admin/roles/{id}/acl

Update customer role ACL (admin)

Updates the ACL (features and portal admin flag) for a customer role. Invalidates RBAC cache after update.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "features": [
    "string"
  ]
}

Responses

200ACL updated

Content-Type: application/json

{
  "ok": true,
  "updatedAt": "string"
}

400Validation failed

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404Role not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

409Stale ACL write (optimistic-lock conflict)

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/roles/00000000-0000-4000-8000-000000000000/acl" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"features\": [
    \"string\"
  ]
}"

GET/customer_accounts/admin/users

List customer users (admin)

Returns a paginated list of customer users with roles. Supports filtering by status, company, role, and search.

Parameters

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	—

Responses

200Paginated user list

Content-Type: application/json

{
  "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,
      "createdAt": "string",
      "updatedAt": null,
      "roles": [
        {
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "string",
          "slug": "string"
        }
      ]
    }
  ],
  "total": 1,
  "totalPages": 1,
  "page": 1
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/users" \
  -H "Accept: application/json"

POST/customer_accounts/admin/users

Create customer user (admin)

Creates a new customer user directly. Staff-initiated, bypasses signup flow.

Request body (application/json)

{
  "email": "user@example.com",
  "password": "string",
  "displayName": "string"
}

Responses

201User created

Content-Type: application/json

{
  "ok": true,
  "user": {
    "id": "00000000-0000-4000-8000-000000000000",
    "email": "string",
    "displayName": "string"
  }
}

400Validation failed

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

409Email already exists

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/users" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"email\": \"user@example.com\",
  \"password\": \"string\",
  \"displayName\": \"string\"
}"

GET/customer_accounts/admin/users-invite

List pending customer invitations (admin)

Lists 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.

Parameters

Name	In	Required	Schema	Description
page	query	No	any	—
pageSize	query	No	any	—
personEntityId	query	No	any	—
customerEntityId	query	No	any	—
email	query	No	any	—

Responses

200Pending invitations

Content-Type: application/json

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

400Validation failed

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/users-invite" \
  -H "Accept: application/json"

POST/customer_accounts/admin/users-invite

Invite customer user (admin)

Creates a staff-initiated invitation for a new customer user. The invitedByUserId is set from the staff auth context.

Request body (application/json)

{
  "email": "user@example.com",
  "roleIds": [
    "00000000-0000-4000-8000-000000000000"
  ]
}

Responses

201Invitation created

Content-Type: application/json

{
  "ok": true,
  "invitation": {
    "id": "00000000-0000-4000-8000-000000000000",
    "email": "string",
    "customerEntityId": null,
    "personEntityId": null,
    "expiresAt": "string"
  }
}

400Validation failed

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

429Too many invitation requests

Content-Type: application/json

{
  "error": "string"
}

502Invitation email could not be sent

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
  ]
}"

GET/customer_accounts/admin/users/{id}

Get customer user detail (admin)

Returns full customer user details including CRM links, roles, and active session count.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200User detail

Content-Type: application/json

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

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404User not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json"

PUT/customer_accounts/admin/users/{id}

Update customer user (admin)

Updates a customer user. Staff can update status, lock, CRM links, and roles. Role assignment bypasses customer_assignable check.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "lockedUntil": null,
  "personEntityId": null,
  "customerEntityId": null
}

Responses

200User updated

Content-Type: application/json

{
  "ok": true
}

400Validation failed or role not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404User not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/customer_accounts/admin/users/{id}

Delete customer user (admin)

Soft deletes a customer user and revokes all their active sessions.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200User deleted

Content-Type: application/json

{
  "ok": true
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404User not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json"

POST/customer_accounts/admin/users/{id}/reset-password

Reset customer user password (admin)

Allows staff to set a new password for a customer user.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "newPassword": "string"
}

Responses

200Password reset

Content-Type: application/json

{
  "ok": true
}

400Validation failed

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404User not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000/reset-password" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"newPassword\": \"string\"
}"

POST/customer_accounts/admin/users/{id}/send-reset-link

Send password reset link for customer user (admin)

Creates 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.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Reset link generated

Content-Type: application/json

{
  "ok": true,
  "resetLink": "string"
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404User not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000/send-reset-link" \
  -H "Accept: application/json"

POST/customer_accounts/admin/users/{id}/verify-email

Verify customer user email (admin)

Allows staff to manually mark a customer user email as verified.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Email verified

Content-Type: application/json

{
  "ok": true
}

401Not authenticated

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

404User not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000/verify-email" \
  -H "Accept: application/json"

Customer Authentication

Showing 8 of 8 endpoints

POST/customer_accounts/email/verify

Verify customer email address

Validates the email verification token and marks the email as verified.

Request body (application/json)

{
  "token": "string"
}

Responses

200Email verified

Content-Type: application/json

{
  "ok": true
}

400Invalid or expired token

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/email/verify" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"token\": \"string\"
}"

POST/customer_accounts/invitations/accept

Accept customer invitation

Accepts an invitation, creates the user account, assigns roles, and auto-logs in.

Request body (application/json)

{
  "token": "string",
  "password": "string",
  "displayName": "string"
}

Responses

201Invitation accepted and user created

Content-Type: application/json

{
  "ok": true,
  "user": {
    "id": "00000000-0000-4000-8000-000000000000",
    "email": "user@example.com",
    "displayName": "string",
    "emailVerified": true
  },
  "resolvedFeatures": [
    "string"
  ]
}

400Invalid or expired invitation

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/invitations/accept" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"token\": \"string\",
  \"password\": \"string\",
  \"displayName\": \"string\"
}"

POST/customer_accounts/login

Authenticate customer credentials

Validates customer credentials and issues JWT + session cookies.

Request body (application/json)

{
  "email": "user@example.com",
  "password": "string"
}

Responses

200Login successful

Content-Type: application/json

{
  "ok": true,
  "user": {
    "id": "00000000-0000-4000-8000-000000000000",
    "email": "user@example.com",
    "displayName": "string",
    "emailVerified": true
  },
  "resolvedFeatures": [
    "string"
  ]
}

400Validation failed

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Invalid credentials

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

429Too many login attempts

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/login" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"email\": \"user@example.com\",
  \"password\": \"string\"
}"

POST/customer_accounts/magic-link/request

Request magic link login

Sends a magic link to the customer email. Always returns 200 to prevent enumeration.

Request body (application/json)

{
  "email": "user@example.com"
}

Responses

200Request accepted

Content-Type: application/json

{
  "ok": true
}

429Too many requests

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/magic-link/request" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"email\": \"user@example.com\"
}"

POST/customer_accounts/magic-link/verify

Verify magic link token

Validates the magic link token, auto-verifies email, and creates a session.

Request body (application/json)

{
  "token": "string"
}

Responses

200Login successful

Content-Type: application/json

{
  "ok": true,
  "user": {
    "id": "00000000-0000-4000-8000-000000000000",
    "email": "user@example.com",
    "displayName": "string",
    "emailVerified": true
  },
  "resolvedFeatures": [
    "string"
  ]
}

400Invalid or expired token

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

401Account not found

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/magic-link/verify" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"token\": \"string\"
}"

POST/customer_accounts/password/reset-confirm

Confirm customer password reset

Validates the reset token and sets a new password. Revokes all existing sessions.

Request body (application/json)

{
  "token": "string",
  "password": "string"
}

Responses

200Password reset successful

Content-Type: application/json

{
  "ok": true
}

400Invalid or expired token

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/password/reset-confirm" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"token\": \"string\",
  \"password\": \"string\"
}"

POST/customer_accounts/password/reset-request

Request customer password reset

Initiates a password reset flow. Always returns 200 to prevent email enumeration.

Request body (application/json)

{
  "email": "user@example.com"
}

Responses

200Request accepted

Content-Type: application/json

{
  "ok": true
}

429Too many requests

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/password/reset-request" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"email\": \"user@example.com\"
}"

POST/customer_accounts/signup

Register a new customer account

Accepts a signup request and always returns 202 to prevent account enumeration.

Request body (application/json)

{
  "email": "user@example.com",
  "password": "string",
  "displayName": "string"
}

Responses

202Signup accepted

Content-Type: application/json

{
  "ok": true
}

400Validation failed or invalid request origin

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

429Too many signup attempts

Content-Type: application/json

{
  "error": "string"
}

500Signup email origin is not configured

Content-Type: application/json

{
  "ok": false,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/customer_accounts/signup" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"email\": \"user@example.com\",
  \"password\": \"string\",
  \"displayName\": \"string\"
}"

Customers

Showing 20 of 101 endpoints

GET/customers/activities

Auth required

List activitys

Returns a paginated collection of activitys scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated activitys

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customers/activities?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customers/activities

Auth required

Create activity

DEPRECATED (sunset 2026-06-30): Creates a timeline activity. Use POST /api/customers/interactions instead.

Request body (application/json)

{
  "entityId": "00000000-0000-4000-8000-000000000000",
  "activityType": "string",
  "phoneNumber": null,
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

201Activity created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\",
  \"phoneNumber\": null,
  \"appearanceIcon\": null,
  \"appearanceColor\": null
}"

PUT/customers/activities

Auth required

Update activity

DEPRECATED (sunset 2026-06-30): Updates an activity. Use PUT /api/customers/interactions instead.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "phoneNumber": null,
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

200Activity updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/customers/activities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\",
  \"phoneNumber\": null,
  \"appearanceIcon\": null,
  \"appearanceColor\": null
}"

DELETE/customers/activities

Auth required

Delete activity

DEPRECATED (sunset 2026-06-30): Deletes an activity. Use DELETE /api/customers/interactions instead.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Activity deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/customers/activities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/customers/addresses

Auth required

List addresss

Returns a paginated collection of addresss scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated addresss

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customers/addresses?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customers/addresses

Auth required

Create address

Creates a customer address record and associates it with the referenced entity.

Request body (application/json)

{
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "entityId": "00000000-0000-4000-8000-000000000000",
  "addressLine1": "string",
  "latitude": null,
  "longitude": null
}

Responses

201Address created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/customers/addresses

Auth required

Update address

Updates fields on an existing customer address.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "latitude": null,
  "longitude": null
}

Responses

200Address updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/customers/addresses

Auth required

Delete address

Deletes an address by id. The identifier may be included in the body or query.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Address deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/customers/addresses" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/customers/assignable-staff

Auth required

DEPRECATED: use GET /api/staff/team-members/assignable instead.

Deprecated. Returns 308 Permanent Redirect to /api/staff/team-members/assignable preserving the query string. Will be removed no earlier than the next major release.

Parameters

Name	In	Required	Schema	Description
page	query	No	any	—
pageSize	query	No	any	—
search	query	No	any	—

Responses

200Assignable staff members (only reachable by following the redirect).

Content-Type: application/json

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

308Permanent redirect to /api/staff/team-members/assignable.

Content-Type: application/json

{
  "error": "string"
}

400Invalid request

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customers/assignable-staff?page=1&pageSize=24" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/customers/comments

Auth required

List comments

Returns a paginated collection of comments scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated comments

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customers/comments?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customers/comments

Auth required

Create comment

Adds a comment to a customer timeline.

Request body (application/json)

{
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "entityId": "00000000-0000-4000-8000-000000000000",
  "body": "string",
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

201Comment created

Content-Type: application/json

{
  "id": null,
  "authorUserId": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/customers/comments

Auth required

Update comment

Updates an existing timeline comment.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

200Comment updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/customers/comments

Auth required

Delete comment

Deletes a comment identified by `id` supplied via body or query string.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Comment deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/customers/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/customers/companies

Auth required

List companies

Returns a paginated collection of companies scoped to the authenticated organization.

Parameters

Name	In	Required	Schema	Description
page	query	No	any	—
pageSize	query	No	any	—
search	query	No	any	—
email	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).

Responses

200Paginated companies

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customers/companies?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/customers/companies

Auth required

Create company

Creates a company record and associated profile data.

Request body (application/json)

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

Responses

201Company created

Content-Type: application/json

{
  "id": null,
  "companyId": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/customers/companies

Auth required

Update company

Updates company profile fields, tags, or custom attributes.

Request body (application/json)

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

Responses

200Company updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/customers/companies

Auth required

Delete company

Deletes a company by id. The identifier can be provided via body or query.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Company deleted

Content-Type: application/json

{
  "ok": true
}

422Company has dependent records (people, deals, or direct staff); unlink or reassign before delete.

Content-Type: application/json

{
  "error": "string",
  "code": "COMPANY_HAS_DEPENDENTS"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/customers/companies" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/customers/companies/{id}

Auth required

Fetch company with related data

Returns a company customer record with optional related resources such as addresses, comments, activities, interactions, deals, todos, and linked people.

Parameters

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).

Responses

200Company detail payload

Content-Type: application/json

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

400Invalid identifier

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden for tenant/organization scope

Content-Type: application/json

{
  "error": "string"
}

404Company not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customers/companies/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/customers/companies/{id}/people

Auth required

List linked people for a company

Parameters

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	—

Responses

200Paginated linked people

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customers/companies/:id/people?page=1&pageSize=20&sort=name-asc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/customers/companies/{id}/roles

Auth required

List roles for a company

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Role assignments

Content-Type: application/json

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

400Invalid request

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/customers/companies/00000000-0000-4000-8000-000000000000/roles" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Dashboards

Showing 10 of 10 endpoints

GET/dashboards/layout

Auth required

Load the current dashboard layout

Returns the saved widget layout together with the widgets the current user is allowed to place.

Responses

200Current dashboard layout and available widgets.

Content-Type: application/json

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

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dashboards/layout" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/dashboards/layout

Auth required

Persist dashboard layout changes

Saves the provided widget ordering, sizes, and settings for the current user.

Request body (application/json)

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "widgetId": "string",
      "order": 1
    }
  ]
}

Responses

200Layout updated successfully.

Content-Type: application/json

{
  "ok": true
}

400Invalid layout payload

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Missing dashboards.configure feature

Content-Type: application/json

{
  "error": "string"
}

503Widget registry unavailable — the layout was not saved

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
    }
  ]
}"

PATCH/dashboards/layout/{itemId}

Auth required

Update a dashboard layout item

Adjusts the size or settings for a single widget within the dashboard layout.

Parameters

Name	In	Required	Schema	Description
itemId	path	Yes	any	—

Request body (application/json)

{}

Responses

200Layout item updated.

Content-Type: application/json

{
  "ok": true
}

400Invalid payload or missing item id

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Missing dashboards.configure feature

Content-Type: application/json

{
  "error": "string"
}

404Item not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PATCH "https://fixture.omnibus.buscrazy.net/api/dashboards/layout/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{}"

GET/dashboards/roles/widgets

Auth required

Fetch widget assignments for a role

Returns the widgets explicitly assigned to the given role together with the evaluation scope.

Parameters

Name	In	Required	Schema	Description
roleId	query	Yes	any	—
tenantId	query	No	any	—
organizationId	query	No	any	—

Responses

200Current widget configuration for the role.

Content-Type: application/json

{
  "widgetIds": [
    "string"
  ],
  "hasCustom": true,
  "scope": {
    "tenantId": null,
    "organizationId": null
  }
}

400Missing role identifier

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Insufficient permissions to manage role widgets

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dashboards/roles/widgets?roleId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/dashboards/roles/widgets

Auth required

Update widgets assigned to a role

Persists the widget list for a role within the provided tenant and organization scope.

Request body (application/json)

{
  "roleId": "00000000-0000-4000-8000-000000000000",
  "widgetIds": [
    "string"
  ]
}

Responses

200Widgets updated successfully.

Content-Type: application/json

{
  "ok": true,
  "widgetIds": [
    "string"
  ]
}

400Invalid payload or unknown widgets

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Insufficient permissions to manage role widgets

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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\"
  ]
}"

GET/dashboards/users/widgets

Auth required

Read widget overrides for a user

Returns the widgets inherited and explicitly configured for the requested user within the current scope.

Parameters

Name	In	Required	Schema	Description
userId	query	Yes	any	—
tenantId	query	No	any	—
organizationId	query	No	any	—

Responses

200Widget settings for the user.

Content-Type: application/json

{
  "mode": "inherit",
  "widgetIds": [
    "string"
  ],
  "hasCustom": true,
  "effectiveWidgetIds": [
    "string"
  ],
  "scope": {
    "tenantId": null,
    "organizationId": null
  }
}

400Missing user identifier

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Insufficient permissions to manage user widgets

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dashboards/users/widgets?userId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/dashboards/users/widgets

Auth required

Update user-specific dashboard widgets

Sets the widget override mode and allowed widgets for a user. Passing `mode: inherit` clears overrides.

Request body (application/json)

{
  "userId": "00000000-0000-4000-8000-000000000000",
  "mode": "inherit",
  "widgetIds": [
    "string"
  ]
}

Responses

200Overrides saved.

Content-Type: application/json

{
  "ok": true,
  "mode": "inherit",
  "widgetIds": [
    "string"
  ]
}

400Invalid payload or unknown widgets

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Insufficient permissions to manage user widgets

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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\"
  ]
}"

GET/dashboards/widgets/catalog

Auth required

List available dashboard widgets

Returns the catalog of widgets that modules expose, including defaults and feature requirements.

Responses

200Widgets available for assignment.

Content-Type: application/json

{
  "items": [
    {
      "id": "string",
      "title": "string",
      "description": null,
      "defaultSize": "sm",
      "defaultEnabled": true,
      "defaultSettings": null,
      "features": [
        "string"
      ],
      "moduleId": "string",
      "icon": null,
      "loaderKey": "string",
      "supportsRefresh": true
    }
  ]
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Insufficient permissions to view widget catalog

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dashboards/widgets/catalog" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dashboards/widgets/data

Auth required

Fetch aggregated data for dashboard widgets

Executes an aggregation query against the specified entity type and returns the result. Supports date range filtering, grouping, and period-over-period comparison.

Request body (application/json)

{
  "entityType": "string",
  "metric": {
    "field": "string",
    "aggregate": "count"
  }
}

Responses

200Aggregated data for the widget.

Content-Type: application/json

{
  "value": null,
  "data": [
    {
      "value": null
    }
  ],
  "metadata": {
    "fetchedAt": "string",
    "recordCount": 1,
    "currency": null
  }
}

400Invalid request payload

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Missing analytics.view feature

Content-Type: application/json

{
  "error": "string"
}

422Too many rows to group an encrypted field in application code

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

503Encryption is configured but the group source cannot currently be resolved

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
  }
}"

POST/dashboards/widgets/data/batch

Auth required

Fetch aggregated data for multiple dashboard widgets in one request

Resolves 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.

Request body (application/json)

{
  "requests": [
    {
      "id": "string",
      "request": {
        "entityType": "string",
        "metric": {
          "field": "string",
          "aggregate": "count"
        }
      }
    }
  ]
}

Responses

200Per-widget aggregation results keyed by request id.

Content-Type: application/json

{
  "results": [
    {
      "id": "string",
      "ok": true,
      "data": {
        "value": null,
        "data": [
          {
            "value": null
          }
        ],
        "metadata": {
          "fetchedAt": "string",
          "recordCount": 1,
          "currency": null
        }
      }
    }
  ]
}

400Invalid request payload

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
        }
      }
    }
  ]
}"

DBBS Jobs

Showing 6 of 6 endpoints

GET/dbbs_jobs/actions

Auth required

List jobactions

Returns a paginated collection of jobactions.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
jobId	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).

Responses

200Paginated jobactions

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "jobId": "00000000-0000-4000-8000-000000000000",
      "state": "string",
      "stage": "string",
      "evidence": {},
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_jobs/actions?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_jobs/actions

Auth required

Create jobaction

Creates a new jobaction.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "jobId": "00000000-0000-4000-8000-000000000000",
  "updatedAt": "string",
  "kind": "time",
  "payload": {
    "staffMemberId": "00000000-0000-4000-8000-000000000000",
    "date": "string",
    "durationMinutes": 1
  }
}

Responses

201JobAction created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "jobId": "00000000-0000-4000-8000-000000000000",
  "state": "string",
  "stage": "string",
  "evidence": {},
  "updatedAt": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_jobs/actions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"jobId\": \"00000000-0000-4000-8000-000000000000\",
  \"updatedAt\": \"string\",
  \"kind\": \"time\",
  \"payload\": {
    \"staffMemberId\": \"00000000-0000-4000-8000-000000000000\",
    \"date\": \"string\",
    \"durationMinutes\": 1
  }
}"

GET/dbbs_jobs/billing-options

Auth required

Read named native invoice lines under current job scope

Parameters

Name	In	Required	Schema	Description
jobId	query	Yes	any	—

Responses

200Current verified invoice and named lines; no posting authority

Content-Type: application/json

{
  "invoiceId": "00000000-0000-4000-8000-000000000000",
  "invoiceNumber": "string",
  "lines": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "string",
      "quantity": "string",
      "total": "string"
    }
  ]
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_jobs/billing-options?jobId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dbbs_jobs/jobs

Auth required

List jobs

Returns a paginated collection of jobs.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
page	query	No	any	—
pageSize	query	No	any	—
shop	query	No	any	—
state	query	No	any	—
ids	query	No	any	Comma-separated list of record UUIDs to filter by (max 200).

Responses

200Paginated jobs

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "state": "string",
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_jobs/jobs?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_jobs/jobs

Auth required

Create job

Creates a new job.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "shop": "service",
  "customerId": "00000000-0000-4000-8000-000000000000",
  "timeProjectId": "00000000-0000-4000-8000-000000000000",
  "unitId": null,
  "channelId": "00000000-0000-4000-8000-000000000000",
  "currencyCode": "string"
}

Responses

201Job created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "state": "string",
  "updatedAt": "string",
  "replayed": true
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_jobs/jobs" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"shop\": \"service\",
  \"customerId\": \"00000000-0000-4000-8000-000000000000\",
  \"timeProjectId\": \"00000000-0000-4000-8000-000000000000\",
  \"unitId\": null,
  \"channelId\": \"00000000-0000-4000-8000-000000000000\",
  \"currencyCode\": \"string\"
}"

POST/dbbs_jobs/reconcile

Auth required

Resume a durable action with authenticated native readback

Request body (application/json)

{
  "actionId": "00000000-0000-4000-8000-000000000000"
}

Responses

202Verified or still awaiting reconciliation

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "jobId": "00000000-0000-4000-8000-000000000000",
  "state": "string",
  "stage": "string",
  "evidence": {},
  "updatedAt": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_jobs/reconcile" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"actionId\": \"00000000-0000-4000-8000-000000000000\"
}"

Omnibus Operations

Showing 20 of 25 endpoints

POST/dbbs_omnibus_operations/actions

Auth required

Apply a permissioned versioned operational extension action

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "identity_association",
  "expectedVersion": 1,
  "action": "revise"
}

Responses

200Committed extension result or original replay; no native/provider effect

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "identity_association",
  "state": "string",
  "version": 1,
  "updatedAt": "string",
  "requestId": "00000000-0000-4000-8000-000000000000",
  "replayed": true,
  "dependencies": [
    "string"
  ],
  "effect": "extension_only"
}

400Invalid input

Content-Type: application/json

"string"

403Kind/action feature denied

Content-Type: application/json

"string"

404Scoped record absent

Content-Type: application/json

"string"

409Version/intent/state conflict or exact missing contract

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/actions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"id\": \"00000000-0000-4000-8000-000000000000\",
  \"kind\": \"identity_association\",
  \"expectedVersion\": 1,
  \"action\": \"revise\"
}"

GET/dbbs_omnibus_operations/appointments

Auth required

List appointments

Returns a paginated collection of appointments.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
state	query	No	any	—
customerId	query	No	any	—
unitId	query	No	any	—
jobId	query	No	any	—
resourceId	query	No	any	—
from	query	No	any	—
until	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).

Responses

200Paginated appointments

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "appointment",
      "payload": {
        "kind": "identity_association",
        "customerId": "00000000-0000-4000-8000-000000000000",
        "personId": null,
        "unitId": "00000000-0000-4000-8000-000000000000",
        "relationship": "owner",
        "sourceIdentity": {
          "system": "native_company",
          "companyCode": "string",
          "controlId": "string"
        },
        "aliases": [
          {
            "system": "native_company",
            "companyCode": "string",
            "controlId": "string"
          }
        ],
        "validFrom": "string",
        "validTo": null
      },
      "state": "string",
      "version": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/appointments?page=1&pageSize=50&sortField=created_at&sortDir=desc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_operations/appointments

Auth required

Create appointment

Creates a new appointment.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "record": {
    "kind": "identity_association",
    "customerId": "00000000-0000-4000-8000-000000000000",
    "personId": null,
    "unitId": "00000000-0000-4000-8000-000000000000",
    "relationship": "owner",
    "sourceIdentity": {
      "system": "native_company",
      "companyCode": "string",
      "controlId": "string"
    },
    "aliases": [
      {
        "system": "native_company",
        "companyCode": "string",
        "controlId": "string"
      }
    ],
    "validFrom": "string",
    "validTo": null
  }
}

Responses

201appointment created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "identity_association",
  "state": "string",
  "version": 1,
  "updatedAt": "string",
  "requestId": "00000000-0000-4000-8000-000000000000",
  "replayed": true,
  "dependencies": [
    "string"
  ],
  "effect": "extension_only"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/appointments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"record\": {
    \"kind\": \"identity_association\",
    \"customerId\": \"00000000-0000-4000-8000-000000000000\",
    \"personId\": null,
    \"unitId\": \"00000000-0000-4000-8000-000000000000\",
    \"relationship\": \"owner\",
    \"sourceIdentity\": {
      \"system\": \"native_company\",
      \"companyCode\": \"string\",
      \"controlId\": \"string\"
    },
    \"aliases\": [
      {
        \"system\": \"native_company\",
        \"companyCode\": \"string\",
        \"controlId\": \"string\"
      }
    ],
    \"validFrom\": \"string\",
    \"validTo\": null
  }
}"

GET/dbbs_omnibus_operations/dispatch-assignments

Auth required

List dispatch_assignments

Returns a paginated collection of dispatch_assignments.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
state	query	No	any	—
customerId	query	No	any	—
unitId	query	No	any	—
jobId	query	No	any	—
resourceId	query	No	any	—
from	query	No	any	—
until	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).

Responses

200Paginated dispatch_assignments

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "dispatch_assignment",
      "payload": {
        "kind": "identity_association",
        "customerId": "00000000-0000-4000-8000-000000000000",
        "personId": null,
        "unitId": "00000000-0000-4000-8000-000000000000",
        "relationship": "owner",
        "sourceIdentity": {
          "system": "native_company",
          "companyCode": "string",
          "controlId": "string"
        },
        "aliases": [
          {
            "system": "native_company",
            "companyCode": "string",
            "controlId": "string"
          }
        ],
        "validFrom": "string",
        "validTo": null
      },
      "state": "string",
      "version": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/dispatch-assignments?page=1&pageSize=50&sortField=created_at&sortDir=desc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_operations/dispatch-assignments

Auth required

Create dispatch_assignment

Creates a new dispatch_assignment.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "record": {
    "kind": "identity_association",
    "customerId": "00000000-0000-4000-8000-000000000000",
    "personId": null,
    "unitId": "00000000-0000-4000-8000-000000000000",
    "relationship": "owner",
    "sourceIdentity": {
      "system": "native_company",
      "companyCode": "string",
      "controlId": "string"
    },
    "aliases": [
      {
        "system": "native_company",
        "companyCode": "string",
        "controlId": "string"
      }
    ],
    "validFrom": "string",
    "validTo": null
  }
}

Responses

201dispatch_assignment created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "identity_association",
  "state": "string",
  "version": 1,
  "updatedAt": "string",
  "requestId": "00000000-0000-4000-8000-000000000000",
  "replayed": true,
  "dependencies": [
    "string"
  ],
  "effect": "extension_only"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/dispatch-assignments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"record\": {
    \"kind\": \"identity_association\",
    \"customerId\": \"00000000-0000-4000-8000-000000000000\",
    \"personId\": null,
    \"unitId\": \"00000000-0000-4000-8000-000000000000\",
    \"relationship\": \"owner\",
    \"sourceIdentity\": {
      \"system\": \"native_company\",
      \"companyCode\": \"string\",
      \"controlId\": \"string\"
    },
    \"aliases\": [
      {
        \"system\": \"native_company\",
        \"companyCode\": \"string\",
        \"controlId\": \"string\"
      }
    ],
    \"validFrom\": \"string\",
    \"validTo\": null
  }
}"

GET/dbbs_omnibus_operations/estimates

Auth required

List estimates

Returns a paginated collection of estimates.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
state	query	No	any	—
customerId	query	No	any	—
unitId	query	No	any	—
jobId	query	No	any	—
resourceId	query	No	any	—
from	query	No	any	—
until	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).

Responses

200Paginated estimates

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "estimate",
      "payload": {
        "kind": "identity_association",
        "customerId": "00000000-0000-4000-8000-000000000000",
        "personId": null,
        "unitId": "00000000-0000-4000-8000-000000000000",
        "relationship": "owner",
        "sourceIdentity": {
          "system": "native_company",
          "companyCode": "string",
          "controlId": "string"
        },
        "aliases": [
          {
            "system": "native_company",
            "companyCode": "string",
            "controlId": "string"
          }
        ],
        "validFrom": "string",
        "validTo": null
      },
      "state": "string",
      "version": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/estimates?page=1&pageSize=50&sortField=created_at&sortDir=desc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_operations/estimates

Auth required

Create estimate

Creates a new estimate.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "record": {
    "kind": "identity_association",
    "customerId": "00000000-0000-4000-8000-000000000000",
    "personId": null,
    "unitId": "00000000-0000-4000-8000-000000000000",
    "relationship": "owner",
    "sourceIdentity": {
      "system": "native_company",
      "companyCode": "string",
      "controlId": "string"
    },
    "aliases": [
      {
        "system": "native_company",
        "companyCode": "string",
        "controlId": "string"
      }
    ],
    "validFrom": "string",
    "validTo": null
  }
}

Responses

201estimate created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "identity_association",
  "state": "string",
  "version": 1,
  "updatedAt": "string",
  "requestId": "00000000-0000-4000-8000-000000000000",
  "replayed": true,
  "dependencies": [
    "string"
  ],
  "effect": "extension_only"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/estimates" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"record\": {
    \"kind\": \"identity_association\",
    \"customerId\": \"00000000-0000-4000-8000-000000000000\",
    \"personId\": null,
    \"unitId\": \"00000000-0000-4000-8000-000000000000\",
    \"relationship\": \"owner\",
    \"sourceIdentity\": {
      \"system\": \"native_company\",
      \"companyCode\": \"string\",
      \"controlId\": \"string\"
    },
    \"aliases\": [
      {
        \"system\": \"native_company\",
        \"companyCode\": \"string\",
        \"controlId\": \"string\"
      }
    ],
    \"validFrom\": \"string\",
    \"validTo\": null
  }
}"

GET/dbbs_omnibus_operations/estimates/capture

Auth required

Read the authoritative estimate capture and its unavailable downstream bindings

Parameters

Name	In	Required	Schema	Description
id	query	Yes	any	—

Responses

200Exact owning row with explicit legacy or typed capture mode

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "estimate",
  "state": "string",
  "version": 1,
  "updatedAt": "string",
  "record": {
    "kind": "estimate",
    "customerId": null,
    "unitId": null,
    "appointmentId": null,
    "originalEstimateId": null,
    "currency": "string",
    "lines": [
      {
        "lineId": "00000000-0000-4000-8000-000000000000",
        "kind": "labor",
        "sourceLineId": null,
        "quantityMicros": "string",
        "amountMinor": "string",
        "currency": "string",
        "configurationVersion": null,
        "artifactId": null
      }
    ],
    "approvalArtifactId": null,
    "sourceArtifactIds": [
      "00000000-0000-4000-8000-000000000000"
    ]
  },
  "captureMode": "quote_capture_v1",
  "downstream": [
    {
      "intent": "quote_convert_to_appointment",
      "available": false,
      "dependency": "string"
    }
  ],
  "effect": "extension_only"
}

400Invalid query

Content-Type: application/json

"string"

401Authentication required

Content-Type: application/json

"string"

403Current estimate or native-reference read permission denied

Content-Type: application/json

"string"

404No estimate in the trusted scope

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/estimates/capture?id=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dbbs_omnibus_operations/identity-associations

Auth required

List identity_associations

Returns a paginated collection of identity_associations.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
state	query	No	any	—
customerId	query	No	any	—
unitId	query	No	any	—
jobId	query	No	any	—
resourceId	query	No	any	—
from	query	No	any	—
until	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).

Responses

200Paginated identity_associations

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "identity_association",
      "payload": {
        "kind": "identity_association",
        "customerId": "00000000-0000-4000-8000-000000000000",
        "personId": null,
        "unitId": "00000000-0000-4000-8000-000000000000",
        "relationship": "owner",
        "sourceIdentity": {
          "system": "native_company",
          "companyCode": "string",
          "controlId": "string"
        },
        "aliases": [
          {
            "system": "native_company",
            "companyCode": "string",
            "controlId": "string"
          }
        ],
        "validFrom": "string",
        "validTo": null
      },
      "state": "string",
      "version": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/identity-associations?page=1&pageSize=50&sortField=created_at&sortDir=desc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_operations/identity-associations

Auth required

Create identity_association

Creates a new identity_association.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "record": {
    "kind": "identity_association",
    "customerId": "00000000-0000-4000-8000-000000000000",
    "personId": null,
    "unitId": "00000000-0000-4000-8000-000000000000",
    "relationship": "owner",
    "sourceIdentity": {
      "system": "native_company",
      "companyCode": "string",
      "controlId": "string"
    },
    "aliases": [
      {
        "system": "native_company",
        "companyCode": "string",
        "controlId": "string"
      }
    ],
    "validFrom": "string",
    "validTo": null
  }
}

Responses

201identity_association created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "identity_association",
  "state": "string",
  "version": 1,
  "updatedAt": "string",
  "requestId": "00000000-0000-4000-8000-000000000000",
  "replayed": true,
  "dependencies": [
    "string"
  ],
  "effect": "extension_only"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/identity-associations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"record\": {
    \"kind\": \"identity_association\",
    \"customerId\": \"00000000-0000-4000-8000-000000000000\",
    \"personId\": null,
    \"unitId\": \"00000000-0000-4000-8000-000000000000\",
    \"relationship\": \"owner\",
    \"sourceIdentity\": {
      \"system\": \"native_company\",
      \"companyCode\": \"string\",
      \"controlId\": \"string\"
    },
    \"aliases\": [
      {
        \"system\": \"native_company\",
        \"companyCode\": \"string\",
        \"controlId\": \"string\"
      }
    ],
    \"validFrom\": \"string\",
    \"validTo\": null
  }
}"

GET/dbbs_omnibus_operations/merge-plans

Auth required

List merge_plans

Returns a paginated collection of merge_plans.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
state	query	No	any	—
customerId	query	No	any	—
unitId	query	No	any	—
jobId	query	No	any	—
resourceId	query	No	any	—
from	query	No	any	—
until	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).

Responses

200Paginated merge_plans

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "merge_plan",
      "payload": {
        "kind": "identity_association",
        "customerId": "00000000-0000-4000-8000-000000000000",
        "personId": null,
        "unitId": "00000000-0000-4000-8000-000000000000",
        "relationship": "owner",
        "sourceIdentity": {
          "system": "native_company",
          "companyCode": "string",
          "controlId": "string"
        },
        "aliases": [
          {
            "system": "native_company",
            "companyCode": "string",
            "controlId": "string"
          }
        ],
        "validFrom": "string",
        "validTo": null
      },
      "state": "string",
      "version": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/merge-plans?page=1&pageSize=50&sortField=created_at&sortDir=desc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_operations/merge-plans

Auth required

Create merge_plan

Creates a new merge_plan.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "record": {
    "kind": "identity_association",
    "customerId": "00000000-0000-4000-8000-000000000000",
    "personId": null,
    "unitId": "00000000-0000-4000-8000-000000000000",
    "relationship": "owner",
    "sourceIdentity": {
      "system": "native_company",
      "companyCode": "string",
      "controlId": "string"
    },
    "aliases": [
      {
        "system": "native_company",
        "companyCode": "string",
        "controlId": "string"
      }
    ],
    "validFrom": "string",
    "validTo": null
  }
}

Responses

201merge_plan created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "identity_association",
  "state": "string",
  "version": 1,
  "updatedAt": "string",
  "requestId": "00000000-0000-4000-8000-000000000000",
  "replayed": true,
  "dependencies": [
    "string"
  ],
  "effect": "extension_only"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/merge-plans" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"record\": {
    \"kind\": \"identity_association\",
    \"customerId\": \"00000000-0000-4000-8000-000000000000\",
    \"personId\": null,
    \"unitId\": \"00000000-0000-4000-8000-000000000000\",
    \"relationship\": \"owner\",
    \"sourceIdentity\": {
      \"system\": \"native_company\",
      \"companyCode\": \"string\",
      \"controlId\": \"string\"
    },
    \"aliases\": [
      {
        \"system\": \"native_company\",
        \"companyCode\": \"string\",
        \"controlId\": \"string\"
      }
    ],
    \"validFrom\": \"string\",
    \"validTo\": null
  }
}"

GET/dbbs_omnibus_operations/native-references

Auth required

Resolve an exact native record ID without copying its master

Parameters

Name	In	Required	Schema	Description
type	query	Yes	any	—
id	query	Yes	any	—

Responses

200Scoped native identity

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "type": "string",
  "writer": "string"
}

400Only exact-ID lookup is qualified

Content-Type: application/json

"string"

403Native owner feature denied

Content-Type: application/json

"string"

404Scoped native identity absent

Content-Type: application/json

"string"

503Native owner unavailable

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/native-references?type=company&id=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dbbs_omnibus_operations/receipts

Auth required

Recover the original committed request result

Parameters

Name	In	Required	Schema	Description
kind	query	Yes	any	—
requestId	query	Yes	any	—
page	query	No	any	—
pageSize	query	No	any	—

Responses

200Exact scoped request receipt

Content-Type: application/json

{
  "items": [
    {
      "result": {
        "id": "00000000-0000-4000-8000-000000000000",
        "kind": "identity_association",
        "state": "string",
        "version": 1,
        "updatedAt": "string",
        "requestId": "00000000-0000-4000-8000-000000000000",
        "replayed": true,
        "dependencies": [
          "string"
        ],
        "effect": "extension_only"
      }
    }
  ],
  "totalCount": 1
}

400Invalid input

Content-Type: application/json

"string"

403Kind view permission denied

Content-Type: application/json

"string"

404No original request for this actor and scope

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/receipts?kind=identity_association&requestId=00000000-0000-4000-8000-000000000000&page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dbbs_omnibus_operations/recommendations

Auth required

List recommendations

Returns a paginated collection of recommendations.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
state	query	No	any	—
customerId	query	No	any	—
unitId	query	No	any	—
jobId	query	No	any	—
resourceId	query	No	any	—
from	query	No	any	—
until	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).

Responses

200Paginated recommendations

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "recommendation",
      "payload": {
        "kind": "identity_association",
        "customerId": "00000000-0000-4000-8000-000000000000",
        "personId": null,
        "unitId": "00000000-0000-4000-8000-000000000000",
        "relationship": "owner",
        "sourceIdentity": {
          "system": "native_company",
          "companyCode": "string",
          "controlId": "string"
        },
        "aliases": [
          {
            "system": "native_company",
            "companyCode": "string",
            "controlId": "string"
          }
        ],
        "validFrom": "string",
        "validTo": null
      },
      "state": "string",
      "version": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/recommendations?page=1&pageSize=50&sortField=created_at&sortDir=desc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_operations/recommendations

Auth required

Create recommendation

Creates a new recommendation.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "record": {
    "kind": "identity_association",
    "customerId": "00000000-0000-4000-8000-000000000000",
    "personId": null,
    "unitId": "00000000-0000-4000-8000-000000000000",
    "relationship": "owner",
    "sourceIdentity": {
      "system": "native_company",
      "companyCode": "string",
      "controlId": "string"
    },
    "aliases": [
      {
        "system": "native_company",
        "companyCode": "string",
        "controlId": "string"
      }
    ],
    "validFrom": "string",
    "validTo": null
  }
}

Responses

201recommendation created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "identity_association",
  "state": "string",
  "version": 1,
  "updatedAt": "string",
  "requestId": "00000000-0000-4000-8000-000000000000",
  "replayed": true,
  "dependencies": [
    "string"
  ],
  "effect": "extension_only"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/recommendations" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"record\": {
    \"kind\": \"identity_association\",
    \"customerId\": \"00000000-0000-4000-8000-000000000000\",
    \"personId\": null,
    \"unitId\": \"00000000-0000-4000-8000-000000000000\",
    \"relationship\": \"owner\",
    \"sourceIdentity\": {
      \"system\": \"native_company\",
      \"companyCode\": \"string\",
      \"controlId\": \"string\"
    },
    \"aliases\": [
      {
        \"system\": \"native_company\",
        \"companyCode\": \"string\",
        \"controlId\": \"string\"
      }
    ],
    \"validFrom\": \"string\",
    \"validTo\": null
  }
}"

GET/dbbs_omnibus_operations/revisions

Auth required

Read immutable operational revision history

Parameters

Name	In	Required	Schema	Description
kind	query	Yes	any	—
page	query	No	any	—
pageSize	query	No	any	—
recordId	query	Yes	any	—

Responses

200Scoped ordered immutable history

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "version": 1
    }
  ],
  "totalCount": 1
}

400Invalid input

Content-Type: application/json

"string"

403Kind view or typed capture native-reference permission denied

Content-Type: application/json

"string"

404Typed capture native reference unavailable in current scope

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/revisions?kind=identity_association&page=1&pageSize=50&recordId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dbbs_omnibus_operations/time-entries

Auth required

List time_entrys

Returns a paginated collection of time_entrys.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
state	query	No	any	—
customerId	query	No	any	—
unitId	query	No	any	—
jobId	query	No	any	—
resourceId	query	No	any	—
from	query	No	any	—
until	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).

Responses

200Paginated time_entrys

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "time_entry",
      "payload": {
        "kind": "identity_association",
        "customerId": "00000000-0000-4000-8000-000000000000",
        "personId": null,
        "unitId": "00000000-0000-4000-8000-000000000000",
        "relationship": "owner",
        "sourceIdentity": {
          "system": "native_company",
          "companyCode": "string",
          "controlId": "string"
        },
        "aliases": [
          {
            "system": "native_company",
            "companyCode": "string",
            "controlId": "string"
          }
        ],
        "validFrom": "string",
        "validTo": null
      },
      "state": "string",
      "version": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/time-entries?page=1&pageSize=50&sortField=created_at&sortDir=desc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_operations/time-entries

Auth required

Create time_entry

Creates a new time_entry.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "record": {
    "kind": "identity_association",
    "customerId": "00000000-0000-4000-8000-000000000000",
    "personId": null,
    "unitId": "00000000-0000-4000-8000-000000000000",
    "relationship": "owner",
    "sourceIdentity": {
      "system": "native_company",
      "companyCode": "string",
      "controlId": "string"
    },
    "aliases": [
      {
        "system": "native_company",
        "companyCode": "string",
        "controlId": "string"
      }
    ],
    "validFrom": "string",
    "validTo": null
  }
}

Responses

201time_entry created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "identity_association",
  "state": "string",
  "version": 1,
  "updatedAt": "string",
  "requestId": "00000000-0000-4000-8000-000000000000",
  "replayed": true,
  "dependencies": [
    "string"
  ],
  "effect": "extension_only"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/time-entries" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"record\": {
    \"kind\": \"identity_association\",
    \"customerId\": \"00000000-0000-4000-8000-000000000000\",
    \"personId\": null,
    \"unitId\": \"00000000-0000-4000-8000-000000000000\",
    \"relationship\": \"owner\",
    \"sourceIdentity\": {
      \"system\": \"native_company\",
      \"companyCode\": \"string\",
      \"controlId\": \"string\"
    },
    \"aliases\": [
      {
        \"system\": \"native_company\",
        \"companyCode\": \"string\",
        \"controlId\": \"string\"
      }
    ],
    \"validFrom\": \"string\",
    \"validTo\": null
  }
}"

GET/dbbs_omnibus_operations/vehicle-scenarios

Auth required

List vehicle_scenarios

Returns a paginated collection of vehicle_scenarios.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
state	query	No	any	—
customerId	query	No	any	—
unitId	query	No	any	—
jobId	query	No	any	—
resourceId	query	No	any	—
from	query	No	any	—
until	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).

Responses

200Paginated vehicle_scenarios

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "vehicle_scenario",
      "payload": {
        "kind": "identity_association",
        "customerId": "00000000-0000-4000-8000-000000000000",
        "personId": null,
        "unitId": "00000000-0000-4000-8000-000000000000",
        "relationship": "owner",
        "sourceIdentity": {
          "system": "native_company",
          "companyCode": "string",
          "controlId": "string"
        },
        "aliases": [
          {
            "system": "native_company",
            "companyCode": "string",
            "controlId": "string"
          }
        ],
        "validFrom": "string",
        "validTo": null
      },
      "state": "string",
      "version": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/vehicle-scenarios?page=1&pageSize=50&sortField=created_at&sortDir=desc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Omnibus Job Conversion

Showing 5 of 5 endpoints

GET/dbbs_omnibus_operations/job-conversions

Auth required

Read current proposed conversion and verified native outcome

Parameters

Name	In	Required	Schema	Description
id	query	Yes	any	—

Responses

200Authoritative scoped coordinator state; source binding remains proposed

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "state": "prepared",
  "version": 1,
  "updatedAt": "string",
  "intent": {
    "sources": {
      "appointment": null,
      "estimate": null
    },
    "binding": {
      "id": "string",
      "status": "synthetic_candidate",
      "policy": "synthetic_snapshot_locked_v1",
      "contractPin": "60106bc1bf906c1d3667332114a90032eb3a29f5:dbbs_jobs.jobs.create"
    },
    "nativeInput": {
      "requestId": "00000000-0000-4000-8000-000000000000",
      "shop": "service",
      "customerId": "00000000-0000-4000-8000-000000000000",
      "timeProjectId": "00000000-0000-4000-8000-000000000000",
      "unitId": null,
      "channelId": "00000000-0000-4000-8000-000000000000",
      "currencyCode": "string"
    },
    "preparedBy": "00000000-0000-4000-8000-000000000000",
    "preparedAt": "string"
  },
  "nativeResult": null,
  "dispatchReserved": true,
  "observation": null
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/job-conversions?id=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_operations/job-conversions

Auth required

Persist immutable source snapshots and one native request before dispatch

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "appointment": null,
  "estimate": null
}

Responses

201Immutable prepared receipt; default source adapter refuses unqualified binding

Content-Type: application/json

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "conversion": {
    "id": "00000000-0000-4000-8000-000000000000",
    "state": "prepared",
    "version": 1,
    "updatedAt": "string",
    "intent": {
      "sources": {
        "appointment": null,
        "estimate": null
      },
      "binding": {
        "id": "string",
        "status": "synthetic_candidate",
        "policy": "synthetic_snapshot_locked_v1",
        "contractPin": "60106bc1bf906c1d3667332114a90032eb3a29f5:dbbs_jobs.jobs.create"
      },
      "nativeInput": {
        "requestId": "00000000-0000-4000-8000-000000000000",
        "shop": "service",
        "customerId": "00000000-0000-4000-8000-000000000000",
        "timeProjectId": "00000000-0000-4000-8000-000000000000",
        "unitId": null,
        "channelId": "00000000-0000-4000-8000-000000000000",
        "currencyCode": "string"
      },
      "preparedBy": "00000000-0000-4000-8000-000000000000",
      "preparedAt": "string"
    },
    "nativeResult": null,
    "dispatchReserved": true,
    "observation": null
  }
}

403Current source/native permission or synthetic admission denied

Content-Type: application/json

"string"

409Source/binding/version/intent conflict

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/job-conversions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"appointment\": null,
  \"estimate\": null
}"

POST/dbbs_omnibus_operations/job-conversions/actions

Auth required

Reserve dispatch or recover the exact original native job request

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "id": "00000000-0000-4000-8000-000000000000",
  "expectedVersion": 1,
  "action": "dispatch"
}

Responses

200Immutable action receipt; GET exposes later native outcome

Content-Type: application/json

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "conversion": {
    "id": "00000000-0000-4000-8000-000000000000",
    "state": "prepared",
    "version": 1,
    "updatedAt": "string",
    "intent": {
      "sources": {
        "appointment": null,
        "estimate": null
      },
      "binding": {
        "id": "string",
        "status": "synthetic_candidate",
        "policy": "synthetic_snapshot_locked_v1",
        "contractPin": "60106bc1bf906c1d3667332114a90032eb3a29f5:dbbs_jobs.jobs.create"
      },
      "nativeInput": {
        "requestId": "00000000-0000-4000-8000-000000000000",
        "shop": "service",
        "customerId": "00000000-0000-4000-8000-000000000000",
        "timeProjectId": "00000000-0000-4000-8000-000000000000",
        "unitId": null,
        "channelId": "00000000-0000-4000-8000-000000000000",
        "currencyCode": "string"
      },
      "preparedBy": "00000000-0000-4000-8000-000000000000",
      "preparedAt": "string"
    },
    "nativeResult": null,
    "dispatchReserved": true,
    "observation": null
  }
}

403Current source/native permission or synthetic admission denied

Content-Type: application/json

"string"

404Scoped conversion absent

Content-Type: application/json

"string"

409Actor/intent/version/state conflict

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/job-conversions/actions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"id\": \"00000000-0000-4000-8000-000000000000\",
  \"expectedVersion\": 1,
  \"action\": \"dispatch\"
}"

GET/dbbs_omnibus_operations/job-conversions/history

Auth required

Read append-only conversion observations in version order

Parameters

Name	In	Required	Schema	Description
id	query	Yes	any	—
afterVersion	query	No	any	—
limit	query	No	any	—

Responses

200Bounded history authorized against current source/native read permissions

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/job-conversions/history?id=00000000-0000-4000-8000-000000000000&afterVersion=0&limit=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dbbs_omnibus_operations/job-conversions/requests

Auth required

Recover the original actor receipt without dispatching

Parameters

Name	In	Required	Schema	Description
requestId	query	Yes	any	—

Responses

200Immutable original result after current source/native read authorization

Content-Type: application/json

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "conversion": {
    "id": "00000000-0000-4000-8000-000000000000",
    "state": "prepared",
    "version": 1,
    "updatedAt": "string",
    "intent": {
      "sources": {
        "appointment": null,
        "estimate": null
      },
      "binding": {
        "id": "string",
        "status": "synthetic_candidate",
        "policy": "synthetic_snapshot_locked_v1",
        "contractPin": "60106bc1bf906c1d3667332114a90032eb3a29f5:dbbs_jobs.jobs.create"
      },
      "nativeInput": {
        "requestId": "00000000-0000-4000-8000-000000000000",
        "shop": "service",
        "customerId": "00000000-0000-4000-8000-000000000000",
        "timeProjectId": "00000000-0000-4000-8000-000000000000",
        "unitId": null,
        "channelId": "00000000-0000-4000-8000-000000000000",
        "currencyCode": "string"
      },
      "preparedBy": "00000000-0000-4000-8000-000000000000",
      "preparedAt": "string"
    },
    "nativeResult": null,
    "dispatchReserved": true,
    "observation": null
  }
}

404No receipt in current actor/scope

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_operations/job-conversions/requests?requestId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Omnibus Parts preparation

Showing 11 of 11 endpoints

GET/dbbs_omnibus_parts/counts

Auth required

List countss

Returns a paginated collection of countss.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
identity	query	No	any	—
state	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).

Responses

200Paginated countss

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "count",
      "identity": "string",
      "state": "string",
      "payload": {},
      "revision": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_parts/counts?page=1&pageSize=50&sortField=identity&sortDir=asc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_parts/counts

Auth required

Create counts

Execute a scoped synthetic preparation command. Exact action features apply. No stock, financial or provider effect.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "identity": "string",
  "action": "create",
  "snapshotId": "00000000-0000-4000-8000-000000000000",
  "mode": "full",
  "countBasis": "original_snapshot"
}

Responses

201counts created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "snapshot",
  "state": "string",
  "revision": 1,
  "updatedAt": "string",
  "result": {},
  "replayed": true,
  "readModel": "pending"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_parts/counts" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"identity\": \"string\",
  \"action\": \"create\",
  \"snapshotId\": \"00000000-0000-4000-8000-000000000000\",
  \"mode\": \"full\",
  \"countBasis\": \"original_snapshot\"
}"

GET/dbbs_omnibus_parts/documents

Auth required

List documentss

Returns a paginated collection of documentss.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
identity	query	No	any	—
state	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).

Responses

200Paginated documentss

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "document",
      "identity": "string",
      "state": "string",
      "payload": {},
      "revision": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_parts/documents?page=1&pageSize=50&sortField=identity&sortDir=asc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_parts/documents

Auth required

Create documents

Execute a scoped synthetic preparation command. Exact action features apply. No stock, financial or provider effect.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "identity": "string",
  "action": "create",
  "data": {
    "source": "synthetic",
    "type": "counter",
    "sourceVersion": "string",
    "sourceDocumentId": "string",
    "parentDocumentId": null,
    "currencyCode": "string",
    "lines": [
      {
        "lineId": "string",
        "nativeLineId": null,
        "sku": "string",
        "uom": "string",
        "parentLineId": null
      }
    ],
    "events": [
      {
        "eventId": "string",
        "kind": "ordered",
        "lineId": "string",
        "occurredAt": "string",
        "sourceVersion": "string",
        "parentEventId": null
      }
    ]
  }
}

Responses

201documents created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "snapshot",
  "state": "string",
  "revision": 1,
  "updatedAt": "string",
  "result": {},
  "replayed": true,
  "readModel": "pending"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_parts/documents" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"identity\": \"string\",
  \"action\": \"create\",
  \"data\": {
    \"source\": \"synthetic\",
    \"type\": \"counter\",
    \"sourceVersion\": \"string\",
    \"sourceDocumentId\": \"string\",
    \"parentDocumentId\": null,
    \"currencyCode\": \"string\",
    \"lines\": [
      {
        \"lineId\": \"string\",
        \"nativeLineId\": null,
        \"sku\": \"string\",
        \"uom\": \"string\",
        \"parentLineId\": null
      }
    ],
    \"events\": [
      {
        \"eventId\": \"string\",
        \"kind\": \"ordered\",
        \"lineId\": \"string\",
        \"occurredAt\": \"string\",
        \"sourceVersion\": \"string\",
        \"parentEventId\": null
      }
    ]
  }
}"

GET/dbbs_omnibus_parts/payables

Auth required

List payabless

Returns a paginated collection of payabless.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
identity	query	No	any	—
state	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).

Responses

200Paginated payabless

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "payable",
      "identity": "string",
      "state": "string",
      "payload": {},
      "revision": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_parts/payables?page=1&pageSize=50&sortField=identity&sortDir=asc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_parts/payables

Auth required

Create payables

Execute a scoped synthetic preparation command. Exact action features apply. No stock, financial or provider effect.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "identity": "string",
  "action": "create",
  "data": {
    "source": "synthetic",
    "type": "po",
    "vendorId": "00000000-0000-4000-8000-000000000000",
    "currencyCode": "string",
    "sourceDocumentId": null,
    "originalPlanId": null,
    "documentNumber": null,
    "noteCode": null,
    "lines": [
      {
        "lineId": "string",
        "allocations": [
          {
            "allocationId": "string",
            "targetType": "ro_line",
            "targetId": "00000000-0000-4000-8000-000000000000",
            "targetLineId": null
          }
        ]
      }
    ]
  }
}

Responses

201payables created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "snapshot",
  "state": "string",
  "revision": 1,
  "updatedAt": "string",
  "result": {},
  "replayed": true,
  "readModel": "pending"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_parts/payables" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"identity\": \"string\",
  \"action\": \"create\",
  \"data\": {
    \"source\": \"synthetic\",
    \"type\": \"po\",
    \"vendorId\": \"00000000-0000-4000-8000-000000000000\",
    \"currencyCode\": \"string\",
    \"sourceDocumentId\": null,
    \"originalPlanId\": null,
    \"documentNumber\": null,
    \"noteCode\": null,
    \"lines\": [
      {
        \"lineId\": \"string\",
        \"allocations\": [
          {
            \"allocationId\": \"string\",
            \"targetType\": \"ro_line\",
            \"targetId\": \"00000000-0000-4000-8000-000000000000\",
            \"targetLineId\": null
          }
        ]
      }
    ]
  }
}"

GET/dbbs_omnibus_parts/payments

Auth required

List paymentss

Returns a paginated collection of paymentss.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
identity	query	No	any	—
state	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).

Responses

200Paginated paymentss

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "payment",
      "identity": "string",
      "state": "string",
      "payload": {},
      "revision": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_parts/payments?page=1&pageSize=50&sortField=identity&sortDir=asc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_parts/payments

Auth required

Create payments

Execute a scoped synthetic preparation command. Exact action features apply. No stock, financial or provider effect.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "identity": "string",
  "action": "create",
  "data": {
    "source": "synthetic",
    "currencyCode": "string",
    "lines": [
      {
        "lineId": "string",
        "payableId": "00000000-0000-4000-8000-000000000000",
        "expectedPayableRevision": 1
      }
    ]
  }
}

Responses

201payments created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "snapshot",
  "state": "string",
  "revision": 1,
  "updatedAt": "string",
  "result": {},
  "replayed": true,
  "readModel": "pending"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_parts/payments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"identity\": \"string\",
  \"action\": \"create\",
  \"data\": {
    \"source\": \"synthetic\",
    \"currencyCode\": \"string\",
    \"lines\": [
      {
        \"lineId\": \"string\",
        \"payableId\": \"00000000-0000-4000-8000-000000000000\",
        \"expectedPayableRevision\": 1
      }
    ]
  }
}"

GET/dbbs_omnibus_parts/receipts

Auth required

Read the original Parts request result without repeating its action

Parameters

Name	In	Required	Schema	Description
requestId	query	Yes	any	—
kind	query	Yes	any	—

Responses

200Immutable original business result and current projection delivery status

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "snapshot",
  "state": "string",
  "revision": 1,
  "updatedAt": "string",
  "result": {},
  "replayed": true,
  "readModel": "pending",
  "requestId": "00000000-0000-4000-8000-000000000000"
}

400Invalid query

Content-Type: application/json

"string"

401Authentication required

Content-Type: application/json

"string"

403Family or financial/cost view denied

Content-Type: application/json

"string"

404Receipt unavailable for the current actor, family and Company scope

Content-Type: application/json

"string"

503Receipt unavailable or invalid

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_parts/receipts?requestId=00000000-0000-4000-8000-000000000000&kind=snapshot" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dbbs_omnibus_parts/snapshots

Auth required

List snapshotss

Returns a paginated collection of snapshotss.

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
identity	query	No	any	—
state	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).

Responses

200Paginated snapshotss

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "snapshot",
      "identity": "string",
      "state": "string",
      "payload": {},
      "revision": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_parts/snapshots?page=1&pageSize=50&sortField=identity&sortDir=asc" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dbbs_omnibus_parts/snapshots

Auth required

Create snapshots

Execute a scoped synthetic preparation command. Exact action features apply. No stock, financial or provider effect.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "identity": "string",
  "action": "capture",
  "data": {
    "source": "synthetic",
    "sourceVersion": "string",
    "observedAt": "string",
    "complete": true,
    "missingContracts": [
      "string"
    ],
    "rows": [
      {
        "lineId": "string",
        "sku": "string",
        "uom": "string",
        "bin": null,
        "stockingClass": "stock",
        "supersededBy": null,
        "onHand": null,
        "reserved": null,
        "allocated": null,
        "unitCost": null,
        "currencyCode": null,
        "price": null,
        "priceVersion": null
      }
    ]
  }
}

Responses

201snapshots created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "snapshot",
  "state": "string",
  "revision": 1,
  "updatedAt": "string",
  "result": {},
  "replayed": true,
  "readModel": "pending"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus_parts/snapshots" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"identity\": \"string\",
  \"action\": \"capture\",
  \"data\": {
    \"source\": \"synthetic\",
    \"sourceVersion\": \"string\",
    \"observedAt\": \"string\",
    \"complete\": true,
    \"missingContracts\": [
      \"string\"
    ],
    \"rows\": [
      {
        \"lineId\": \"string\",
        \"sku\": \"string\",
        \"uom\": \"string\",
        \"bin\": null,
        \"stockingClass\": \"stock\",
        \"supersededBy\": null,
        \"onHand\": null,
        \"reserved\": null,
        \"allocated\": null,
        \"unitCost\": null,
        \"currencyCode\": null,
        \"price\": null,
        \"priceVersion\": null
      }
    ]
  }
}"

Omnibus integration

Showing 11 of 11 endpoints

GET/dbbs_omnibus/attempts

List attemptss

Returns a paginated collection of attemptss.

Parameters

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	—
ids	query	No	any	Comma-separated list of record UUIDs to filter by (max 200).

Responses

200Paginated attemptss

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "string",
      "state": "string",
      "version": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus/attempts?page=1&pageSize=25&sortField=created_at&sortDir=desc" \
  -H "Accept: application/json"

POST/dbbs_omnibus/attempts

Create attempts

Creates a new attempts.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "action": "settings.create",
  "key": "string",
  "source": {
    "system": "string",
    "companyCode": "string",
    "contractVersion": "string",
    "evidenceId": "string"
  },
  "effectiveFrom": "string",
  "values": {
    "type": "display",
    "pageSize": 1,
    "dateFormat": "iso",
    "timezone": "string"
  }
}

Responses

201attempts created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "string",
  "state": "string",
  "version": 1,
  "updatedAt": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus/attempts" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"action\": \"settings.create\",
  \"key\": \"string\",
  \"source\": {
    \"system\": \"string\",
    \"companyCode\": \"string\",
    \"contractVersion\": \"string\",
    \"evidenceId\": \"string\"
  },
  \"effectiveFrom\": \"string\",
  \"values\": {
    \"type\": \"display\",
    \"pageSize\": 1,
    \"dateFormat\": \"iso\",
    \"timezone\": \"string\"
  }
}"

GET/dbbs_omnibus/coverage

Auth required

Inspect exact source metadata and proposed backend bindings without claiming acceptance

Responses

200Verified 601-row source snapshot, 1790 exact labels, proposed owners/contracts and unbound qualification requirements; issue obligations remain separate

Content-Type: application/json

{
  "catalogueStatus": "verified_metadata_handoff",
  "sourceControlCoverage": {
    "schema": "dbbs.omnibus.source-coverage.v1",
    "snapshotId": "OMNI-CATALOGUE-20261106-V1",
    "integrity": {
      "schema": "dbbs.omnibus.source-integrity.v1",
      "repository": "don-brown-bus-sales/dbbs-operations",
      "commit": "29b2a3782799e6acadf4ca654e74a91e78e39732",
      "snapshotId": "OMNI-CATALOGUE-20261106-V1",
      "verificationKind": "static_metadata_bytes_only",
      "files": [
        {
          "name": "string",
          "sourcePath": "string",
          "localPath": "string",
          "bytes": 1,
          "sha256": "string",
          "gitBlobSha": "string",
          "manifestListed": true
        }
      ]
    },
    "qualification": [
      "string"
    ],
    "assignmentQualification": "string",
    "totalScreenDenominator": "unknown",
    "metadataMembershipComplete": true,
    "sourceBindingComplete": false,
    "backendAccepted": false,
    "operatorAccepted": false,
    "counts": {
      "typedRows": 601,
      "contractLabels": 1790,
      "rowTypes": {
        "key": 1
      },
      "baselineScreens": 315,
      "additionalScreens": 2,
      "workflows": 59,
      "lexicalEvents": 166,
      "lexicalTokens": 73,
      "literalFlows": 36,
      "literalDraftFields": 146,
      "sourceBoundRows": 0,
      "sourceBoundControls": 0,
      "verifiedAccepted": 0
    },
    "historicalSourceClaims": {},
    "remainingSourceGaps": [
      {
        "title": "string",
        "count": 1,
        "detail": "string",
        "items": [
          "string"
        ]
      }
    ],
    "sourceIndex": {
      "artifact": "string",
      "recorded_at_utc": "string",
      "sha256": "string",
      "referenced_builder_sha256": "string",
      "matches_this_catalogue": false,
      "qualification": "string"
    },
    "sourceAssetHashes": [
      {
        "artifact": "string",
        "sha256": "string",
        "bytes": 1
      }
    ],
    "lexicalMetadata": {
      "schema": "comet.omnibus.prototype-bindings.v1",
      "snapshot_id": "OMNI-CATALOGUE-20261106-V1",
      "captured_at_utc": "string",
      "method": "string",
      "coverage_limits": [
        "string"
      ],
      "counts": {
        "control_requirements": 1,
        "literal_event_occurrences": 1,
        "unique_literal_tokens": 1,
        "literal_flow_definitions": 1,
        "literal_draft_field_occurrences": 1
      },
      "prototype_event_occurrences": [
        {
          "kind": "string",
          "token": "string",
          "source_asset": "string",
          "line": 1,
          "qualification": "string"
        }
      ],
      "prototype_flow_definitions": [
        {
          "prototype_flow_id": "string",
          "route_pattern": "string",
          "source_asset": "string",
          "line": 1,
          "qualification": "string"
        }
      ],
      "prototype_draft_fields": [
        {
          "prototype_draft_key": "string",
          "label": "string",
          "source_asset": "string",
          "line": 1,
          "qualification": "string"
        }
      ],
      "control_requirement_defaults": {
        "binding_id_kind": "proposed_from_source_row_and_ordinal",
        "control_semantics": "unclassified_source_label_not_an_API_action",
        "route_and_anchor_lookup": "string"
      },
      "asset_hash_lookup": "string"
    },
    "ownerReferences": [
      {
        "id": "string",
        "owner": "string",
        "repository": "string",
        "commit": "string",
        "code": "string",
        "publicContract": "string",
        "availability": "installed_main_seam",
        "qualification": "string"
      }
    ],
    "profiles": [
      {
        "id": "string",
        "owner": "string",
        "group": "integration",
        "lanes": [
          "string"
        ],
        "contractIds": [
          "string"
        ],
        "ownerRefIds": [
          "string"
        ],
        "missingContracts": [
          "string"
        ],
        "rationale": "string",
        "sourceBindingStatus": "unbound",
        "accepted": false,
        "candidateContracts": [
          {
            "id": "string",
            "lane": "string",
            "route": "string",
            "method": "GET",
            "commandId": null,
            "schemaExport": "string",
            "permission": "string",
            "writer": "string",
            "effects": [
              "string"
            ],
            "tests": [
              "string"
            ],
            "dependencies": [
              "string"
            ]
          }
        ]
      }
    ],
    "rows": [
      {
        "source_type": "screen",
        "source_id": "string",
        "sourceClaims": {
          "type": "screen",
          "source_id": "string",
          "module": "string",
          "source_title": "string",
          "legacy_route": "string",
          "source_status": "string",
          "target_route": "string",
          "component_anchor": "string",
          "state_anchor": "string",
          "source_evidence": [
            "string"
          ],
          "design_complete": "string",
          "locally_exercised": "string",
          "backend_implemented": "string",
          "operator_accepted": "string",
          "still_unresolved": "string"
        },
        "profileIds": [
          "string"
        ],
        "sourceBindingStatus": "unbound",
        "accepted": false
      }
    ],
    "controls": [
      {
        "binding_id": "string",
        "source_id": "string",
        "source_type": "screen",
        "ordinal": 1,
        "label": "string",
        "bindingIdKind": "proposed_from_source_row_and_ordinal",
        "semantics": "unclassified_source_label_not_an_API_action",
        "profileIds": [
          "string"
        ],
        "sourceBindingStatus": "unbound",
        "accepted": false
      }
    ]
  },
  "operatorAccepted": false,
  "contracts": [
    {
      "id": "string",
      "lane": "string",
      "route": "string",
      "method": "GET",
      "commandId": null,
      "schemaExport": "string",
      "permission": "string",
      "writer": "string",
      "effects": [
        "string"
      ],
      "tests": [
        "string"
      ],
      "dependencies": [
        "string"
      ]
    }
  ],
  "knownObligations": {
    "version": 1,
    "inventoryId": "issue26-known-obligations-v1",
    "handoffId": "COMET-AXLE-OMNIBUS-BACKEND-20261106-01",
    "issueUrl": "https://github.com/don-brown-bus-sales/dbbs-operations/issues/26",
    "sourceQualification": "string",
    "catalogueStatus": "verified_metadata_handoff",
    "totalScreenDenominator": "unknown",
    "sourceCoverageAccepted": false,
    "operatorAccepted": false,
    "executionEvidence": "not_claimed_by_inventory",
    "dependencies": [
      {
        "id": "string",
        "owner": "string",
        "missing": "string",
        "nextAction": "string"
      }
    ],
    "obligations": [
      {
        "id": "string",
        "lane": "AX-OB-01",
        "provenance": "https://github.com/don-brown-bus-sales/dbbs-operations/issues/26",
        "requirement": "string",
        "status": "implemented_proposed",
        "owner": "string",
        "delivered": "string",
        "codeEvidence": [
          "string"
        ],
        "testEvidence": [
          "string"
        ],
        "dependencyIds": [
          "string"
        ],
        "acceptance": "not_claimed"
      }
    ]
  }
}

400Query parameters unsupported

Content-Type: application/json

"string"

401Authentication required

Content-Type: application/json

"string"

403Contract view feature denied

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus/coverage" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dbbs_omnibus/history

Auth required

Read immutable scoped revision history

Parameters

Name	In	Required	Schema	Description
id	query	Yes	any	—
kind	query	Yes	any	—
page	query	No	any	—
pageSize	query	No	any	—

Responses

200Ordered original revisions

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "version": 1
    }
  ],
  "total": 1
}

400Invalid query

Content-Type: application/json

"string"

401Authentication required

Content-Type: application/json

"string"

403Feature denied

Content-Type: application/json

"string"

404Scoped record absent

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus/history?id=00000000-0000-4000-8000-000000000000&kind=settings&page=1&pageSize=25" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dbbs_omnibus/imports

List importss

Returns a paginated collection of importss.

Parameters

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	—
ids	query	No	any	Comma-separated list of record UUIDs to filter by (max 200).

Responses

200Paginated importss

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "string",
      "state": "string",
      "version": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus/imports?page=1&pageSize=25&sortField=created_at&sortDir=desc" \
  -H "Accept: application/json"

POST/dbbs_omnibus/imports

Create imports

Creates a new imports.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "action": "settings.create",
  "key": "string",
  "source": {
    "system": "string",
    "companyCode": "string",
    "contractVersion": "string",
    "evidenceId": "string"
  },
  "effectiveFrom": "string",
  "values": {
    "type": "display",
    "pageSize": 1,
    "dateFormat": "iso",
    "timezone": "string"
  }
}

Responses

201imports created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "string",
  "state": "string",
  "version": 1,
  "updatedAt": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus/imports" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"action\": \"settings.create\",
  \"key\": \"string\",
  \"source\": {
    \"system\": \"string\",
    \"companyCode\": \"string\",
    \"contractVersion\": \"string\",
    \"evidenceId\": \"string\"
  },
  \"effectiveFrom\": \"string\",
  \"values\": {
    \"type\": \"display\",
    \"pageSize\": 1,
    \"dateFormat\": \"iso\",
    \"timezone\": \"string\"
  }
}"

GET/dbbs_omnibus/preferences

List preferencess

Returns a paginated collection of preferencess.

Parameters

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	—
ids	query	No	any	Comma-separated list of record UUIDs to filter by (max 200).

Responses

200Paginated preferencess

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "string",
      "state": "string",
      "version": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus/preferences?page=1&pageSize=25&sortField=created_at&sortDir=desc" \
  -H "Accept: application/json"

POST/dbbs_omnibus/preferences

Create preferences

Creates a new preferences.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "action": "settings.create",
  "key": "string",
  "source": {
    "system": "string",
    "companyCode": "string",
    "contractVersion": "string",
    "evidenceId": "string"
  },
  "effectiveFrom": "string",
  "values": {
    "type": "display",
    "pageSize": 1,
    "dateFormat": "iso",
    "timezone": "string"
  }
}

Responses

201preferences created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "string",
  "state": "string",
  "version": 1,
  "updatedAt": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus/preferences" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"action\": \"settings.create\",
  \"key\": \"string\",
  \"source\": {
    \"system\": \"string\",
    \"companyCode\": \"string\",
    \"contractVersion\": \"string\",
    \"evidenceId\": \"string\"
  },
  \"effectiveFrom\": \"string\",
  \"values\": {
    \"type\": \"display\",
    \"pageSize\": 1,
    \"dateFormat\": \"iso\",
    \"timezone\": \"string\"
  }
}"

GET/dbbs_omnibus/requests

Auth required

Recover the original scoped request result without resending

Parameters

Name	In	Required	Schema	Description
requestId	query	Yes	any	—
kind	query	Yes	any	—

Responses

200Immutable original result and current projection status

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "requestId": "00000000-0000-4000-8000-000000000000",
  "readModel": "pending"
}

400Invalid query

Content-Type: application/json

"string"

401Authentication required

Content-Type: application/json

"string"

403Feature denied

Content-Type: application/json

"string"

404Request not found for this actor and scope

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus/requests?requestId=00000000-0000-4000-8000-000000000000&kind=settings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dbbs_omnibus/settings

List settingss

Returns a paginated collection of settingss.

Parameters

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	—
ids	query	No	any	Comma-separated list of record UUIDs to filter by (max 200).

Responses

200Paginated settingss

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "kind": "string",
      "state": "string",
      "version": 1,
      "updatedAt": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus/settings?page=1&pageSize=25&sortField=created_at&sortDir=desc" \
  -H "Accept: application/json"

POST/dbbs_omnibus/settings

Create settings

Creates a new settings.

Request body (application/json)

{
  "requestId": "00000000-0000-4000-8000-000000000000",
  "action": "settings.create",
  "key": "string",
  "source": {
    "system": "string",
    "companyCode": "string",
    "contractVersion": "string",
    "evidenceId": "string"
  },
  "effectiveFrom": "string",
  "values": {
    "type": "display",
    "pageSize": 1,
    "dateFormat": "iso",
    "timezone": "string"
  }
}

Responses

201settings created

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "kind": "string",
  "state": "string",
  "version": 1,
  "updatedAt": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dbbs_omnibus/settings" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"requestId\": \"00000000-0000-4000-8000-000000000000\",
  \"action\": \"settings.create\",
  \"key\": \"string\",
  \"source\": {
    \"system\": \"string\",
    \"companyCode\": \"string\",
    \"contractVersion\": \"string\",
    \"evidenceId\": \"string\"
  },
  \"effectiveFrom\": \"string\",
  \"values\": {
    \"type\": \"display\",
    \"pageSize\": 1,
    \"dateFormat\": \"iso\",
    \"timezone\": \"string\"
  }
}"

Devices (admin)

Showing 3 of 3 endpoints

GET/devices/admin/devices/{id}

Auth required

Get any device

Admin: fetch a single device by id (push_token is never returned).

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Device

Content-Type: application/json

{
  "item": {
    "id": "00000000-0000-4000-8000-000000000000",
    "user_id": "00000000-0000-4000-8000-000000000000",
    "device_id": "string",
    "platform": "ios",
    "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
  }
}

400Invalid id

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Missing devices.admin

Content-Type: application/json

{
  "error": "string"
}

404Device not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/devices/admin/devices/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/devices/admin/devices/{id}

Auth required

Update any device

Admin: update last-seen, app/OS metadata, and push token for any device. Set pushToken to null to clear it.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "clientAppVersion": null,
  "osVersion": null,
  "locale": null,
  "pushToken": null,
  "pushProvider": null
}

Responses

200Device updated

Content-Type: application/json

{
  "ok": true
}

400Invalid payload or id

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Missing devices.admin

Content-Type: application/json

{
  "error": "string"
}

404Device not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/devices/admin/devices/{id}

Auth required

Deactivate any device

Admin: soft-delete any device in the tenant.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Device deactivated

Content-Type: application/json

{
  "ok": true
}

400Invalid id

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Missing devices.admin

Content-Type: application/json

{
  "error": "string"
}

404Device not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/devices/admin/devices/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Dictionaries

Showing 11 of 11 endpoints

GET/dictionaries

Auth required

List dictionaries

Returns dictionaries accessible to the current organization, optionally including inactive records.

Parameters

Name	In	Required	Schema	Description
includeInactive	query	No	any	—

Responses

200Dictionary collection.

Content-Type: application/json

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

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

500Failed to load dictionaries

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dictionaries" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dictionaries

Auth required

Create dictionary

Registers a dictionary scoped to the current organization.

Request body (application/json)

{
  "key": "string",
  "name": "string"
}

Responses

201Dictionary created.

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "key": "string",
  "name": "string",
  "description": null,
  "isSystem": true,
  "isActive": true,
  "managerVisibility": null,
  "organizationId": null,
  "createdAt": "string",
  "updatedAt": null
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

409Dictionary key already exists

Content-Type: application/json

{
  "error": "string"
}

500Failed to create dictionary

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/dictionaries" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"key\": \"string\",
  \"name\": \"string\"
}"

GET/dictionaries/{dictionaryId}

Auth required

Get dictionary

Returns details for the specified dictionary, including inheritance flags.

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—

Responses

200Dictionary details.

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "key": "string",
  "name": "string",
  "description": null,
  "isSystem": true,
  "isActive": true,
  "managerVisibility": null,
  "organizationId": null,
  "createdAt": "string",
  "updatedAt": null
}

400Invalid parameters

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

404Dictionary not found

Content-Type: application/json

{
  "error": "string"
}

500Failed to load dictionary

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dictionaries/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/dictionaries/{dictionaryId}

Auth required

Update dictionary

Updates mutable attributes of the dictionary. Currency dictionaries are protected from modification.

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—

Request body (application/json)

{}

Responses

200Dictionary updated.

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "key": "string",
  "name": "string",
  "description": null,
  "isSystem": true,
  "isActive": true,
  "managerVisibility": null,
  "organizationId": null,
  "createdAt": "string",
  "updatedAt": null
}

400Validation failed or protected dictionary

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

404Dictionary not found

Content-Type: application/json

{
  "error": "string"
}

409Dictionary key already exists

Content-Type: application/json

{
  "error": "string"
}

500Failed to update dictionary

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PATCH "https://fixture.omnibus.buscrazy.net/api/dictionaries/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{}"

DELETE/dictionaries/{dictionaryId}

Auth required

Delete dictionary

Soft deletes the dictionary unless it is the protected currency dictionary.

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—

Responses

200Dictionary archived.

Content-Type: application/json

{
  "ok": true
}

400Protected dictionary cannot be deleted

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

404Dictionary not found

Content-Type: application/json

{
  "error": "string"
}

500Failed to delete dictionary

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/dictionaries/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/dictionaries/{dictionaryId}/entries

Auth required

List dictionary entries

Returns 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.

Parameters

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.

Responses

200Dictionary entries.

Content-Type: application/json

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

400Invalid parameters

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

404Dictionary not found

Content-Type: application/json

{
  "error": "string"
}

500Failed to load dictionary entries

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/dictionaries/00000000-0000-4000-8000-000000000000/entries" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dictionaries/{dictionaryId}/entries

Auth required

Create dictionary entry

Creates a new entry in the specified dictionary.

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—

Request body (application/json)

{
  "value": "string",
  "color": null,
  "icon": null
}

Responses

201Dictionary entry created.

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "value": "string",
  "label": "string",
  "color": null,
  "icon": null,
  "position": 1,
  "isDefault": true,
  "createdAt": "string",
  "updatedAt": null
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

404Dictionary not found

Content-Type: application/json

{
  "error": "string"
}

500Failed to create dictionary entry

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PATCH/dictionaries/{dictionaryId}/entries/{entryId}

Auth required

Update dictionary entry

Updates the specified dictionary entry using the command bus pipeline.

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—
entryId	path	Yes	any	—

Request body (application/json)

{
  "color": null,
  "icon": null
}

Responses

200Dictionary entry updated.

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000",
  "value": "string",
  "label": "string",
  "color": null,
  "icon": null,
  "position": 1,
  "isDefault": true,
  "createdAt": "string",
  "updatedAt": null
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

404Dictionary or entry not found

Content-Type: application/json

{
  "error": "string"
}

500Failed to update entry

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PATCH "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/dictionaries/{dictionaryId}/entries/{entryId}

Auth required

Delete dictionary entry

Deletes the specified dictionary entry via the command bus.

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—
entryId	path	Yes	any	—

Responses

200Entry deleted.

Content-Type: application/json

{
  "ok": true
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

404Dictionary or entry not found

Content-Type: application/json

{
  "error": "string"
}

500Failed to delete entry

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/dictionaries/00000000-0000-4000-8000-000000000000/entries/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/dictionaries/{dictionaryId}/entries/reorder

Auth required

Reorder dictionary entries

Updates the position of dictionary entries for drag-and-drop reordering.

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—

Request body (application/json)

{
  "entries": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "position": 1
    }
  ]
}

Responses

200Entries reordered.

Content-Type: application/json

{
  "ok": true
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

404Dictionary not found

Content-Type: application/json

{
  "error": "string"
}

500Failed to reorder entries

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
    }
  ]
}"

POST/dictionaries/{dictionaryId}/entries/set-default

Auth required

Set default dictionary entry

Marks the specified entry as the default for this dictionary, clearing any previous default.

Parameters

Name	In	Required	Schema	Description
dictionaryId	path	Yes	any	—

Request body (application/json)

{
  "entryId": "00000000-0000-4000-8000-000000000000"
}

Responses

200Default entry set.

Content-Type: application/json

{
  "ok": true
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

404Dictionary or entry not found

Content-Type: application/json

{
  "error": "string"
}

500Failed to set default entry

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

Entities

Showing 19 of 19 endpoints

GET/entities/definitions

Auth required

List active custom field definitions

Returns active custom field definitions for the supplied entity ids, respecting tenant scope and tombstones.

Parameters

Name	In	Required	Schema	Description
entityId	query	No	any	—
entityIds	query	No	any	—
fieldset	query	No	any	—

Responses

200Definition list

Content-Type: application/json

{
  "items": [
    {
      "key": "string",
      "kind": "string",
      "label": "string",
      "entityId": "string"
    }
  ]
}

400Missing entity id

Content-Type: application/json

{
  "error": "string"
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/entities/definitions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/entities/definitions

Auth required

Upsert custom field definition

Creates or updates a custom field definition for the current tenant/org scope.

Request body (application/json)

{
  "entityId": "string",
  "key": "string",
  "kind": "text"
}

Responses

200Definition saved

Content-Type: application/json

{
  "ok": true,
  "item": {
    "id": "00000000-0000-4000-8000-000000000000",
    "key": "string",
    "kind": "string",
    "configJson": {}
  }
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/entities/definitions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"entityId\": \"string\",
  \"key\": \"string\",
  \"kind\": \"text\"
}"

DELETE/entities/definitions

Auth required

Soft delete custom field definition

Marks the specified definition inactive and tombstones it for the current scope.

Request body (application/json)

{
  "entityId": "string",
  "key": "string"
}

Responses

200Definition deleted

Content-Type: application/json

{
  "ok": true,
  "version": null
}

400Missing entity id or key

Content-Type: application/json

{
  "error": "string"
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

404Definition not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/entities/definitions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"entityId\": \"string\",
  \"key\": \"string\"
}"

POST/entities/definitions.batch

Auth required

Save multiple custom field definitions

Creates or updates multiple definitions for a single entity in one transaction.

Request body (application/json)

{
  "entityId": "string",
  "definitions": [
    {
      "key": "string",
      "kind": "text"
    }
  ]
}

Responses

200Definitions saved

Content-Type: application/json

{
  "ok": true,
  "version": null
}

400Validation error

Content-Type: application/json

{
  "error": "string"
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

500Unexpected failure

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
    }
  ]
}"

GET/entities/definitions.manage

Auth required

Get management snapshot

Returns scoped custom field definitions (including inactive tombstones) for administration interfaces.

Parameters

Name	In	Required	Schema	Description
entityId	query	Yes	any	—

Responses

200Scoped definitions and deleted keys

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "key": "string",
      "kind": "string",
      "configJson": null,
      "organizationId": null,
      "tenantId": null
    }
  ],
  "deletedKeys": [
    "string"
  ],
  "version": null
}

400Missing entity id

Content-Type: application/json

{
  "error": "string"
}

401Missing authentication or feature

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/entities/definitions.manage?entityId=string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/entities/definitions.restore

Auth required

Restore definition

Reactivates a previously soft-deleted definition within the current tenant/org scope.

Request body (application/json)

{
  "entityId": "string",
  "key": "string"
}

Responses

200Definition restored

Content-Type: application/json

{
  "ok": true
}

400Missing entity id or key

Content-Type: application/json

{
  "error": "string"
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

404Definition not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/entities/definitions.restore" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"entityId\": \"string\",
  \"key\": \"string\"
}"

GET/entities/encryption

Auth required

Fetch encryption map

Returns the encrypted field map for the current tenant/organization scope.

Parameters

Name	In	Required	Schema	Description
entityId	query	Yes	any	—

Responses

200Map

Content-Type: application/json

{
  "entityId": "string",
  "fields": [
    {
      "field": "string",
      "hashField": null
    }
  ],
  "updatedAt": null
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/entities/encryption?entityId=string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/entities/encryption

Auth required

Upsert encryption map

Creates or updates the encryption map for the current tenant/organization scope. Enforces optimistic locking when the caller sends the expected version header.

Request body (application/json)

{
  "entityId": "string",
  "tenantId": null,
  "organizationId": null,
  "fields": [
    {
      "field": "string",
      "hashField": null
    }
  ]
}

Responses

200Saved

Content-Type: application/json

{
  "ok": true,
  "updatedAt": null
}

409Optimistic-lock conflict (stale write)

Content-Type: application/json

{
  "error": "string",
  "code": "string",
  "currentUpdatedAt": "string",
  "expectedUpdatedAt": "string"
}

422Selected organization is unavailable

Content-Type: application/json

{
  "error": "string",
  "code": "organization_selection_invalid"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
    }
  ]
}"

GET/entities/entities

Auth required

List available entities

Returns generated and custom entities scoped to the caller with field counts per entity.

Responses

200List of entities

Content-Type: application/json

{
  "items": [
    {
      "entityId": "string",
      "source": "code",
      "label": "string",
      "count": 1
    }
  ]
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/entities/entities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/entities/entities

Auth required

Upsert custom entity

Creates or updates a tenant/org scoped custom entity definition.

Request body (application/json)

{
  "entityId": "string",
  "label": "string",
  "description": null,
  "showInSidebar": false,
  "accessRestricted": false
}

Responses

200Entity saved

Content-Type: application/json

{
  "ok": true,
  "item": {
    "id": "00000000-0000-4000-8000-000000000000",
    "entityId": "string",
    "label": "string"
  }
}

400Validation error

Content-Type: application/json

{
  "error": "string"
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/entities/entities

Auth required

Soft delete custom entity

Marks the specified custom entity inactive within the current scope.

Request body (application/json)

{
  "entityId": "string"
}

Responses

200Entity deleted

Content-Type: application/json

{
  "ok": true
}

400Missing entity id

Content-Type: application/json

{
  "error": "string"
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

404Entity not found in scope

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/entities/entities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"entityId\": \"string\"
}"

GET/entities/entity-settings

Auth required

Get custom entity settings

Returns the tenant-scoped default-restricted policy for new custom entities.

Responses

200Current settings

Content-Type: application/json

{
  "newEntitiesRestrictedByDefault": true,
  "updatedAt": null
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/entities/entity-settings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/entities/entity-settings

Auth required

Update custom entity settings

Sets the tenant-scoped default-restricted policy for new custom entities.

Request body (application/json)

{
  "newEntitiesRestrictedByDefault": true
}

Responses

200Updated settings

Content-Type: application/json

{
  "ok": true,
  "newEntitiesRestrictedByDefault": true,
  "updatedAt": null
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

409Optimistic lock conflict

Content-Type: application/json

{
  "code": "string",
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/entities/entity-settings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"newEntitiesRestrictedByDefault\": true
}"

GET/entities/records

Auth required

List records

Returns paginated records for the supplied entity. Supports custom field filters, exports, and soft-delete toggles.

Parameters

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	—

Responses

200Paginated records

Content-Type: application/json

{
  "items": [
    {}
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

400Missing entity id

Content-Type: application/json

{
  "error": "string"
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

500Unexpected failure

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/entities/records?entityId=string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/entities/records

Auth required

Create record

Creates a record for the given entity. When `recordId` is omitted or not a UUID the data engine will generate one automatically.

Request body (application/json)

{
  "entityId": "string",
  "values": {}
}

Responses

200Record created

Content-Type: application/json

{
  "ok": true
}

400Validation failure

Content-Type: application/json

{
  "error": "string"
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

500Unexpected failure

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/entities/records" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"entityId\": \"string\",
  \"values\": {}
}"

PUT/entities/records

Auth required

Update record

Updates an existing record. If the provided recordId is not a UUID the record will be created instead to support optimistic flows.

Request body (application/json)

{
  "entityId": "string",
  "recordId": "string",
  "values": {}
}

Responses

200Record updated

Content-Type: application/json

{
  "ok": true
}

400Validation failure

Content-Type: application/json

{
  "error": "string"
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

500Unexpected failure

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/entities/records" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"entityId\": \"string\",
  \"recordId\": \"string\",
  \"values\": {}
}"

DELETE/entities/records

Auth required

Delete record

Soft deletes the specified record within the current tenant/org scope.

Request body (application/json)

{
  "entityId": "string",
  "recordId": "string"
}

Responses

200Record deleted

Content-Type: application/json

{
  "ok": true
}

400Missing entity id or record id

Content-Type: application/json

{
  "error": "string"
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

404Record not found

Content-Type: application/json

{
  "error": "string"
}

500Unexpected failure

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/entities/records" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"entityId\": \"string\",
  \"recordId\": \"string\"
}"

GET/entities/relations/options

Auth required

List relation options

Returns 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.

Parameters

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	—

Responses

200Option list

Content-Type: application/json

{
  "items": [
    {
      "value": "string",
      "label": "string"
    }
  ]
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/entities/relations/options?entityId=string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/entities/sidebar-entities

Auth required

Get sidebar entities

Returns custom entities flagged with `showInSidebar` for the current tenant/org scope.

Responses

200Sidebar entities for navigation

Content-Type: application/json

{
  "items": [
    {
      "entityId": "string",
      "label": "string",
      "href": "string"
    }
  ]
}

401Missing authentication

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/entities/sidebar-entities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

EUDR

Showing 20 of 32 endpoints

GET/eudr/dashboard/widgets/compliance-overview

Auth required

Compliance overview

Responses

200EUDR compliance overview metrics

Content-Type: application/json

{
  "deadline": {
    "date": "2026-12-30",
    "daysLeft": 1
  },
  "statements": {
    "total": 1,
    "byStatus": {
      "key": 1
    },
    "notReady": 1,
    "missingReference": 1
  },
  "queues": {}
}

400Invalid organization context

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "error": "string"
}

500Compliance overview loading failed

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/eudr/dashboard/widgets/compliance-overview" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/eudr/evidence-submissions

Auth required

List evidence submissions

Returns a paginated collection of evidence submissions scoped to the authenticated organization.

Parameters

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	—

Responses

200Paginated evidence submissions

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/eudr/evidence-submissions?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/eudr/evidence-submissions

Auth required

Create evidence submission

Creates an EUDR supplier evidence submission for the scoped organization.

Request body (application/json)

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

Responses

201Evidence submission created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/eudr/evidence-submissions

Auth required

Update evidence submission

Updates an EUDR supplier evidence submission.

Request body (application/json)

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

Responses

200Evidence submission updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/eudr/evidence-submissions

Auth required

Delete evidence submission

Deletes an EUDR supplier evidence submission by id. Request body or query may provide the identifier.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Evidence submission deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/eudr/evidence-submissions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/eudr/mitigation-actions

Auth required

List mitigation actions

Returns a paginated collection of mitigation actions scoped to the authenticated organization.

Parameters

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	—

Responses

200Paginated mitigation actions

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/eudr/mitigation-actions?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/eudr/mitigation-actions

Auth required

Create mitigation action

Creates an EUDR mitigation action for the scoped organization.

Request body (application/json)

{
  "riskAssessmentId": "00000000-0000-4000-8000-000000000000",
  "title": "string",
  "description": null,
  "dueDate": null,
  "notes": null
}

Responses

201Mitigation action created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/eudr/mitigation-actions

Auth required

Update mitigation action

Updates an EUDR mitigation action.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "description": null,
  "dueDate": null,
  "notes": null
}

Responses

200Mitigation action updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/eudr/mitigation-actions

Auth required

Delete mitigation action

Deletes an EUDR mitigation action by id. Request body or query may provide the identifier.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Mitigation action deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/eudr/mitigation-actions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/eudr/plots

Auth required

List plots

Returns a paginated collection of plots scoped to the authenticated organization.

Parameters

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	—

Responses

200Paginated plots

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/eudr/plots?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/eudr/plots

Auth required

Create plot

Creates an EUDR supplier plot for the scoped organization.

Request body (application/json)

{
  "supplierEntityId": "00000000-0000-4000-8000-000000000000",
  "supplierSnapshot": null,
  "name": "string",
  "externalId": null,
  "description": null,
  "areaHa": null,
  "producerName": null
}

Responses

201Plot created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/eudr/plots

Auth required

Update plot

Updates an EUDR supplier plot.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "supplierSnapshot": null,
  "externalId": null,
  "description": null,
  "areaHa": null,
  "producerName": null
}

Responses

200Plot updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/eudr/plots

Auth required

Delete plot

Deletes an EUDR supplier plot by id. Request body or query may provide the identifier.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Plot deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/eudr/plots" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

POST/eudr/plots/import

Auth required

Import plots

Request body (application/json)

{
  "supplierEntityId": "00000000-0000-4000-8000-000000000000"
}

Responses

200Import result

Content-Type: application/json

{
  "created": 1,
  "failed": [
    {
      "index": 1,
      "name": "string",
      "errorKey": "string"
    }
  ]
}

400Invalid import payload

Content-Type: application/json

{}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "error": "string"
}

500Plot import failed

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/eudr/plots/import" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"supplierEntityId\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/eudr/product-mappings

Auth required

List product mappings

Returns a paginated collection of product mappings scoped to the authenticated organization.

Parameters

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	—

Responses

200Paginated product mappings

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/eudr/product-mappings?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/eudr/product-mappings

Auth required

Create product mapping

Creates an EUDR product commodity mapping for the scoped organization.

Request body (application/json)

{
  "productId": "00000000-0000-4000-8000-000000000000",
  "productSnapshot": null,
  "commodity": "cattle",
  "hsCode": null,
  "speciesScientificName": null,
  "speciesCommonName": null,
  "notes": null
}

Responses

201Product mapping created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/eudr/product-mappings

Auth required

Update product mapping

Updates an EUDR product commodity mapping.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "productSnapshot": null,
  "hsCode": null,
  "speciesScientificName": null,
  "speciesCommonName": null,
  "notes": null
}

Responses

200Product mapping updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/eudr/product-mappings

Auth required

Delete product mapping

Deletes an EUDR product commodity mapping by id. Request body or query may provide the identifier.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Product mapping deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/eudr/product-mappings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/eudr/product-mappings/suggestions

Auth required

Product mapping suggestions

Responses

200Suggested product mappings

Content-Type: application/json

{
  "items": [
    {
      "productId": "00000000-0000-4000-8000-000000000000",
      "name": "string",
      "sku": null,
      "hsCode": "string",
      "suggestedCommodity": "cattle"
    }
  ]
}

400Invalid organization context

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "error": "string"
}

500Product mapping suggestions loading failed

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/eudr/product-mappings/suggestions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/eudr/product-mappings/suggestions/apply

Auth required

Apply mapping suggestions

Request body (application/json)

{}

Responses

200Apply result

Content-Type: application/json

{
  "created": 1,
  "failed": [
    {
      "productId": "00000000-0000-4000-8000-000000000000",
      "errorKey": "string"
    }
  ]
}

400Invalid apply payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "error": "string"
}

500Mapping suggestion apply failed

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/eudr/product-mappings/suggestions/apply" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{}"

InboxOps

Showing 20 of 20 endpoints

GET/inbox_ops/emails

Auth required

List received emails

Processing log of all received emails

Responses

200Paginated list of emails

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/inbox_ops/emails" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/inbox_ops/emails/{id}

Auth required

Get email detail with parsed thread

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Email detail

Content-Type: application/json

"string"

404Email not found

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/inbox_ops/emails/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/inbox_ops/emails/{id}

Auth required

Soft-delete an inbox email

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Email deleted

Content-Type: application/json

"string"

404Email not found

Content-Type: application/json

"string"

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/inbox_ops/emails/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/emails/{id}/reprocess

Auth required

Re-trigger LLM extraction on a failed or low-confidence email

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Email queued for reprocessing

Content-Type: application/json

"string"

404Email not found

Content-Type: application/json

"string"

409Email is already processing or proposal cannot be superseded safely

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/inbox_ops/emails/:id/reprocess" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/extract

Auth required

Submit raw text for LLM extraction

Creates an InboxEmail record from raw text and triggers the extraction pipeline. The extraction runs asynchronously.

Responses

200Extraction queued successfully

Content-Type: application/json

"string"

400Invalid request body

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/inbox_ops/extract" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/inbox_ops/proposals

Auth required

List proposals

List inbox proposals with optional status filter and pagination

Responses

200Paginated list of proposals

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/inbox_ops/proposals" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/inbox_ops/proposals/{id}

Auth required

Get proposal detail

Returns proposal with actions, discrepancies, and source email

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Full proposal detail

Content-Type: application/json

"string"

404Proposal not found

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/inbox_ops/proposals/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/accept-all

Auth required

Accept and execute all pending actions in a proposal

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200All actions processed

Content-Type: application/json

"string"

404Proposal not found

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/inbox_ops/proposals/:id/accept-all" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/inbox_ops/proposals/{id}/actions/{actionId}

Auth required

Edit action payload before accepting

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
actionId	path	Yes	any	—

Responses

200Action updated

Content-Type: application/json

"string"

404Action not found

Content-Type: application/json

"string"

409Action already processed or stale (optimistic-lock conflict)

Content-Type: application/json

"string"

Example

curl -X PATCH "https://fixture.omnibus.buscrazy.net/api/inbox_ops/proposals/:id/actions/:actionId" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/actions/{actionId}/accept

Auth required

Accept and execute a proposal action

Executes the action and creates the entity in the target module. Returns 409 if already processed.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
actionId	path	Yes	any	—

Responses

200Action executed successfully

Content-Type: application/json

"string"

403Insufficient permissions in target module

Content-Type: application/json

"string"

404Action not found

Content-Type: application/json

"string"

409Action already processed

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/inbox_ops/proposals/:id/actions/:actionId/accept" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/inbox_ops/proposals/{id}/actions/{actionId}/complete

Auth required

Mark an action as completed with an externally-created entity

Used when an action is fulfilled through the normal sales form instead of the execution engine. Updates the action status without running the execution engine.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
actionId	path	Yes	any	—

Responses

200Action marked as completed

Content-Type: application/json

"string"

400Invalid body

Content-Type: application/json

"string"

404Action not found

Content-Type: application/json

"string"

409Action already processed

Content-Type: application/json

"string"

Example

curl -X PATCH "https://fixture.omnibus.buscrazy.net/api/inbox_ops/proposals/:id/actions/:actionId/complete" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/actions/{actionId}/reject

Auth required

Reject a proposal action

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
actionId	path	Yes	any	—

Responses

200Action rejected

Content-Type: application/json

"string"

404Action not found

Content-Type: application/json

"string"

409Action already processed

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/inbox_ops/proposals/:id/actions/:actionId/reject" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/categorize

Auth required

Set or change the category of a proposal

Assigns a category to a proposal. Returns the new and previous category for undo support.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Category updated

Content-Type: application/json

"string"

400Invalid category value

Content-Type: application/json

"string"

404Proposal not found

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/inbox_ops/proposals/:id/categorize" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/reject

Auth required

Reject entire proposal (all pending actions)

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Proposal rejected

Content-Type: application/json

"string"

404Proposal not found

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/inbox_ops/proposals/:id/reject" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/replies/{replyId}/send

Auth required

Send a draft reply email and register it in messages when available

Sends 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.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
replyId	path	Yes	any	—

Responses

200Reply sent successfully

Content-Type: application/json

"string"

400Missing required payload fields

Content-Type: application/json

"string"

404Reply action not found

Content-Type: application/json

"string"

409Action in invalid state for sending, or a send is already in progress / completed for this reply

Content-Type: application/json

"string"

502Email delivery failed

Content-Type: application/json

"string"

503Email service not configured or disabled

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/inbox_ops/proposals/:id/replies/:replyId/send" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/proposals/{id}/translate

Auth required

Translate proposal content

Translates the proposal summary and action descriptions to the target locale. Results are cached.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Translation result

Content-Type: application/json

"string"

400Invalid target locale or same language

Content-Type: application/json

"string"

404Proposal not found

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/inbox_ops/proposals/:id/translate" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/inbox_ops/proposals/counts

Auth required

Get proposal status and category counts

Returns counts by status and by category for tab badges and filter dropdowns

Responses

200Status and category counts object

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/inbox_ops/proposals/counts" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/inbox_ops/settings

Auth required

Get tenant inbox configuration

Returns the forwarding address and configuration for this tenant

Responses

200Inbox settings

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/inbox_ops/settings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PATCH/inbox_ops/settings

Auth required

Update tenant inbox configuration

Updates working language and/or active status

Responses

200Updated settings

Content-Type: application/json

"string"

404Settings not found

Content-Type: application/json

"string"

Example

curl -X PATCH "https://fixture.omnibus.buscrazy.net/api/inbox_ops/settings" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/inbox_ops/webhook/inbound

Receive forwarded email from provider webhook

Public endpoint — validated by provider HMAC signature or Resend/Svix signature. Rate limited per tenant.

Request body (application/json)

{}

Responses

200Email received and queued for processing

Content-Type: application/json

"string"

400Invalid payload or signature

Content-Type: application/json

"string"

413Payload too large

Content-Type: application/json

"string"

429Rate limit exceeded

Content-Type: application/json

"string"

503Webhook secret not configured

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/inbox_ops/webhook/inbound" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{}"

Demo

Showing 1 of 1 endpoints

POST/onboarding/demo-feedback

Submit demo feedback

Sends a feedback/contact request from the demo environment to the configured admin.

Request body (application/json)

{
  "email": "user@example.com",
  "message": "",
  "termsAccepted": true,
  "marketingConsent": false
}

Responses

200Feedback sent successfully.

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/onboarding/demo-feedback" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"email\": \"user@example.com\",
  \"message\": \"\",
  \"termsAccepted\": true,
  \"marketingConsent\": false
}"

PaymentGateways

Showing 11 of 11 endpoints

POST/payment_gateways/cancel

Auth required

Cancel payment

Responses

200Payment cancelled

Content-Type: application/json

"string"

409Invalid payment status transition

Content-Type: application/json

"string"

422Invalid payload

Content-Type: application/json

"string"

502Gateway provider error

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/payment_gateways/cancel" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/payment_gateways/capture

Auth required

Capture payment

Responses

200Payment captured

Content-Type: application/json

"string"

409Invalid payment status transition, cumulative capture ceiling exceeded, or conflicting capture operation

Content-Type: application/json

"string"

422Invalid payload

Content-Type: application/json

"string"

502Gateway provider error

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/payment_gateways/capture" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/payment_gateways/providers

Auth required

List payment gateway descriptors

Responses

200List of safe payment gateway descriptors

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/payment_gateways/providers" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/payment_gateways/providers/{providerKey}

Auth required

Get payment gateway descriptor

Parameters

Name	In	Required	Schema	Description
providerKey	path	Yes	any	—

Responses

200Provider descriptor

Content-Type: application/json

"string"

404Provider descriptor not found

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/payment_gateways/providers/:providerKey" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/payment_gateways/refund

Auth required

Refund payment

Responses

200Payment refunded

Content-Type: application/json

"string"

409Invalid payment status transition

Content-Type: application/json

"string"

422Invalid payload

Content-Type: application/json

"string"

502Gateway provider error

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/payment_gateways/refund" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/payment_gateways/sessions

Auth required

Create payment session

Responses

201Payment session created

Content-Type: application/json

"string"

409Amount or currency does not match the referenced order

Content-Type: application/json

"string"

422Invalid payload or unknown provider

Content-Type: application/json

"string"

502Gateway provider error

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/payment_gateways/sessions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/payment_gateways/status

Auth required

Get stored transaction status

Responses

200Stored transaction status

Content-Type: application/json

"string"

400Missing or malformed transactionId

Content-Type: application/json

"string"

404Transaction not found

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/payment_gateways/status" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/payment_gateways/status

Auth required

Refresh transaction status from the provider

Responses

200Refreshed transaction status

Content-Type: application/json

"string"

401Unauthorized

Content-Type: application/json

"string"

404Transaction not found

Content-Type: application/json

"string"

422Missing or malformed payload

Content-Type: application/json

"string"

502Gateway provider error

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/payment_gateways/status" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/payment_gateways/transactions

Auth required

List payment transactions

Responses

200Payment transaction list

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/payment_gateways/transactions" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/payment_gateways/transactions/{id}

Auth required

Get payment transaction details

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Payment transaction details

Content-Type: application/json

"string"

404Transaction not found

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/payment_gateways/transactions/:id" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/payment_gateways/webhook/{provider}

Process inbound webhook from payment provider

Parameters

Name	In	Required	Schema	Description
provider	path	Yes	any	—

Responses

202Webhook accepted for async processing

Content-Type: application/json

"string"

401Signature verification failed

Content-Type: application/json

"string"

404Unknown provider

Content-Type: application/json

"string"

413Webhook payload too large

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/payment_gateways/webhook/:provider" \
  -H "Accept: application/json"

Perspectives

Showing 4 of 4 endpoints

GET/perspectives/{tableId}

Auth required

Load perspectives for a table

Returns personal perspectives and available role defaults for the requested table identifier.

Parameters

Name	In	Required	Schema	Description
tableId	path	Yes	any	—

Responses

200Current perspectives and defaults.

Content-Type: application/json

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

400Invalid table identifier

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/perspectives/string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/perspectives/{tableId}

Auth required

Create or update a perspective

Saves a personal perspective and optionally applies the same configuration to selected roles.

Parameters

Name	In	Required	Schema	Description
tableId	path	Yes	any	—

Request body (application/json)

{
  "name": "string",
  "settings": {}
}

Responses

200Perspective saved successfully.

Content-Type: application/json

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

400Validation failed or invalid roles provided

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Missing perspectives.role_defaults feature for role updates

Content-Type: application/json

{
  "error": "string"
}

409Optimistic lock conflict or perspective name already exists

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/perspectives/string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"name\": \"string\",
  \"settings\": {}
}"

DELETE/perspectives/{tableId}/{perspectiveId}

Auth required

Delete a personal perspective

Removes a perspective owned by the current user for the given table.

Parameters

Name	In	Required	Schema	Description
tableId	path	Yes	any	—
perspectiveId	path	Yes	any	—

Responses

200Perspective removed.

Content-Type: application/json

{
  "success": true
}

400Invalid identifiers supplied

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

404Perspective not found

Content-Type: application/json

{
  "error": "string"
}

409Optimistic lock conflict

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/perspectives/string/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/perspectives/{tableId}/roles/{roleId}

Auth required

Clear role perspectives for a table

Removes all role-level perspectives associated with the provided role identifier for the table.

Parameters

Name	In	Required	Schema	Description
tableId	path	Yes	any	—
roleId	path	Yes	any	—

Request body (application/json)

"string"

Responses

200Role perspectives cleared.

Content-Type: application/json

{
  "success": true
}

400Invalid identifiers supplied

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Missing perspectives.role_defaults feature

Content-Type: application/json

{
  "error": "string"
}

404Role not found in scope

Content-Type: application/json

{
  "error": "string"
}

409Optimistic lock conflict

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/perspectives/string/roles/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Planner

Showing 10 of 10 endpoints

GET/planner/availability

Auth required

List availability rules

Returns a paginated collection of availability rules scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated availability rules

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/planner/availability?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/planner/availability

Auth required

Create availability rule

Creates an availability rule for the selected subject.

Request body (application/json)

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

Responses

201Availability rule created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/planner/availability

Auth required

Update availability rule

Updates an availability rule by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "note": null,
  "unavailabilityReasonEntryId": null,
  "unavailabilityReasonValue": null
}

Responses

200Availability rule updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/planner/availability

Auth required

Delete availability rule

Deletes an availability rule by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Availability rule deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/planner/availability" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

POST/planner/availability-date-specific

Auth required

Replace date-specific availability

Replaces date-specific availability rules for the subject in a single request.

Request body (application/json)

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

Responses

200Date-specific availability updated

Content-Type: application/json

{
  "ok": true
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "error": "string"
}

409Conflict — the subject/date availability was modified by another edit

Content-Type: application/json

{
  "error": "string",
  "code": "string",
  "currentUpdatedAt": "string",
  "expectedUpdatedAt": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

GET/planner/availability-rule-sets

Auth required

List availability rule sets

Returns a paginated collection of availability rule sets scoped to the authenticated organization.

Parameters

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	—

Responses

200Paginated availability rule sets

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/planner/availability-rule-sets?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/planner/availability-rule-sets

Auth required

Create availability rule set

Creates a reusable availability rule set.

Request body (application/json)

{
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "name": "string",
  "description": null,
  "timezone": "string"
}

Responses

201Availability rule set created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

PUT/planner/availability-rule-sets

Auth required

Update availability rule set

Updates an availability rule set by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "description": null
}

Responses

200Availability rule set updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/planner/availability-rule-sets

Auth required

Delete availability rule set

Deletes an availability rule set by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Availability rule set deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/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\"
}"

POST/planner/availability-weekly

Auth required

Replace weekly availability

Replaces weekly availability rules for the subject in a single request.

Request body (application/json)

{
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "subjectType": "member",
  "subjectId": "00000000-0000-4000-8000-000000000000",
  "timezone": "string",
  "windows": []
}

Responses

200Weekly availability updated

Content-Type: application/json

{
  "ok": true
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "error": "string"
}

409Optimistic lock conflict

Content-Type: application/json

{
  "error": "string",
  "code": "optimistic_lock_conflict",
  "currentUpdatedAt": "string",
  "expectedUpdatedAt": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\": []
}"

PushNotifications

Showing 2 of 2 endpoints

GET/push_notifications/deliveries

Auth required

List push deliveries

Returns the tenant's push push deliveries (admin observability).

Parameters

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).

Responses

200Paginated push deliveries

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/push_notifications/deliveries?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/push_notifications/deliveries/{id}

Auth required

Get a push delivery

Admin: fetch a single push delivery row (payload + provider response; no full push token).

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Push delivery

Content-Type: application/json

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

400Invalid id

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Missing push_notifications.view_deliveries

Content-Type: application/json

{
  "error": "string"
}

404Delivery not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/push_notifications/deliveries/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Query Index

Showing 3 of 3 endpoints

POST/query_index/purge

Auth required

Purge query index records

Queues a purge job to remove indexed records for an entity type within the active scope.

Request body (application/json)

{
  "entityType": "string"
}

Responses

200Purge job accepted.

Content-Type: application/json

{
  "ok": true
}

400Missing entity type

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/query_index/purge" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"entityType\": \"string\"
}"

POST/query_index/reindex

Auth required

Trigger query index rebuild

Queues a reindex job for the specified entity type within the current tenant scope.

Request body (application/json)

{
  "entityType": "string"
}

Responses

200Reindex job accepted.

Content-Type: application/json

{
  "ok": true
}

400Missing entity type

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/query_index/reindex" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"entityType\": \"string\"
}"

GET/query_index/status

Auth required

Inspect query index coverage

Returns entity counts comparing base tables with the query index along with the latest job status.

Responses

200Current query index status.

Content-Type: application/json

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

400Tenant or organization context required

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/query_index/status" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

RateLimitProbe

Showing 1 of 1 endpoints

POST/ratelimit_probe/ping

Test-only endpoint with per-route metadata.rateLimit — used to prove rate-limit leakage under OM_INTEGRATION_TEST

Responses

200Always OK when under the points budget

Content-Type: application/json

{
  "ok": true
}

429Rate limit exceeded (3 points / 60 s per client IP)

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/ratelimit_probe/ping" \
  -H "Accept: application/json"

Resources

Showing 20 of 22 endpoints

GET/resources/activities

Auth required

List resourceactivitys

Returns a paginated collection of resourceactivitys scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated resourceactivitys

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/resources/activities?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/resources/activities

Auth required

Create resourceactivity

Adds an activity to a resource timeline.

Request body (application/json)

{
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "entityId": "00000000-0000-4000-8000-000000000000",
  "activityType": "string",
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

201ResourceActivity created

Content-Type: application/json

{
  "id": null,
  "authorUserId": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/resources/activities" \
  -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\",
  \"activityType\": \"string\",
  \"appearanceIcon\": null,
  \"appearanceColor\": null
}"

PUT/resources/activities

Auth required

Update resourceactivity

Updates a resource activity.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

200ResourceActivity updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/resources/activities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\",
  \"appearanceIcon\": null,
  \"appearanceColor\": null
}"

DELETE/resources/activities

Auth required

Delete resourceactivity

Deletes a resource activity.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200ResourceActivity deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/resources/activities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/resources/comments

Auth required

List resourcecomments

Returns a paginated collection of resourcecomments scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated resourcecomments

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/resources/comments?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/resources/comments

Auth required

Create resourcecomment

Adds a note to a resource timeline.

Request body (application/json)

{
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "entityId": "00000000-0000-4000-8000-000000000000",
  "body": "string",
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

201ResourceComment created

Content-Type: application/json

{
  "id": null,
  "authorUserId": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/resources/comments

Auth required

Update resourcecomment

Updates a resource note.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

200ResourceComment updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/resources/comments

Auth required

Delete resourcecomment

Deletes a resource note.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200ResourceComment deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/resources/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/resources/resource-types

Auth required

List resource types

Returns a paginated collection of resource types scoped to the authenticated organization.

Parameters

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	—

Responses

200Paginated resource types

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/resources/resource-types?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/resources/resource-types

Auth required

Create resource type

Creates a resource type for resources resources.

Request body (application/json)

{
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "name": "string",
  "description": null,
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

201Resource type created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/resources/resource-types

Auth required

Update resource type

Updates a resource type by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "description": null,
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

200Resource type updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/resources/resource-types

Auth required

Delete resource type

Deletes a resource type by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Resource type deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/resources/resource-types" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/resources/resources

Auth required

List resources

Returns a paginated collection of resources scoped to the authenticated organization.

Parameters

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	—

Responses

200Paginated resources

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/resources/resources?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/resources/resources

Auth required

Create resource

Creates a resource scoped to the selected organization.

Request body (application/json)

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

Responses

201Resource created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/resources/resources

Auth required

Update resource

Updates a resource by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "description": null,
  "resourceTypeId": null,
  "capacity": null,
  "capacityUnitValue": null,
  "appearanceIcon": null,
  "appearanceColor": null,
  "availabilityRuleSetId": null,
  "customFieldsetCode": null
}

Responses

200Resource updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/resources/resources

Auth required

Delete resource

Deletes a resource by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Resource deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/resources/resources" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

POST/resources/resources/tags/assign

Auth required

Assign resource tag

Assigns a tag to a resources resource.

Request body (application/json)

{
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tagId": "00000000-0000-4000-8000-000000000000",
  "resourceId": "00000000-0000-4000-8000-000000000000"
}

Responses

201Tag assignment created

Content-Type: application/json

{
  "id": null
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

POST/resources/resources/tags/unassign

Auth required

Unassign resource tag

Removes a tag from a resources resource.

Request body (application/json)

{
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tagId": "00000000-0000-4000-8000-000000000000",
  "resourceId": "00000000-0000-4000-8000-000000000000"
}

Responses

200Tag assignment removed

Content-Type: application/json

{
  "id": null
}

400Invalid payload

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

GET/resources/tags

Auth required

List resource tags

Returns a paginated collection of resource tags scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated resource tags

Content-Type: application/json

{
  "items": [
    {
      "id": null,
      "slug": null,
      "label": null,
      "color": null,
      "description": null,
      "organization_id": null,
      "tenant_id": null
    }
  ],
  "total": 1,
  "totalPages": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/resources/tags?page=1&pageSize=100" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/resources/tags

Auth required

Create resource tag

Creates a tag for resources resources and services.

Request body (application/json)

{
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "label": "string",
  "color": null,
  "description": null
}

Responses

201Resource tag created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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

Showing 20 of 110 endpoints

GET/sales/adjustment-kinds

Auth required

List sales adjustment kinds

Returns a paginated collection of sales adjustment kinds that belong to the current organization.

Parameters

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).

Responses

200Paginated sales adjustment kinds

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/sales/adjustment-kinds?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sales/adjustment-kinds

Auth required

Create sales adjustment kind

Creates an adjustment kind.

Request body (application/json)

{}

Responses

201Sales adjustment kind created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/sales/adjustment-kinds" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{}"

PUT/sales/adjustment-kinds

Auth required

Update sales adjustment kind

Updates an adjustment kind.

Request body (application/json)

{}

Responses

200Sales adjustment kind updated

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/sales/adjustment-kinds" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{}"

DELETE/sales/adjustment-kinds

Auth required

Delete sales adjustment kind

Deletes an adjustment kind.

Request body (application/json)

{}

Responses

200Sales adjustment kind deleted

Content-Type: application/json

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/sales/adjustment-kinds" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{}"

GET/sales/channels

Auth required

List sales channels

Manage sales channels to segment orders and pricing across marketplaces or stores.

Parameters

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	—

Responses

200Paginated sales channels

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/sales/channels?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sales/channels

Auth required

Create sales channel

Creates a new sales channel.

Request body (application/json)

{
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "name": "string",
  "code": "string"
}

Responses

201Sales channel created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

PUT/sales/channels

Auth required

Update sales channel

Updates an existing sales channel by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "code": "string"
}

Responses

200Sales channel updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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\"
}"

DELETE/sales/channels

Auth required

Delete sales channel

Deletes a sales channel identified by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Sales channel deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/sales/channels" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/sales/credit-memos

Auth required

List creditmemos

Returns a paginated collection of creditmemos that belong to the current organization.

Parameters

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).

Responses

200Paginated creditmemos

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/sales/credit-memos?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sales/credit-memos

Auth required

Create creditmemo

Create a new credit memo

Request body (application/json)

{
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "currencyCode": "string"
}

Responses

201CreditMemo created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

PUT/sales/credit-memos

Auth required

Update creditmemo

Update a credit memo

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "statusEntryId": null,
  "issueDate": null,
  "reason": null,
  "metadata": null
}

Responses

200CreditMemo updated

Content-Type: application/json

{
  "creditMemoId": "00000000-0000-4000-8000-000000000000"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/sales/credit-memos" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\",
  \"statusEntryId\": null,
  \"issueDate\": null,
  \"reason\": null,
  \"metadata\": null
}"

DELETE/sales/credit-memos

Auth required

Delete creditmemo

Delete a credit memo

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200CreditMemo deleted

Content-Type: application/json

{
  "creditMemoId": "00000000-0000-4000-8000-000000000000"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/sales/credit-memos" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/sales/dashboard/widgets/new-orders

Fetch recently created sales orders

Fetches recently created sales orders for the dashboard widget with a configurable date period.

Parameters

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	—

Responses

200List of recent orders

Content-Type: application/json

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

400Invalid query parameters

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "error": "string"
}

500Widget failed to load

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/sales/dashboard/widgets/new-orders?limit=5&datePeriod=last24h" \
  -H "Accept: application/json"

GET/sales/dashboard/widgets/new-quotes

Fetch recently created sales quotes

Fetches recently created sales quotes for the dashboard widget with a configurable date period.

Parameters

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	—

Responses

200List of recent quotes

Content-Type: application/json

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

400Invalid query parameters

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden

Content-Type: application/json

{
  "error": "string"
}

500Widget failed to load

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/sales/dashboard/widgets/new-quotes?limit=5&datePeriod=last24h" \
  -H "Accept: application/json"

GET/sales/delivery-windows

Auth required

List delivery windows

Define delivery windows to communicate lead times and cut-off rules for sales orders.

Parameters

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).

Responses

200Paginated delivery windows

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/sales/delivery-windows?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sales/delivery-windows

Auth required

Create delivery window

Creates a new delivery window.

Request body (application/json)

{
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "name": "string",
  "code": "string"
}

Responses

201Delivery window created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

PUT/sales/delivery-windows

Auth required

Update delivery window

Updates an existing delivery window by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Delivery window updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/sales/delivery-windows" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

DELETE/sales/delivery-windows

Auth required

Delete delivery window

Deletes a delivery window identified by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Delivery window deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/sales/delivery-windows" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/sales/document-addresses

Auth required

List document addresss

Returns a paginated collection of document addresss that belong to the current organization.

Parameters

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).

Responses

200Paginated document addresss

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/sales/document-addresses?page=1&pageSize=50&documentId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/sales/document-addresses

Auth required

Create document address

Creates a sales document address linked to an order or quote.

Request body (application/json)

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

Responses

201Document address created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

ShippingCarriers

Showing 8 of 8 endpoints

POST/shipping-carriers/cancel

Auth required

Cancel shipment

Responses

200Shipment cancelled

Content-Type: application/json

"string"

422Validation failed or shipment cannot be cancelled in its current status

Content-Type: application/json

"string"

502Provider upstream error

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/shipping-carriers/cancel" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/shipping-carriers/points

Auth required

Search carrier drop-off points (lockers, POP points)

Responses

200Points returned

Content-Type: application/json

"string"

422Validation failed

Content-Type: application/json

"string"

502Provider upstream error or unsupported

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/shipping-carriers/points" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/shipping-carriers/providers

Auth required

List registered shipping providers

Responses

200List of registered provider keys

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/shipping-carriers/providers" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/shipping-carriers/rates

Auth required

Calculate shipping rates

Responses

200Rates calculated

Content-Type: application/json

"string"

422Validation failed

Content-Type: application/json

"string"

502Provider upstream error

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/shipping-carriers/rates" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/shipping-carriers/shipments

Auth required

Create shipment

Responses

201Shipment created

Content-Type: application/json

"string"

409Idempotency conflict: the idempotency key was reused with a different payload

Content-Type: application/json

"string"

422Validation failed

Content-Type: application/json

"string"

502Provider upstream error

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/shipping-carriers/shipments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/shipping-carriers/tracking

Auth required

Get tracking

Responses

200Tracking returned

Content-Type: application/json

"string"

404Shipment not found

Content-Type: application/json

"string"

422Validation failed

Content-Type: application/json

"string"

502Provider upstream error

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/shipping-carriers/tracking" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/shipping-carriers/tracking/refresh

Auth required

Refresh tracking and persist the latest shipment status

Responses

200Tracking refreshed and shipment status persisted

Content-Type: application/json

"string"

422Validation failed

Content-Type: application/json

"string"

502Provider upstream error

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/shipping-carriers/tracking/refresh" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/shipping-carriers/webhook/{provider}

Process inbound carrier webhook

Parameters

Name	In	Required	Schema	Description
provider	path	Yes	any	—

Responses

202Webhook accepted for async processing

Content-Type: application/json

"string"

401Signature verification failed

Content-Type: application/json

"string"

404Unknown provider

Content-Type: application/json

"string"

413Webhook payload too large

Content-Type: application/json

"string"

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/shipping-carriers/webhook/:provider" \
  -H "Accept: application/json"

Staff

Showing 20 of 59 endpoints

GET/staff/activities

Auth required

List teammemberactivitys

Returns a paginated collection of teammemberactivitys scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated teammemberactivitys

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/staff/activities?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/staff/activities

Auth required

Create teammemberactivity

Adds an activity to a team member timeline.

Request body (application/json)

{
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "entityId": "00000000-0000-4000-8000-000000000000",
  "activityType": "string",
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

201TeamMemberActivity created

Content-Type: application/json

{
  "id": null,
  "authorUserId": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/staff/activities" \
  -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\",
  \"activityType\": \"string\",
  \"appearanceIcon\": null,
  \"appearanceColor\": null
}"

PUT/staff/activities

Auth required

Update teammemberactivity

Updates a team member activity.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

200TeamMemberActivity updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/staff/activities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\",
  \"appearanceIcon\": null,
  \"appearanceColor\": null
}"

DELETE/staff/activities

Auth required

Delete teammemberactivity

Deletes a team member activity.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200TeamMemberActivity deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/staff/activities" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/staff/addresses

Auth required

List teammemberaddresss

Returns a paginated collection of teammemberaddresss scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated teammemberaddresss

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/staff/addresses?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/staff/addresses

Auth required

Create teammemberaddress

Adds a team member address.

Request body (application/json)

{
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "entityId": "00000000-0000-4000-8000-000000000000",
  "addressLine1": "string"
}

Responses

201TeamMemberAddress created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

PUT/staff/addresses

Auth required

Update teammemberaddress

Updates a team member address.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200TeamMemberAddress updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/staff/addresses" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

DELETE/staff/addresses

Auth required

Delete teammemberaddress

Deletes a team member address.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200TeamMemberAddress deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/staff/addresses" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/staff/comments

Auth required

List teammembercomments

Returns a paginated collection of teammembercomments scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated teammembercomments

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/staff/comments?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/staff/comments

Auth required

Create teammembercomment

Adds a note to a team member timeline.

Request body (application/json)

{
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "entityId": "00000000-0000-4000-8000-000000000000",
  "body": "string",
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

201TeamMemberComment created

Content-Type: application/json

{
  "id": null,
  "authorUserId": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/staff/comments

Auth required

Update teammembercomment

Updates a team member note.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "appearanceIcon": null,
  "appearanceColor": null
}

Responses

200TeamMemberComment updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/staff/comments

Auth required

Delete teammembercomment

Deletes a team member note.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200TeamMemberComment deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/staff/comments" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/staff/job-histories

Auth required

List teammemberjobhistorys

Returns a paginated collection of teammemberjobhistorys scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated teammemberjobhistorys

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/staff/job-histories?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/staff/job-histories

Auth required

Create teammemberjobhistory

Adds a team member job history entry.

Request body (application/json)

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

Responses

201TeamMemberJobHistory created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/staff/job-histories

Auth required

Update teammemberjobhistory

Updates a team member job history entry.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "companyName": null,
  "description": null,
  "endDate": null
}

Responses

200TeamMemberJobHistory updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/staff/job-histories

Auth required

Delete teammemberjobhistory

Deletes a team member job history entry.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200TeamMemberJobHistory deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/staff/job-histories" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

GET/staff/leave-requests

Auth required

List leave requests

Returns a paginated collection of leave requests scoped to the authenticated organization.

Parameters

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	—

Responses

200Paginated leave requests

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/staff/leave-requests?page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/staff/leave-requests

Auth required

Create leave request

Creates a leave request for a staff member.

Request body (application/json)

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

Responses

201Leave request created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/staff/leave-requests

Auth required

Update leave request

Updates a leave request by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "unavailabilityReasonEntryId": null,
  "unavailabilityReasonValue": null,
  "note": null
}

Responses

200Leave request updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/staff/leave-requests

Auth required

Delete leave request

Deletes a leave request by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Leave request deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/staff/leave-requests" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

Translations

Showing 3 of 3 endpoints

GET/translations/{entityType}/{entityId}

Auth required

Get entity translations

Returns the full translation record for a single entity.

Parameters

Name	In	Required	Schema	Description
entityType	path	Yes	any	—
entityId	path	Yes	any	—

Responses

200Translation record found.

Content-Type: application/json

"string"

401Authentication required

Content-Type: application/json

"string"

404No translations found for this entity

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/translations/string/string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

PUT/translations/{entityType}/{entityId}

Auth required

Create or update entity translations

Full replacement of translations JSONB for an entity.

Parameters

Name	In	Required	Schema	Description
entityType	path	Yes	any	—
entityId	path	Yes	any	—

Responses

200Translations saved.

Content-Type: application/json

"string"

400Validation failed

Content-Type: application/json

"string"

401Authentication required

Content-Type: application/json

"string"

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/api/translations/string/string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

DELETE/translations/{entityType}/{entityId}

Auth required

Delete entity translations

Removes all translations for an entity.

Parameters

Name	In	Required	Schema	Description
entityType	path	Yes	any	—
entityId	path	Yes	any	—

Responses

204Translations deleted.

No response body.

401Authentication required

Content-Type: application/json

"string"

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/translations/string/string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Warranty Claims

Showing 20 of 42 endpoints

GET/warranty_claims

Auth required

List warrantyclaims

Returns a paginated collection of warrantyclaims scoped to the authenticated organization.

Parameters

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	—

Responses

200Paginated warrantyclaims

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims?page=1&pageSize=20" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/warranty_claims

Auth required

Create warrantyclaim

Creates a warranty, return, core-return, or vendor-recovery claim.

Request body (application/json)

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

Responses

201WarrantyClaim created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/warranty_claims

Auth required

Update warrantyclaim

Updates editable claim header fields for the current claim status.

Request body (application/json)

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

Responses

200WarrantyClaim updated

Content-Type: application/json

{
  "ok": true,
  "id": null
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/warranty_claims

Auth required

Delete warrantyclaim

Soft-deletes a draft or cancelled claim.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200WarrantyClaim deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/warranty_claims" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

POST/warranty_claims/ai/assess

Auth required

Assess a damage photo or extract proof-of-purchase facts

Request body (application/json)

{
  "claimId": "00000000-0000-4000-8000-000000000000",
  "attachmentId": "00000000-0000-4000-8000-000000000000",
  "kind": "damage",
  "updatedAt": null
}

Responses

200Assessment completed or AI gracefully degraded

Content-Type: application/json

{
  "status": "ok"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

POST/warranty_claims/ai/draft-reply

Auth required

Generate an AI-assisted customer reply draft for operator review

Request body (application/json)

{
  "claimId": "00000000-0000-4000-8000-000000000000"
}

Responses

200Customer reply draft generated

Content-Type: application/json

{
  "ok": true,
  "draft": "string"
}

422AI drafting is not configured

Content-Type: application/json

{
  "ok": false,
  "notConfigured": true,
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

GET/warranty_claims/ai/suggest

Auth required

Return deterministic triage suggestions for a claim

Parameters

Name	In	Required	Schema	Description
claimId	query	Yes	any	—

Responses

200Triage suggestions

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/ai/suggest?claimId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/warranty_claims/ai/suggest

Auth required

Return deterministic triage suggestions for a claim

Request body (application/json)

{
  "claimId": "00000000-0000-4000-8000-000000000000"
}

Responses

200Triage suggestions

Content-Type: application/json

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

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

POST/warranty_claims/assign

Auth required

Assign or unassign a claim

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "assigneeUserId": null
}

Responses

200Claim assigned

Content-Type: application/json

{
  "ok": true,
  "claimId": "00000000-0000-4000-8000-000000000000"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

GET/warranty_claims/assignees

Auth required

Resolve assignee user ids to display names

Resolves 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.

Parameters

Name	In	Required	Schema	Description
ids	query	Yes	any	—

Responses

200Assignee display names

Content-Type: application/json

{
  "items": [
    {
      "id": "string",
      "name": null
    }
  ]
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/assignees?ids=string" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/warranty_claims/credit-memo

Auth required

Create and link a credit memo from eligible received credit or refund lines

Amounts are prorated from source order-line totals. Version 1 does not prorate order-level adjustments.

Request body (application/json)

{
  "claimId": "00000000-0000-4000-8000-000000000000",
  "updatedAt": null
}

Responses

200Credit memo created and linked; ineligible or unresolvable claim lines are reported as skipped

Content-Type: application/json

{
  "creditMemoId": "00000000-0000-4000-8000-000000000000",
  "skippedLineIds": [
    "00000000-0000-4000-8000-000000000000"
  ],
  "grandTotalGrossAmount": "string",
  "currencyCode": "string"
}

400Invalid request or claim is not eligible for credit-memo creation

Content-Type: application/json

{
  "error": "string"
}

401Authentication required

Content-Type: application/json

{
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "error": "string"
}

409Optimistic lock conflict

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

GET/warranty_claims/entitlement

Auth required

Resolve warranty entitlement for serial, order, product, SKU, or purchase date facts

Parameters

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	—

Responses

200Resolved warranty entitlement

Content-Type: application/json

{
  "warrantyStatus": "in_warranty",
  "coverageType": null,
  "expiresAt": null,
  "source": null
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/entitlement" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/warranty_claims/events

Auth required

List timeline events for a claim

Parameters

Name	In	Required	Schema	Description
claimId	query	Yes	any	—

Responses

200Timeline events

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "claimId": null,
      "kind": "string",
      "visibility": "string",
      "body": null,
      "payload": null,
      "actorUserId": null,
      "actorCustomerId": null,
      "createdAt": null
    }
  ]
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/events?claimId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/warranty_claims/events

Auth required

Append a staff comment to a claim timeline

Request body (application/json)

{
  "claimId": "00000000-0000-4000-8000-000000000000",
  "body": "string",
  "visibility": "internal"
}

Responses

200Comment appended

Content-Type: application/json

{
  "ok": true,
  "claimId": "00000000-0000-4000-8000-000000000000"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

GET/warranty_claims/lines

Auth required

List warrantyclaimlines

Returns a paginated collection of warrantyclaimlines scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated warrantyclaimlines

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/lines?claimId=00000000-0000-4000-8000-000000000000&page=1&pageSize=50" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/warranty_claims/lines

Auth required

Create warrantyclaimline

Creates a line on a warranty claim and recomputes claim totals.

Request body (application/json)

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

Responses

201WarrantyClaimLine created

Content-Type: application/json

{
  "id": null,
  "claimId": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

PUT/warranty_claims/lines

Auth required

Update warrantyclaimline

Updates a warranty claim line and recomputes claim totals.

Request body (application/json)

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

Responses

200WarrantyClaimLine updated

Content-Type: application/json

{
  "ok": true,
  "id": null,
  "claimId": null
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/warranty_claims/lines

Auth required

Delete warrantyclaimline

Soft-deletes a warranty claim line and recomputes claim totals.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200WarrantyClaimLine deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/warranty_claims/lines" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

POST/warranty_claims/receiving

Auth required

Grade a received line or release its quarantine hold

Request body (application/json)

{
  "lineId": "00000000-0000-4000-8000-000000000000",
  "action": "release",
  "updatedAt": null
}

Responses

200Receiving action applied

Content-Type: application/json

{
  "ok": true,
  "lineId": "00000000-0000-4000-8000-000000000000",
  "claimId": "00000000-0000-4000-8000-000000000000"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
}"

GET/warranty_claims/registrations

Auth required

List warrantyregistrations

Returns a paginated collection of warrantyregistrations scoped to the authenticated organization.

Parameters

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).

Responses

200Paginated warrantyregistrations

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/registrations?page=1&pageSize=20" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

Warranty Claims External

Showing 2 of 2 endpoints

GET/warranty_claims/external/claims

Auth required

Get an external claim status by id, claim number, or external reference

Parameters

Name	In	Required	Schema	Description
id	query	No	any	—
claimNumber	query	No	any	—
externalRef	query	No	any	—

Responses

200External claim status

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/external/claims" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/warranty_claims/external/claims

Auth required

Submit an external warranty claim intake

Request body (application/json)

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

Responses

200Existing idempotent claim

Content-Type: application/json

{
  "ok": true,
  "id": "00000000-0000-4000-8000-000000000000",
  "claimNumber": "string",
  "status": "string",
  "externalRef": null,
  "lines": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "warrantyStatus": null
    }
  ]
}

201Claim created and submitted

Content-Type: application/json

{
  "ok": true,
  "id": "00000000-0000-4000-8000-000000000000",
  "claimNumber": "string",
  "status": "string",
  "externalRef": null,
  "lines": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "warrantyStatus": null
    }
  ]
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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

Showing 15 of 15 endpoints

GET/warranty_claims/portal/attachments

List attachments for an owned claim

Parameters

Name	In	Required	Schema	Description
claimId	query	Yes	any	—
page	query	No	any	—
pageSize	query	No	any	—

Responses

200Claim attachments

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/portal/attachments?claimId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json"

POST/warranty_claims/portal/attachments

Upload an attachment for an owned claim

Request body (multipart/form-data)

claimId=00000000-0000-4000-8000-000000000000
file=string

Responses

200Attachment uploaded

Content-Type: application/json

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

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/warranty_claims/portal/attachments" \
  -H "Accept: application/json" \
  -H "Content-Type: multipart/form-data" \
  -d "{
  \"claimId\": \"00000000-0000-4000-8000-000000000000\",
  \"file\": \"string\"
}"

PUT/warranty_claims/portal/attachments

Replace an attachment on an owned claim

Request body (multipart/form-data)

claimId=00000000-0000-4000-8000-000000000000
file=string
attachmentId=00000000-0000-4000-8000-000000000000

Responses

200Attachment replaced

Content-Type: application/json

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

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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\"
}"

DELETE/warranty_claims/portal/attachments

Delete an attachment from an owned claim

Parameters

Name	In	Required	Schema	Description
attachmentId	query	Yes	any	—

Responses

200Attachment deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/warranty_claims/portal/attachments?attachmentId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json"

GET/warranty_claims/portal/claims

List the authenticated customer account claims

Parameters

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	—

Responses

200Customer claims

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/portal/claims?page=1&pageSize=20" \
  -H "Accept: application/json"

POST/warranty_claims/portal/claims

Submit a customer portal claim intake

Request body (application/json)

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

Responses

201Claim created and submitted

Content-Type: application/json

{
  "ok": true,
  "claimId": "00000000-0000-4000-8000-000000000000"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
    }
  ]
}"

GET/warranty_claims/portal/claims/{id}

Read one authenticated customer claim

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Customer claim detail

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/portal/claims/:id" \
  -H "Accept: application/json"

POST/warranty_claims/portal/claims/{id}/submit

Submit an owned draft claim from the customer portal

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Claim submitted

Content-Type: application/json

{
  "ok": true,
  "claimId": "00000000-0000-4000-8000-000000000000",
  "status": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/warranty_claims/portal/claims/:id/submit" \
  -H "Accept: application/json"

POST/warranty_claims/portal/claims/{id}/withdraw

Withdraw (cancel) an owned claim while it is draft or submitted

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Claim withdrawn

Content-Type: application/json

{
  "ok": true,
  "claimId": "00000000-0000-4000-8000-000000000000",
  "status": "cancelled"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/warranty_claims/portal/claims/:id/withdraw" \
  -H "Accept: application/json"

GET/warranty_claims/portal/events

List customer-visible timeline events for an owned claim

Parameters

Name	In	Required	Schema	Description
claimId	query	Yes	any	—

Responses

200Customer-visible timeline events

Content-Type: application/json

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "claimId": null,
      "kind": "string",
      "visibility": "customer",
      "body": null,
      "payload": null,
      "actorCustomerId": null,
      "createdAt": null
    }
  ]
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/portal/events?claimId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json"

POST/warranty_claims/portal/events

Append a customer-visible customer comment

Request body (application/json)

{
  "claimId": "00000000-0000-4000-8000-000000000000",
  "body": "string"
}

Responses

200Comment appended

Content-Type: application/json

{
  "ok": true,
  "claimId": "00000000-0000-4000-8000-000000000000"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/warranty_claims/portal/events" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"claimId\": \"00000000-0000-4000-8000-000000000000\",
  \"body\": \"string\"
}"

GET/warranty_claims/portal/options

List active customer portal warranty claim options

Responses

200Portal warranty claim options

Content-Type: application/json

{
  "ok": true,
  "result": {
    "reasons": [
      {
        "value": "string",
        "label": "string"
      }
    ],
    "faultCodes": [
      {
        "value": "string",
        "label": "string"
      }
    ]
  }
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/portal/options" \
  -H "Accept: application/json"

GET/warranty_claims/portal/orders

List authenticated customer orders for portal claim intake

Parameters

Name	In	Required	Schema	Description
search	query	No	any	—
page	query	No	any	—

Responses

200Customer-owned sales orders

Content-Type: application/json

{
  "ok": true,
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "orderNumber": "string",
      "placedAt": null,
      "currencyCode": null,
      "grandTotalGrossAmount": null
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/portal/orders?page=1" \
  -H "Accept: application/json"

GET/warranty_claims/portal/orders/lines

List product lines for an authenticated customer-owned order

Parameters

Name	In	Required	Schema	Description
orderId	query	Yes	any	—

Responses

200Customer-owned sales order product lines

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/portal/orders/lines?orderId=00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json"

GET/warranty_claims/portal/troubleshooting

Load the best matching guided troubleshooting tree for portal claim intake

Parameters

Name	In	Required	Schema	Description
claimType	query	No	any	—
reasonCode	query	No	any	—

Responses

200Matching troubleshooting guide, if configured

Content-Type: application/json

{
  "guide": null
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/warranty_claims/portal/troubleshooting" \
  -H "Accept: application/json"

WMS

Showing 20 of 41 endpoints

GET/wms/dashboard/operational

Auth required

Load operational dashboard data

Aggregated KPIs, expiry watch lot rows (`expiryLots`), monthly movement trends, and recent activity for the WMS operational dashboard.

Parameters

Name	In	Required	Schema	Description
warehouseId	query	No	any	—

Responses

200Dashboard payload

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

"string"

404Warehouse not found

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/wms/dashboard/operational" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

GET/wms/inventory-profiles

Auth required

List inventory profiles

Returns a paginated collection of inventory profiles scoped to the authenticated organization.

Parameters

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	—

Responses

200Paginated inventory profiles

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/wms/inventory-profiles?page=1&pageSize=25" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/wms/inventory-profiles

Auth required

Create inventory profile

Creates a product inventory profile.

Request body (application/json)

{
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "catalogProductId": "00000000-0000-4000-8000-000000000000",
  "catalogVariantId": null,
  "defaultUom": "string",
  "defaultStrategy": "fifo"
}

Responses

201Inventory profile created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

PUT/wms/inventory-profiles

Auth required

Update inventory profile

Updates an inventory profile by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000",
  "catalogVariantId": null
}

Responses

200Inventory profile updated

Content-Type: application/json

{
  "ok": true
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/wms/inventory-profiles

Auth required

Delete inventory profile

Soft-deletes an inventory profile by id.

Request body (application/json)

{
  "id": "00000000-0000-4000-8000-000000000000"
}

Responses

200Inventory profile deleted

Content-Type: application/json

{
  "ok": true
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/wms/inventory-profiles" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{
  \"id\": \"00000000-0000-4000-8000-000000000000\"
}"

POST/wms/inventory/adjust

Auth required

Adjust inventory

Applies a manual inventory adjustment and appends a movement ledger row.

Request body (application/json)

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

Responses

200Inventory adjusted

Content-Type: application/json

{
  "ok": true,
  "movementId": "00000000-0000-4000-8000-000000000000"
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

409Insufficient stock

Content-Type: application/json

{
  "error": "string"
}

422Invalid location

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

POST/wms/inventory/allocate

Auth required

Allocate reservation

Converts a reservation from reserved quantity into allocated quantity on the selected stock buckets.

Request body (application/json)

{
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "reservationId": "00000000-0000-4000-8000-000000000000"
}

Responses

200Reservation allocated

Content-Type: application/json

{
  "ok": true,
  "allocationState": "allocated"
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Reservation not found

Content-Type: application/json

{
  "error": "string"
}

409Invalid reservation state

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

GET/wms/inventory/balances

Auth required

List inventory balances

Returns paginated inventory balance buckets for the authenticated organization.

Parameters

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	—

Responses

200Inventory balances collection

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/wms/inventory/balances?page=1&pageSize=25" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/wms/inventory/cycle-count

Auth required

Cycle count reconcile

Reconciles a counted quantity against the current on-hand balance and appends a cycle-count movement when a delta exists.

Request body (application/json)

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

Responses

200Cycle count reconciled

Content-Type: application/json

{
  "ok": true,
  "adjustmentDelta": "string",
  "movementId": null
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

422Invalid location

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

POST/wms/inventory/import/apply

Auth required

Apply inventory CSV import

Applies validated inventory import rows via wms.inventory.adjust commands (idempotent skip when delta is zero).

Request body (application/json)

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

Responses

200Import applied

Content-Type: application/json

{
  "ok": true,
  "importBatchId": "00000000-0000-4000-8000-000000000000",
  "summary": {
    "applied": 1,
    "skipped": 1,
    "failed": 1
  }
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

409Partial apply failure

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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
    }
  ]
}"

GET/wms/inventory/import/template

Auth required

Download inventory import CSV template

Returns 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.

Responses

200CSV template file

Content-Type: application/json

"string"

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/wms/inventory/import/template" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/wms/inventory/import/validate

Auth required

Validate inventory CSV import

Dry-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.

Request body (application/json)

{
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "mode": "additive",
  "rows": [
    {}
  ]
}

Responses

200Validation report

Content-Type: application/json

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

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\": [
    {}
  ]
}"

POST/wms/inventory/move

Auth required

Move inventory

Moves stock from one location to another within a warehouse and appends a transfer movement.

Request body (application/json)

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

Responses

200Inventory moved

Content-Type: application/json

{
  "ok": true,
  "movementId": "00000000-0000-4000-8000-000000000000"
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

409Insufficient stock

Content-Type: application/json

{
  "error": "string"
}

422Invalid location

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

GET/wms/inventory/movements

Auth required

List inventory movements

Returns paginated inventory ledger entries for the authenticated organization.

Parameters

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	—

Responses

200Inventory movements collection

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/wms/inventory/movements?page=1&pageSize=25" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/wms/inventory/receive

Auth required

Receive inventory

Records inbound inventory receipt and appends a receipt movement ledger row.

Request body (application/json)

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

Responses

200Inventory received

Content-Type: application/json

{
  "ok": true,
  "movementId": "00000000-0000-4000-8000-000000000000"
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

422Invalid location

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

POST/wms/inventory/release

Auth required

Release reservation

Releases a previously reserved or allocated inventory reservation.

Request body (application/json)

{
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "reservationId": "00000000-0000-4000-8000-000000000000",
  "reason": "string"
}

Responses

200Reservation released

Content-Type: application/json

{
  "ok": true
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Reservation not found

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

GET/wms/inventory/reservations

Auth required

List inventory reservations

Returns paginated inventory reservations for the authenticated organization.

Parameters

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	—

Responses

200Inventory reservations collection

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/wms/inventory/reservations?page=1&pageSize=25" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/wms/inventory/reserve

Auth required

Reserve inventory

Creates an inventory reservation and assigns available buckets using the configured stock strategy.

Request body (application/json)

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

Responses

200Inventory reserved

Content-Type: application/json

{
  "ok": true,
  "reservationId": "00000000-0000-4000-8000-000000000000",
  "allocatedBuckets": [
    {
      "locationId": "00000000-0000-4000-8000-000000000000",
      "lotId": null,
      "quantity": "string"
    }
  ]
}

400Validation failed

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

409Insufficient stock

Content-Type: application/json

{
  "error": "string"
}

422Invalid tracking state

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\"
}"

GET/wms/locations

Auth required

List warehouse locations

Returns a paginated collection of warehouse locations scoped to the authenticated organization.

Parameters

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	—

Responses

200Paginated warehouse locations

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/wms/locations?page=1&pageSize=25" \
  -H "Accept: application/json" \
  -H "authorization: Bearer <token>"

POST/wms/locations

Auth required

Create warehouse location

Creates a storage location within a warehouse hierarchy.

Request body (application/json)

{
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "warehouseId": "00000000-0000-4000-8000-000000000000",
  "code": "string",
  "type": "zone",
  "parentId": null
}

Responses

201Warehouse location created

Content-Type: application/json

{
  "id": null
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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

Showing 20 of 23 endpoints

GET/workflows/definitions

List workflow definitions

Get a list of workflow definitions with optional filters. Supports pagination and search.

Parameters

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	—

Responses

200List of workflow definitions with pagination

Content-Type: application/json

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

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/workflows/definitions?workflowId=string&limit=50&offset=0" \
  -H "Accept: application/json"

POST/workflows/definitions

Create workflow definition

Create a new workflow definition. The definition must include at least START and END steps with at least one transition connecting them.

Request body (application/json)

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

Responses

201Workflow definition created successfully

Content-Type: application/json

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

400Validation error - invalid workflow structure

Content-Type: application/json

{
  "error": "Validation failed",
  "details": [
    {
      "code": "invalid_type",
      "message": "Workflow must have at least START and END steps",
      "path": [
        "definition",
        "steps"
      ]
    }
  ]
}

409Conflict - workflow with same ID and version already exists

Content-Type: application/json

{
  "error": "Workflow definition with ID \"checkout-flow\" and version 1 already exists"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/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\",
        \"continueOnActivityFailure\": false,
        \"priority\": 0
      }
    ]
  },
  \"metadata\": null,
  \"enabled\": true
}"

GET/workflows/definitions/{id}

Get workflow definition

Get a single workflow definition by ID. Returns the complete workflow structure including steps and transitions (with embedded activities).

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	UUID for DB definitions, or "code:<workflowId>" for code-based definitions

Responses

200Workflow definition found

Content-Type: application/json

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

404Workflow definition not found

Content-Type: application/json

{
  "error": "Workflow definition not found"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/workflows/definitions/string" \
  -H "Accept: application/json"

PUT/workflows/definitions/{id}

Update workflow definition

Update an existing workflow definition. Supports partial updates - only provided fields will be updated.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

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

Responses

200Workflow definition updated successfully

Content-Type: application/json

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

400Validation error

Content-Type: application/json

{
  "error": "Validation failed",
  "details": [
    {
      "code": "invalid_type",
      "message": "Expected object, received string",
      "path": [
        "definition"
      ]
    }
  ]
}

404Workflow definition not found

Content-Type: application/json

{
  "error": "Workflow definition not found"
}

Example

curl -X PUT "https://fixture.omnibus.buscrazy.net/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
}"

DELETE/workflows/definitions/{id}

Delete workflow definition

Soft delete a workflow definition. Cannot be deleted if there are active workflow instances (RUNNING or WAITING status) using this definition.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Workflow definition deleted successfully

Content-Type: application/json

{
  "message": "Workflow definition deleted successfully"
}

404Workflow definition not found

Content-Type: application/json

{
  "error": "Workflow definition not found"
}

409Cannot delete - active workflow instances exist

Content-Type: application/json

{
  "error": "Cannot delete workflow definition with 3 active instance(s)"
}

Example

curl -X DELETE "https://fixture.omnibus.buscrazy.net/api/workflows/definitions/00000000-0000-4000-8000-000000000000" \
  -H "Accept: application/json"

POST/workflows/definitions/{id}/customize

Customize code-based workflow definition

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

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	Must be of the form "code:<workflowId>"

Responses

200Workflow definition customized successfully

Content-Type: application/json

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "workflowId": "workflows.simple-approval",
    "workflowName": "Simple Approval Workflow",
    "source": "code_override"
  },
  "message": "Workflow definition customized successfully"
}

400Not a code-based id

Content-Type: application/json

{
  "error": "Customize is only supported for code-based workflow definitions"
}

404Code workflow not found

Content-Type: application/json

{
  "error": "Workflow definition not found"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/workflows/definitions/string/customize" \
  -H "Accept: application/json"

POST/workflows/definitions/{id}/reset-to-code

Reset workflow definition to code version

Deletes 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.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Workflow definition reset to code version

Content-Type: application/json

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

400Definition is not a code-based override

Content-Type: application/json

{
  "error": "This workflow definition is not a code-based override and cannot be reset"
}

404Workflow definition not found

Content-Type: application/json

{
  "error": "Workflow definition not found"
}

409Cannot reset - active workflow instances exist

Content-Type: application/json

{
  "error": "Cannot reset workflow definition with 3 active instance(s)"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/workflows/definitions/00000000-0000-4000-8000-000000000000/reset-to-code" \
  -H "Accept: application/json"

GET/workflows/events

List all workflow events

Get a paginated list of all workflow events with filtering options

Parameters

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	—

Responses

200List of workflow events

Content-Type: application/json

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

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/workflows/events?page=1&pageSize=50&sortField=occurredAt&sortDir=desc" \
  -H "Accept: application/json"

GET/workflows/events/{id}

Get workflow event by ID

Get detailed information about a specific workflow event

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Workflow event details

Content-Type: application/json

{
  "id": "string",
  "workflowInstanceId": "00000000-0000-4000-8000-000000000000",
  "stepInstanceId": null,
  "eventType": "string",
  "occurredAt": "string",
  "userId": null,
  "tenantId": "00000000-0000-4000-8000-000000000000",
  "organizationId": "00000000-0000-4000-8000-000000000000",
  "workflowInstance": null
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "error": "string"
}

404Workflow event not found

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/workflows/events/:id" \
  -H "Accept: application/json"

GET/workflows/instances

List workflow instances

Get a list of workflow instances with optional filters. Supports pagination and filtering by status, workflowId, correlationKey, etc.

Parameters

Name	In	Required	Schema	Description
workflowId	query	No	any	—
status	query	No	any	—
correlationKey	query	No	any	—
entityType	query	No	any	—
entityId	query	No	any	—
limit	query	No	any	—
offset	query	No	any	—

Responses

200List of workflow instances

Content-Type: application/json

{
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "definitionId": "00000000-0000-4000-8000-000000000000",
      "workflowId": "string",
      "version": 1,
      "status": "RUNNING",
      "currentStepId": "string",
      "correlationKey": null,
      "metadata": null,
      "startedAt": "string",
      "completedAt": null,
      "pausedAt": null,
      "cancelledAt": null,
      "errorMessage": null,
      "errorDetails": null,
      "pendingTransition": null,
      "retryCount": 1,
      "tenantId": "00000000-0000-4000-8000-000000000000",
      "organizationId": "00000000-0000-4000-8000-000000000000",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": null
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1,
    "hasMore": true
  }
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/workflows/instances?limit=50&offset=0" \
  -H "Accept: application/json"

POST/workflows/instances

Start workflow instance

Start a new workflow instance from a workflow definition. The workflow will execute immediately.

Request body (application/json)

{
  "workflowId": "string"
}

Responses

201Workflow started successfully

Content-Type: application/json

{
  "data": {
    "instance": {
      "id": "00000000-0000-4000-8000-000000000000",
      "definitionId": "00000000-0000-4000-8000-000000000000",
      "workflowId": "string",
      "version": 1,
      "status": "RUNNING",
      "currentStepId": "string",
      "correlationKey": null,
      "metadata": null,
      "startedAt": "string",
      "completedAt": null,
      "pausedAt": null,
      "cancelledAt": null,
      "errorMessage": null,
      "errorDetails": null,
      "pendingTransition": null,
      "retryCount": 1,
      "tenantId": "00000000-0000-4000-8000-000000000000",
      "organizationId": "00000000-0000-4000-8000-000000000000",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": null
    },
    "execution": {
      "status": "RUNNING",
      "currentStep": "string",
      "message": "string"
    }
  },
  "message": "string"
}

400Bad request - Validation failed or definition disabled/invalid

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden - Insufficient permissions

Content-Type: application/json

{
  "error": "string"
}

404Workflow definition not found

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/workflows/instances" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"workflowId\": \"string\"
}"

GET/workflows/instances/{id}

Get workflow instance

Get detailed information about a specific workflow instance including current state, context, and execution status.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Workflow instance details

Content-Type: application/json

{
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "definitionId": "00000000-0000-4000-8000-000000000000",
    "workflowId": "string",
    "version": 1,
    "status": "RUNNING",
    "currentStepId": "string",
    "correlationKey": null,
    "metadata": null,
    "startedAt": "string",
    "completedAt": null,
    "pausedAt": null,
    "cancelledAt": null,
    "errorMessage": null,
    "errorDetails": null,
    "pendingTransition": null,
    "retryCount": 1,
    "tenantId": "00000000-0000-4000-8000-000000000000",
    "organizationId": "00000000-0000-4000-8000-000000000000",
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": null
  }
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Workflow instance not found

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/workflows/instances/:id" \
  -H "Accept: application/json"

POST/workflows/instances/{id}/advance

Manually advance workflow to next step

Manually advance a workflow instance to the next step. Useful for manual progression, step-by-step testing, user-triggered transitions, and approval flows. Validates transitions and auto-progresses if possible.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{}

Responses

200Workflow advanced successfully

Content-Type: application/json

{
  "data": {
    "instance": {
      "id": "00000000-0000-4000-8000-000000000000",
      "status": "string",
      "currentStepId": null,
      "previousStepId": null,
      "transitionFired": null
    }
  },
  "message": "string"
}

400Invalid request, no valid transitions, or workflow already completed/cancelled/failed

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "error": "string"
}

404Workflow instance not found

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/workflows/instances/:id/advance" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{}"

POST/workflows/instances/{id}/cancel

Cancel workflow instance

Cancel a running or paused workflow instance. The workflow will be marked as CANCELLED and will not execute further.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Workflow cancelled successfully

Content-Type: application/json

{
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "definitionId": "00000000-0000-4000-8000-000000000000",
    "workflowId": "string",
    "version": 1,
    "status": "RUNNING",
    "currentStepId": "string",
    "correlationKey": null,
    "metadata": null,
    "startedAt": "string",
    "completedAt": null,
    "pausedAt": null,
    "cancelledAt": null,
    "errorMessage": null,
    "errorDetails": null,
    "pendingTransition": null,
    "retryCount": 1,
    "tenantId": "00000000-0000-4000-8000-000000000000",
    "organizationId": "00000000-0000-4000-8000-000000000000",
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": null
  },
  "message": "string"
}

400Bad request - Workflow cannot be cancelled in current status

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden - Insufficient permissions

Content-Type: application/json

{
  "error": "string"
}

404Workflow instance not found

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/workflows/instances/:id/cancel" \
  -H "Accept: application/json"

GET/workflows/instances/{id}/events

Get workflow instance events

Get a chronological list of events for a workflow instance. Events track all state changes, transitions, and activities.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—
eventType	query	No	any	—
limit	query	No	any	—
offset	query	No	any	—

Responses

200List of workflow events

Content-Type: application/json

{
  "data": [
    {
      "id": "string",
      "workflowInstanceId": "00000000-0000-4000-8000-000000000000",
      "stepInstanceId": null,
      "eventType": "string",
      "occurredAt": "string",
      "userId": null,
      "tenantId": "00000000-0000-4000-8000-000000000000",
      "organizationId": "00000000-0000-4000-8000-000000000000"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1,
    "hasMore": true
  }
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

404Workflow instance not found

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/workflows/instances/:id/events?limit=100&offset=0" \
  -H "Accept: application/json"

POST/workflows/instances/{id}/retry

Retry failed workflow instance

Retry a failed workflow instance from its current step. The workflow will be reset to RUNNING status and execution will continue.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Responses

200Workflow retry initiated successfully

Content-Type: application/json

{
  "data": {
    "instance": {
      "id": "00000000-0000-4000-8000-000000000000",
      "definitionId": "00000000-0000-4000-8000-000000000000",
      "workflowId": "string",
      "version": 1,
      "status": "RUNNING",
      "currentStepId": "string",
      "correlationKey": null,
      "metadata": null,
      "startedAt": "string",
      "completedAt": null,
      "pausedAt": null,
      "cancelledAt": null,
      "errorMessage": null,
      "errorDetails": null,
      "pendingTransition": null,
      "retryCount": 1,
      "tenantId": "00000000-0000-4000-8000-000000000000",
      "organizationId": "00000000-0000-4000-8000-000000000000",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": null
    },
    "execution": {
      "status": "RUNNING",
      "currentStep": "string",
      "events": [
        {
          "eventType": "string",
          "occurredAt": "string"
        }
      ],
      "executionTime": 1
    }
  },
  "message": "string"
}

400Bad request - Workflow cannot be retried in current status or execution error

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Forbidden - Insufficient permissions

Content-Type: application/json

{
  "error": "string"
}

404Workflow instance not found

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/workflows/instances/:id/retry" \
  -H "Accept: application/json"

POST/workflows/instances/{id}/signal

Send signal to specific workflow

Sends a signal to a specific workflow instance waiting for a signal. The workflow must be in PAUSED status and waiting for the specified signal.

Parameters

Name	In	Required	Schema	Description
id	path	Yes	any	—

Request body (application/json)

{
  "signalName": "string"
}

Responses

200Signal sent successfully

Content-Type: application/json

{
  "success": true,
  "message": "string"
}

400Invalid request body or signal name mismatch

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "error": "string"
}

404Instance or definition not found

Content-Type: application/json

{
  "error": "string"
}

409Workflow not paused or not waiting for signal

Content-Type: application/json

{
  "error": "string"
}

500Internal server error or transition failed

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/workflows/instances/:id/signal" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"signalName\": \"string\"
}"

POST/workflows/instances/validate-start

Validate if workflow can be started

Evaluates pre-conditions defined on the START step and returns validation errors with localized messages if any fail. Returns canStart: true/false with details.

Request body (application/json)

{
  "workflowId": "string"
}

Responses

200Validation result (canStart, errors, validatedRules)

Content-Type: application/json

{
  "canStart": true,
  "workflowId": "string"
}

400Invalid request body or missing context

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/workflows/instances/validate-start" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"workflowId\": \"string\"
}"

POST/workflows/signals

Send signal to workflows by correlation key

Sends a signal to all workflow instances waiting for the specified signal that match the correlation key. Returns the count of workflows that received the signal.

Request body (application/json)

{
  "correlationKey": "string",
  "signalName": "string"
}

Responses

200Signal sent to matching workflows

Content-Type: application/json

{
  "success": true,
  "message": "string",
  "count": 1
}

400Missing tenant or organization context

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

403Insufficient permissions

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X POST "https://fixture.omnibus.buscrazy.net/api/workflows/signals" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{
  \"correlationKey\": \"string\",
  \"signalName\": \"string\"
}"

GET/workflows/tasks

List user tasks

Returns paginated list of user tasks with optional filtering by status, assignee, workflow instance, overdue, and myTasks flags.

Parameters

Name	In	Required	Schema	Description
status	query	No	any	Filter by status (comma-separated for multiple: PENDING,IN_PROGRESS,COMPLETED,CANCELLED,ESCALATED)
assignedTo	query	No	any	Filter by assigned user ID
workflowInstanceId	query	No	any	Filter by workflow instance ID
overdue	query	No	any	Filter overdue tasks (true/false)
myTasks	query	No	any	Show only tasks assigned to or claimable by current user
limit	query	No	any	Number of results (max 100)
offset	query	No	any	Pagination offset

Responses

200User tasks list with pagination

Content-Type: application/json

{
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "workflowInstanceId": "00000000-0000-4000-8000-000000000000",
      "stepInstanceId": "00000000-0000-4000-8000-000000000000",
      "taskName": "string",
      "description": null,
      "status": "PENDING",
      "formSchema": null,
      "formData": null,
      "assignedTo": null,
      "assignedToRoles": null,
      "claimedBy": null,
      "claimedAt": null,
      "dueDate": null,
      "escalatedAt": null,
      "escalatedTo": null,
      "completedBy": null,
      "completedAt": null,
      "tenantId": "00000000-0000-4000-8000-000000000000",
      "organizationId": "00000000-0000-4000-8000-000000000000",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1,
    "hasMore": true
  }
}

400Invalid query parameters or missing tenant context

Content-Type: application/json

{
  "error": "string"
}

401Unauthorized

Content-Type: application/json

{
  "error": "string"
}

500Internal server error

Content-Type: application/json

{
  "error": "string"
}

Example

curl -X GET "https://fixture.omnibus.buscrazy.net/api/workflows/tasks?limit=50&offset=0" \
  -H "Accept: application/json"