All API Endpoints
Complete endpoint inventory for the Opbox API.
Summary
| Stat | Value |
|---|---|
| Method + Path | 683 |
| Route Groups | 62 |
| HTTP Methods | 5 |
Accounting
| Method | Endpoint |
|---|---|
GET | /api/accounting/stats |
Addons
| Method | Endpoint |
|---|---|
GET | /api/addons |
POST | /api/addons |
GET | /api/addons/:key |
PATCH | /api/addons/:key |
DELETE | /api/addons/:key |
Admin
| Method | Endpoint |
|---|---|
POST | /api/admin/audit-export |
GET | /api/admin/billing |
GET | /api/admin/billing/:orgId |
POST | /api/admin/billing/:orgId/line-items |
DELETE | /api/admin/billing/:orgId/line-items/:itemId |
POST | /api/admin/billing/:orgId/subscription |
POST | /api/admin/billing/:orgId/subscription/sync |
GET | /api/admin/invites/options |
GET | /api/admin/rag |
POST | /api/admin/rag |
GET | /api/admin/security-events |
Agent Tasks
| Method | Endpoint |
|---|---|
POST | /api/agent-tasks/:taskId/claim |
PATCH | /api/agent-tasks/:taskId/complete |
PATCH | /api/agent-tasks/:taskId/progress |
POST | /api/agent-tasks/:taskId/retry |
Ai
| Method | Endpoint |
|---|---|
POST | /api/ai/chat |
GET | /api/ai/chats |
POST | /api/ai/chats |
GET | /api/ai/chats/:id |
PATCH | /api/ai/chats/:id |
POST | /api/ai/chats/:id/generate-title |
GET | /api/ai/chats/:id/messages |
POST | /api/ai/chats/:id/messages |
POST | /api/ai/passport-ocr |
GET | /api/ai/skills |
POST | /api/ai/skills |
POST | /api/ai/skills/:id |
DELETE | /api/ai/skills/:id |
POST | /api/ai/transcribe |
GET | /api/ai/transcripts |
GET | /api/ai/transcripts/:id |
DELETE | /api/ai/transcripts/:id |
Api Keys
| Method | Endpoint |
|---|---|
GET | /api/api-keys |
POST | /api/api-keys |
DELETE | /api/api-keys |
Audit
| Method | Endpoint |
|---|---|
GET | /api/audit/resource |
Auth
| Method | Endpoint |
|---|---|
POST | /api/auth/forgot-password |
POST | /api/auth/register |
POST | /api/auth/reset-password |
POST | /api/auth/signup |
GET | /api/auth/sso/callback |
POST | /api/auth/sso/lookup |
POST | /api/auth/sso/start |
GET | /api/auth/two-factor/status |
GET | /api/auth/validate-invite |
Billing
| Method | Endpoint |
|---|---|
GET | /api/billing/access |
GET | /api/billing/invoices |
GET | /api/billing/line-items |
POST | /api/billing/portal |
GET | /api/billing/subscription |
POST | /api/billing/webhooks |
C
| Method | Endpoint |
|---|---|
GET | /api/c/:token |
GET | /api/c/:token/portal/dashboard |
GET | /api/c/:token/portal/documents |
GET | /api/c/:token/portal/matters |
GET | /api/c/:token/portal/matters/:matterId |
GET | /api/c/:token/portal/matters/:matterId/signing/:envelopeId/download |
POST | /api/c/:token/portal/matters/:matterId/signing/sessions/:sessionId/access |
POST | /api/c/:token/portal/matters/:matterId/submit |
PATCH | /api/c/:token/save |
POST | /api/c/:token/submit |
GET | /api/c/matter/:token |
POST | /api/c/matter/:token/submit |
Change Requests
| Method | Endpoint |
|---|---|
GET | /api/change-requests |
GET | /api/change-requests/:id |
DELETE | /api/change-requests/:id |
Consent
| Method | Endpoint |
|---|---|
GET | /api/consent |
POST | /api/consent |
PATCH | /api/consent/:id |
DELETE | /api/consent/:id |
GET | /api/consent/check |
Cron
| Method | Endpoint |
|---|---|
GET | /api/cron/compliance-degradation |
GET | /api/cron/cross-workspace-tasks |
GET | /api/cron/data-retention |
GET | /api/cron/esop-vesting |
GET | /api/cron/extraction-snapshot-cleanup |
POST | /api/cron/hubspot-sync |
GET | /api/cron/identity-reconciliation |
GET | /api/cron/keepalive |
GET | /api/cron/presence-reconciliation |
GET | /api/cron/purge-archived-documents |
GET | /api/cron/retry-background-jobs |
GET | /api/cron/sign-anchor-rollup |
GET | /api/cron/sign-reminders |
GET | /api/cron/trigger-schedule |
GET | /api/cron/verify-audit-chains |
GET | /api/cron/workflows |
Cross Workspace Tasks
| Method | Endpoint |
|---|---|
GET | /api/cross-workspace-tasks |
GET | /api/cross-workspace-tasks/:id |
POST | /api/cross-workspace-tasks/:id/action |
Csp
| Method | Endpoint |
|---|---|
GET | /api/csp/compliance/calendar |
GET | /api/csp/compliance/kyc-expiry |
GET | /api/csp/compliance/obligations |
POST | /api/csp/compliance/obligations |
PATCH | /api/csp/compliance/obligations/:id |
GET | /api/csp/compliance/summary/:entityId |
POST | /api/csp/documents/generate |
GET | /api/csp/entities/:entityId/document-coverage |
GET | /api/csp/entities/:entityId/files |
GET | /api/csp/entities/workbench-rows |
GET | /api/csp/entities/workbench-tree |
GET | /api/csp/events |
GET | /api/csp/graph/circular |
GET | /api/csp/graph/conflicts/:matterId |
GET | /api/csp/graph/family-tree/:entityId |
GET | /api/csp/graph/ownership/:entityId |
GET | /api/csp/individuals/:individualId/files |
GET | /api/csp/kyc-documents |
POST | /api/csp/kyc-documents |
GET | /api/csp/kyc-documents/:id |
PATCH | /api/csp/kyc-documents/:id |
DELETE | /api/csp/kyc-documents/:id |
GET | /api/csp/presence/:globalIdentityId |
GET | /api/csp/presence/unified/:globalIdentityId |
GET | /api/csp/registers/:entityId |
POST | /api/csp/registers/:entityId/entries |
GET | /api/csp/registers/:entityId/export |
GET | /api/csp/registers/:entityId/history |
GET | /api/csp/risk-assessments |
POST | /api/csp/risk-assessments |
GET | /api/csp/risk-assessments/:id |
PATCH | /api/csp/risk-assessments/:id |
POST | /api/csp/risk-assessments/:id/approve |
POST | /api/csp/risk-assessments/:id/reject |
POST | /api/csp/risk-assessments/compute |
GET | /api/csp/risk-assessments/entity/:entityId |
GET | /api/csp/stakeholders/exposure/:individualId |
GET | /api/csp/stakeholders/shared |
GET | /api/csp/ubos/:entityId |
POST | /api/csp/ubos/compute |
GET | /api/csp/ubos/mismatches |
Csrf
| Method | Endpoint |
|---|---|
GET | /api/csrf |
Dashboards
| Method | Endpoint |
|---|---|
GET | /api/dashboards/:id |
PUT | /api/dashboards/:id |
DELETE | /api/dashboards/:id |
GET | /api/dashboards/:id/comments |
POST | /api/dashboards/:id/comments |
PATCH | /api/dashboards/:id/comments/:commentId |
DELETE | /api/dashboards/:id/comments/:commentId |
GET | /api/dashboards/:id/labels |
POST | /api/dashboards/:id/labels |
DELETE | /api/dashboards/:id/labels |
POST | /api/dashboards/:id/reactions |
GET | /api/dashboards/:id/sharing |
PUT | /api/dashboards/:id/sharing |
GET | /api/dashboards/:id/versions |
POST | /api/dashboards/:id/versions |
GET | /api/dashboards/:id/versions/:versionId |
POST | /api/dashboards/:id/versions/:versionId |
GET | /api/dashboards/:id/widget-data |
POST | /api/dashboards/:id/widget-data |
GET | /api/dashboards/labels |
Docs
| Method | Endpoint |
|---|---|
POST | /api/docs/embed |
GET | /api/docs/search |
Documents
| Method | Endpoint |
|---|---|
GET | /api/documents/:id |
DELETE | /api/documents/:id |
GET | /api/documents/:id/pdf-annotations |
POST | /api/documents/:id/pdf-annotations |
PATCH | /api/documents/:id/pdf-annotations/:annotationId |
DELETE | /api/documents/:id/pdf-annotations/:annotationId |
GET | /api/documents/:id/pdf-annotations/export |
GET | /api/documents/:id/pdf-form-fields |
GET | /api/documents/:id/pdf-text-map |
POST | /api/documents/:id/pdf-variables/fill |
POST | /api/documents/:id/pdf-variables/send-envelope |
POST | /api/documents/:id/pdf-variables/suggest |
GET | /api/documents/doc/:id |
PUT | /api/documents/doc/:id |
DELETE | /api/documents/doc/:id |
POST | /api/documents/doc/:id/access-request |
POST | /api/documents/doc/:id/access-request/decision |
GET | /api/documents/doc/:id/acknowledge |
POST | /api/documents/doc/:id/acknowledge |
POST | /api/documents/doc/:id/archive |
GET | /api/documents/doc/:id/comments |
POST | /api/documents/doc/:id/comments |
PATCH | /api/documents/doc/:id/comments/:commentId |
DELETE | /api/documents/doc/:id/comments/:commentId |
GET | /api/documents/doc/:id/embed |
GET | /api/documents/doc/:id/export |
GET | /api/documents/doc/:id/export-all |
GET | /api/documents/doc/:id/headers-footers |
PATCH | /api/documents/doc/:id/headers-footers |
GET | /api/documents/doc/:id/labels |
POST | /api/documents/doc/:id/labels |
DELETE | /api/documents/doc/:id/labels |
PATCH | /api/documents/doc/:id/move |
POST | /api/documents/doc/:id/reactions |
POST | /api/documents/doc/:id/reupload |
POST | /api/documents/doc/:id/scaffold-form |
GET | /api/documents/doc/:id/sharing |
POST | /api/documents/doc/:id/sharing |
PUT | /api/documents/doc/:id/sharing |
GET | /api/documents/doc/:id/signoffs |
POST | /api/documents/doc/:id/signoffs |
PATCH | /api/documents/doc/:id/signoffs/:signoffId |
DELETE | /api/documents/doc/:id/signoffs/:signoffId |
PATCH | /api/documents/doc/:id/signoffs/config |
GET | /api/documents/doc/:id/structural-map |
GET | /api/documents/doc/:id/versions |
GET | /api/documents/doc/:id/versions/:versionId |
POST | /api/documents/doc/:id/versions/:versionId |
GET | /api/documents/doc/:id/views |
POST | /api/documents/doc/:id/views |
GET | /api/documents/doc/:id/watch |
POST | /api/documents/doc/:id/watch |
GET | /api/documents/docx-sources |
GET | /api/documents/favourites |
POST | /api/documents/favourites |
GET | /api/documents/generated |
GET | /api/documents/generated/:id |
GET | /api/documents/generated/:id/download |
GET | /api/documents/generated/:id/download-all |
POST | /api/documents/generated/:id/signers |
PUT | /api/documents/generated/:id/status |
GET | /api/documents/labels |
GET | /api/documents/packs |
POST | /api/documents/packs |
GET | /api/documents/packs/:packId |
PUT | /api/documents/packs/:packId |
DELETE | /api/documents/packs/:packId |
POST | /api/documents/packs/:packId/generate |
POST | /api/documents/packs/:packId/preview |
POST | /api/documents/packs/:packId/scaffold-form |
POST | /api/documents/packs/:packId/templates |
DELETE | /api/documents/packs/:packId/templates/:docId |
GET | /api/documents/packs/:packId/variables |
GET | /api/documents/public-embed/:token |
GET | /api/documents/templates |
POST | /api/documents/templates |
GET | /api/documents/toolbox |
GET | /api/documents/tree |
POST | /api/documents/upload-document |
GET | /api/documents/upload-document/:id |
GET | /api/documents/upload-document/:id/download |
POST | /api/documents/upload-document/:id/extract |
GET | /api/documents/upload-document/list |
Equity
| Method | Endpoint |
|---|---|
POST | /api/equity/convertibles/:id/convert |
POST | /api/equity/convertibles/:id/convert-via-mechanism |
GET | /api/equity/entities |
POST | /api/equity/entities |
GET | /api/equity/entities/:id |
PATCH | /api/equity/entities/:id |
DELETE | /api/equity/entities/:id |
GET | /api/equity/entities/:id/ocf-export |
GET | /api/equity/entities/:id/summary |
GET | /api/equity/financings |
POST | /api/equity/financings |
GET | /api/equity/financings/:id |
PATCH | /api/equity/financings/:id |
DELETE | /api/equity/financings/:id |
POST | /api/equity/grants/:id/cancel |
POST | /api/equity/grants/:id/exercise |
POST | /api/equity/grants/:id/transition |
GET | /api/equity/holdings |
POST | /api/equity/holdings |
GET | /api/equity/holdings/:id |
PATCH | /api/equity/holdings/:id |
DELETE | /api/equity/holdings/:id |
POST | /api/equity/ocf-import |
GET | /api/equity/option-plans |
POST | /api/equity/option-plans |
GET | /api/equity/option-plans/:id |
PATCH | /api/equity/option-plans/:id |
DELETE | /api/equity/option-plans/:id |
GET | /api/equity/option-plans/:id/pool |
GET | /api/equity/transactions |
GET | /api/equity/transactions/:id |
GET | /api/equity/valuations |
POST | /api/equity/valuations |
GET | /api/equity/valuations/:id |
PATCH | /api/equity/valuations/:id |
DELETE | /api/equity/valuations/:id |
GET | /api/equity/vesting-events |
GET | /api/equity/vesting-terms/:id/preview |
POST | /api/equity/warrants/:id/exercise |
Esop
| Method | Endpoint |
|---|---|
GET | /api/esop/pool |
External Connections
| Method | Endpoint |
|---|---|
GET | /api/external-connections |
POST | /api/external-connections |
GET | /api/external-connections/:connectionId |
PATCH | /api/external-connections/:connectionId |
DELETE | /api/external-connections/:connectionId |
POST | /api/external-connections/:connectionId/sync |
GET | /api/external-connections/:connectionId/tables |
POST | /api/external-connections/:connectionId/test |
Extraction
| Method | Endpoint |
|---|---|
GET | /api/extraction/pending |
POST | /api/extraction/pending |
Files
| Method | Endpoint |
|---|---|
GET | /api/files/:fileId/access-log |
POST | /api/files/:fileId/duplicate |
POST | /api/files/:fileId/extract |
POST | /api/files/:fileId/request-access |
POST | /api/files/:fileId/retention |
GET | /api/files/:fileId/sensitivity |
PATCH | /api/files/:fileId/sensitivity |
GET | /api/files/:fileId/versions |
POST | /api/files/:fileId/versions |
GET | /api/files/archived |
DELETE | /api/files/archived/:id |
GET | /api/files/browse |
GET | /api/files/browse/structure |
GET | /api/files/escalations |
POST | /api/files/escalations/:id |
GET | /api/files/registry-coverage |
POST | /api/files/registry-coverage |
GET | /api/files/shared/:fileId |
Forms
| Method | Endpoint |
|---|---|
GET | /api/forms/:id/favourite |
POST | /api/forms/:id/favourite |
POST | /api/forms/:id/send |
GET | /api/forms/:id/versions |
GET | /api/forms/:id/versions/:versionId |
POST | /api/forms/:id/versions/:versionId/rollback |
GET | /api/forms/:id/watch |
POST | /api/forms/:id/watch |
Health
| Method | Endpoint |
|---|---|
GET | /api/health |
Hubspot
| Method | Endpoint |
|---|---|
GET | /api/hubspot/pipelines |
GET | /api/hubspot/pipelines/:pipelineId/stages |
GET | /api/hubspot/properties |
Identity
| Method | Endpoint |
|---|---|
GET | /api/identity/reviews |
POST | /api/identity/reviews/:reviewId |
Integrations
| Method | Endpoint |
|---|---|
GET | /api/integrations |
POST | /api/integrations |
GET | /api/integrations/:id |
PATCH | /api/integrations/:id |
DELETE | /api/integrations/:id |
GET | /api/integrations/hubspot/mappings |
POST | /api/integrations/hubspot/mappings |
PATCH | /api/integrations/hubspot/mappings/:id |
DELETE | /api/integrations/hubspot/mappings/:id |
GET | /api/integrations/hubspot/properties |
POST | /api/integrations/hubspot/sync |
GET | /api/integrations/mailersend/templates |
POST | /api/integrations/onfido/check |
GET | /api/integrations/onfido/check/:id |
GET | /api/integrations/sendgrid/templates |
GET | /api/integrations/stats |
Invoices
| Method | Endpoint |
|---|---|
GET | /api/invoices |
POST | /api/invoices |
GET | /api/invoices/:id |
PATCH | /api/invoices/:id |
DELETE | /api/invoices/:id |
POST | /api/invoices/:id/sync |
GET | /api/invoices/stats |
Matter Templates
| Method | Endpoint |
|---|---|
GET | /api/matter-templates/:id/versions |
GET | /api/matter-templates/:id/versions/:versionId |
POST | /api/matter-templates/:id/versions/:versionId/rollback |
Matters
| Method | Endpoint |
|---|---|
GET | /api/matters |
POST | /api/matters |
GET | /api/matters/:id/bundle |
GET | /api/matters/:id/comments |
POST | /api/matters/:id/comments |
GET | /api/matters/:id/compliance-exceptions |
POST | /api/matters/:id/compliance-exceptions |
GET | /api/matters/:id/compliance-exceptions/:exceptionId |
PATCH | /api/matters/:id/compliance-exceptions/:exceptionId |
DELETE | /api/matters/:id/compliance-exceptions/:exceptionId |
GET | /api/matters/:id/data |
PATCH | /api/matters/:id/data |
GET | /api/matters/:id/documents |
POST | /api/matters/:id/documents |
DELETE | /api/matters/:id/documents/:docId |
POST | /api/matters/:id/documents/download |
POST | /api/matters/:id/duplicate |
GET | /api/matters/:id/envelopes |
POST | /api/matters/:id/envelopes |
GET | /api/matters/:id/envelopes/:envelopeId |
PATCH | /api/matters/:id/envelopes/:envelopeId |
DELETE | /api/matters/:id/envelopes/:envelopeId |
POST | /api/matters/:id/envelopes/:envelopeId/docuseal |
POST | /api/matters/:id/envelopes/:envelopeId/docusign |
GET | /api/matters/:id/envelopes/providers |
POST | /api/matters/:id/files/filing-folder |
GET | /api/matters/:id/knowledge-links |
POST | /api/matters/:id/knowledge-links |
DELETE | /api/matters/:id/knowledge-links |
GET | /api/matters/:id/profiles |
GET | /api/matters/:id/regulator-comments |
POST | /api/matters/:id/regulator-comments |
GET | /api/matters/:id/regulator-comments/:commentId |
PATCH | /api/matters/:id/regulator-comments/:commentId |
DELETE | /api/matters/:id/regulator-comments/:commentId |
GET | /api/matters/:id/relations |
POST | /api/matters/:id/relations |
DELETE | /api/matters/:id/relations/:relationId |
GET | /api/matters/:id/sidebar-details |
POST | /api/matters/:id/steps/:stepId/assign |
GET | /api/matters/:id/steps/:stepId/automation-context |
POST | /api/matters/:id/steps/:stepId/clear-form |
PATCH | /api/matters/:id/steps/:stepId/config |
PATCH | /api/matters/:id/steps/:stepId/due-date |
GET | /api/matters/:id/steps/:stepId/form-status |
POST | /api/matters/:id/steps/:stepId/init-form |
POST | /api/matters/:id/steps/:stepId/preview-document |
POST | /api/matters/:id/steps/:stepId/reopen |
POST | /api/matters/:id/steps/:stepId/send-form |
POST | /api/matters/:id/steps/:stepId/skip |
POST | /api/matters/:id/steps/:stepId/state-machine-transition |
DELETE | /api/matters/:id/steps/:stepId/state-machine-transition |
POST | /api/matters/:id/steps/:stepId/subtasks |
POST | /api/matters/:id/steps/:stepId/subtasks/:subtaskId/toggle |
GET | /api/matters/:id/xero-link |
PUT | /api/matters/:id/xero-link |
DELETE | /api/matters/:id/xero-link |
POST | /api/matters/bulk-assign |
GET | /api/matters/labels |
GET | /api/matters/sidebar-tree |
GET | /api/matters/templates/:id/hubspot |
PATCH | /api/matters/templates/:id/hubspot |
DELETE | /api/matters/templates/:id/hubspot |
GET | /api/matters/templates/:id/hubspot/status |
POST | /api/matters/templates/:id/hubspot/sync |
GET | /api/matters/templates/:id/payload-paths |
GET | /api/matters/templates/folder-presets |
Mcp
| Method | Endpoint |
|---|---|
GET | /api/mcp |
POST | /api/mcp |
GET | /api/mcp/health |
POST | /api/mcp/keys |
POST | /api/mcp/tools/call |
GET | /api/mcp/tools/list |
Metrics
| Method | Endpoint |
|---|---|
GET | /api/metrics |
Notifications
| Method | Endpoint |
|---|---|
PATCH | /api/notifications/:id |
DELETE | /api/notifications/:id |
POST | /api/notifications/mark-all-read |
Onboarding
| Method | Endpoint |
|---|---|
POST | /api/onboarding/organisation |
POST | /api/onboarding/workspace |
Oversight
| Method | Endpoint |
|---|---|
GET | /api/oversight/change-requests |
GET | /api/oversight/change-requests/:id |
POST | /api/oversight/change-requests/:id/approve |
GET | /api/oversight/change-requests/:id/comments |
POST | /api/oversight/change-requests/:id/comments |
POST | /api/oversight/change-requests/:id/reject |
GET | /api/oversight/overseer-members |
GET | /api/oversight/relationships |
PATCH | /api/oversight/relationships/:id |
DELETE | /api/oversight/relationships/:id |
GET | /api/oversight/requests |
POST | /api/oversight/requests |
GET | /api/oversight/requests/:id |
DELETE | /api/oversight/requests/:id |
POST | /api/oversight/requests/:id/approve |
POST | /api/oversight/requests/:id/reject |
GET | /api/oversight/subordinates |
GET | /api/oversight/subordinates/:orgId/tables |
GET | /api/oversight/subordinates/:orgId/tables/:tableId/rows |
POST | /api/oversight/subordinates/:orgId/tables/:tableId/rows |
PATCH | /api/oversight/subordinates/:orgId/tables/:tableId/rows/:rowId |
Partners
| Method | Endpoint |
|---|---|
GET | /api/partners/register |
POST | /api/partners/register |
Pipelines
| Method | Endpoint |
|---|---|
POST | /api/pipelines/connections/:id/check |
POST | /api/pipelines/connections/:id/discover |
GET | /api/pipelines/connections/:id/runs/:runId |
POST | /api/pipelines/connections/:id/runs/:runId |
POST | /api/pipelines/connections/:id/variants |
POST | /api/pipelines/connections/:id/webhook-url |
POST | /api/pipelines/connections/test |
GET | /api/pipelines/connector-types |
GET | /api/pipelines/cron |
POST | /api/pipelines/oauth/xero/authorize |
GET | /api/pipelines/oauth/xero/callback |
POST | /api/pipelines/oauth/xero/exchange |
POST | /api/pipelines/run-all |
POST | /api/pipelines/webhook/:token |
Portal Access
| Method | Endpoint |
|---|---|
GET | /api/portal-access |
POST | /api/portal-access |
GET | /api/portal-access/:id |
PATCH | /api/portal-access/:id |
DELETE | /api/portal-access/:id |
Registry
| Method | Endpoint |
|---|---|
GET | /api/registry/submissions |
POST | /api/registry/submissions |
GET | /api/registry/submissions/:id |
PATCH | /api/registry/submissions/:id |
Scim
| Method | Endpoint |
|---|---|
GET | /api/scim/v2/ResourceTypes |
GET | /api/scim/v2/Schemas |
GET | /api/scim/v2/ServiceProviderConfig |
GET | /api/scim/v2/Users |
POST | /api/scim/v2/Users |
GET | /api/scim/v2/Users/:userId |
PATCH | /api/scim/v2/Users/:userId |
DELETE | /api/scim/v2/Users/:userId |
Search
| Method | Endpoint |
|---|---|
GET | /api/search |
Security
| Method | Endpoint |
|---|---|
POST | /api/security/csp-report |
Settings
| Method | Endpoint |
|---|---|
GET | /api/settings/ai-usage |
GET | /api/settings/users |
POST | /api/settings/users |
GET | /api/settings/users/:id |
PATCH | /api/settings/users/:id |
DELETE | /api/settings/users/:id |
Share
| Method | Endpoint |
|---|---|
GET | /api/share/:token |
GET | /api/share/form/:id |
POST | /api/share/form/:id/submit |
GET | /api/share/view/:sharedId |
Sign
| Method | Endpoint |
|---|---|
GET | /api/sign/envelopes |
POST | /api/sign/envelopes |
GET | /api/sign/envelopes/:id |
PATCH | /api/sign/envelopes/:id |
DELETE | /api/sign/envelopes/:id |
GET | /api/sign/envelopes/:id/audit-bundle |
GET | /api/sign/envelopes/:id/fields |
POST | /api/sign/envelopes/:id/fields |
PATCH | /api/sign/envelopes/:id/fields/:fieldId |
DELETE | /api/sign/envelopes/:id/fields/:fieldId |
PUT | /api/sign/envelopes/:id/recipients |
POST | /api/sign/envelopes/:id/send |
GET | /api/sign/sessions/:token |
GET | /api/sign/sessions/:token/audit-cert |
GET | /api/sign/sessions/:token/auth-check |
POST | /api/sign/sessions/:token/consent |
POST | /api/sign/sessions/:token/decline |
GET | /api/sign/sessions/:token/download |
POST | /api/sign/sessions/:token/otp |
PUT | /api/sign/sessions/:token/otp |
GET | /api/sign/sessions/:token/pdf |
POST | /api/sign/sessions/:token/sign |
POST | /api/sign/sessions/:token/submit |
Signing
| Method | Endpoint |
|---|---|
GET | /api/signing/status |
Sql
| Method | Endpoint |
|---|---|
POST | /api/sql/execute |
GET | /api/sql/saved |
POST | /api/sql/saved |
PATCH | /api/sql/saved/:id |
DELETE | /api/sql/saved/:id |
Stakeholders
| Method | Endpoint |
|---|---|
GET | /api/stakeholders/:id/files |
GET | /api/stakeholders/entities |
GET | /api/stakeholders/entities/:id |
PATCH | /api/stakeholders/entities/:id |
POST | /api/stakeholders/entities/:id/favorite |
GET | /api/stakeholders/entities/:id/files |
POST | /api/stakeholders/entities/:id/follow |
GET | /api/stakeholders/entities/:id/sources |
POST | /api/stakeholders/entities/bulk-update |
GET | /api/stakeholders/export |
GET | /api/stakeholders/individuals |
GET | /api/stakeholders/individuals/:id |
PATCH | /api/stakeholders/individuals/:id |
POST | /api/stakeholders/individuals/:id/favorite |
GET | /api/stakeholders/individuals/:id/files |
POST | /api/stakeholders/individuals/:id/follow |
GET | /api/stakeholders/individuals/:id/sources |
POST | /api/stakeholders/individuals/bulk-update |
GET | /api/stakeholders/sources |
POST | /api/stakeholders/sources |
PATCH | /api/stakeholders/sources/:id |
DELETE | /api/stakeholders/sources/:id |
POST | /api/stakeholders/sources/resolve |
Stored Files
| Method | Endpoint |
|---|---|
GET | /api/stored-files/:key |
Submissions
| Method | Endpoint |
|---|---|
GET | /api/submissions/:id/comments |
POST | /api/submissions/:id/comments |
PATCH | /api/submissions/:id/comments/:commentId |
DELETE | /api/submissions/:id/comments/:commentId |
GET | /api/submissions/:id/documents |
POST | /api/submissions/:id/documents |
DELETE | /api/submissions/:id/documents |
GET | /api/submissions/:id/history |
GET | /api/submissions/:id/notes |
POST | /api/submissions/:id/notes |
POST | /api/submissions/:id/reactions |
POST | /api/submissions/:id/share |
POST | /api/submissions/:id/share/email |
GET | /api/submissions/:id/snapshots/:snapshotId |
POST | /api/submissions/:id/snapshots/:snapshotId/rollback |
POST | /api/submissions/:id/submit |
GET | /api/submissions/:id/visibility |
PUT | /api/submissions/:id/visibility |
GET | /api/submissions/drafts |
POST | /api/submissions/drafts |
GET | /api/submissions/drafts/:id |
PATCH | /api/submissions/drafts/:id |
DELETE | /api/submissions/drafts/:id |
GET | /api/submissions/stats |
Tables
| Method | Endpoint |
|---|---|
GET | /api/tables |
POST | /api/tables |
POST | /api/tables/:tableId/aggregate |
POST | /api/tables/:tableId/archive |
GET | /api/tables/:tableId/changes |
GET | /api/tables/:tableId/children |
POST | /api/tables/:tableId/children |
GET | /api/tables/:tableId/comments |
POST | /api/tables/:tableId/comments |
PATCH | /api/tables/:tableId/comments/:commentId |
DELETE | /api/tables/:tableId/comments/:commentId |
GET | /api/tables/:tableId/document |
POST | /api/tables/:tableId/document |
POST | /api/tables/:tableId/duplicate |
GET | /api/tables/:tableId/favourite |
POST | /api/tables/:tableId/favourite |
DELETE | /api/tables/:tableId/favourite |
GET | /api/tables/:tableId/follow |
POST | /api/tables/:tableId/follow |
DELETE | /api/tables/:tableId/follow |
POST | /api/tables/:tableId/move |
GET | /api/tables/:tableId/page-views |
POST | /api/tables/:tableId/page-views |
GET | /api/tables/:tableId/permissions |
POST | /api/tables/:tableId/permissions |
DELETE | /api/tables/:tableId/permissions |
GET | /api/tables/:tableId/presence |
POST | /api/tables/:tableId/presence |
DELETE | /api/tables/:tableId/presence |
GET | /api/tables/:tableId/property-groups |
POST | /api/tables/:tableId/property-groups |
PATCH | /api/tables/:tableId/property-groups/:groupId |
DELETE | /api/tables/:tableId/property-groups/:groupId |
PATCH | /api/tables/:tableId/property-groups/reorder |
POST | /api/tables/:tableId/reactions |
POST | /api/tables/:tableId/rows/:rowId/archive |
PATCH | /api/tables/:tableId/rows/:rowId/cell |
GET | /api/tables/:tableId/rows/:rowId/files |
GET | /api/tables/:tableId/rows/:rowId/links |
POST | /api/tables/:tableId/rows/:rowId/links |
DELETE | /api/tables/:tableId/rows/:rowId/links |
GET | /api/tables/:tableId/rows/:rowId/notes |
POST | /api/tables/:tableId/rows/:rowId/notes |
PATCH | /api/tables/:tableId/rows/:rowId/notes/:noteId |
GET | /api/tables/:tableId/rows/:rowId/profile |
GET | /api/tables/:tableId/rows/:rowId/related |
GET | /api/tables/:tableId/rows/:rowId/revisions |
POST | /api/tables/:tableId/rows/:rowId/revisions/:revisionId/restore |
GET | /api/tables/:tableId/rows/groups |
GET | /api/tables/:tableId/snapshots |
POST | /api/tables/:tableId/snapshots |
GET | /api/tables/:tableId/snapshots/:snapshotId |
DELETE | /api/tables/:tableId/snapshots/:snapshotId |
POST | /api/tables/:tableId/snapshots/:snapshotId/restore |
GET | /api/tables/:tableId/views |
POST | /api/tables/:tableId/views |
GET | /api/tables/:tableId/webhooks |
POST | /api/tables/:tableId/webhooks |
POST | /api/tables/:tableId/webhooks/:webhookId |
PATCH | /api/tables/:tableId/webhooks/:webhookId |
DELETE | /api/tables/:tableId/webhooks/:webhookId |
GET | /api/tables/:tableId/webhooks/:webhookId/deliveries |
GET | /api/tables/:tableId/webhooks/:webhookId/deliveries/:deliveryId |
POST | /api/tables/form/backfill |
POST | /api/tables/integration/init |
POST | /api/tables/matter/backfill |
POST | /api/tables/matter/init |
GET | /api/tables/registers |
POST | /api/tables/registers |
GET | /api/tables/stats |
POST | /api/tables/system/init |
GET | /api/tables/tree |
Tasks
| Method | Endpoint |
|---|---|
GET | /api/tasks/:dashboardId/share |
POST | /api/tasks/:dashboardId/share |
DELETE | /api/tasks/:dashboardId/share |
GET | /api/tasks/my-dashboard |
GET | /api/tasks/shared |
Templates
| Method | Endpoint |
|---|---|
GET | /api/templates |
POST | /api/templates |
GET | /api/templates/:id |
GET | /api/templates/:id/versions |
GET | /api/templates/:id/versions/:versionId |
POST | /api/templates/:id/versions/:versionId/rollback |
GET | /api/templates/stats |
Tools
| Method | Endpoint |
|---|---|
POST | /api/tools/web-to-pdf |
User
| Method | Endpoint |
|---|---|
GET | /api/user/themes/tokens |
GET | /api/user/workspaces |
Views
| Method | Endpoint |
|---|---|
POST | /api/views/:viewId/duplicate |
Webhooks
| Method | Endpoint |
|---|---|
POST | /api/webhooks/docuseal |
POST | /api/webhooks/docusign |
GET | /api/webhooks/onfido |
POST | /api/webhooks/onfido |
POST | /api/webhooks/xero |
Workflows
| Method | Endpoint |
|---|---|
GET | /api/workflows/:id |
PATCH | /api/workflows/:id |
DELETE | /api/workflows/:id |
POST | /api/workflows/:id/execute |
GET | /api/workflows/:id/runs |
GET | /api/workflows/:id/runs/:runId |
GET | /api/workflows/:id/runs/export |
GET | /api/workflows/callback/:token |
POST | /api/workflows/callback/:token |
POST | /api/workflows/runs/:runId/resume |
GET | /api/workflows/stats |
Xero
| Method | Endpoint |
|---|---|
GET | /api/xero/connections |
GET | /api/xero/reports |
GET | /api/xero/search |
Xw
| Method | Endpoint |
|---|---|
GET | /api/xw/:token |
POST | /api/xw/:token |
POST | /api/xw/:token/action |
Undocumented Route Groups
The following API route groups do not yet have dedicated documentation pages. They are visible in the endpoint catalog above.
| Group | Description |
|---|---|
agent-tasks / agent | AI Agent API - autonomous task queue and execution |
identity / registry | Identity resolution - cross-workspace identity management |
oversight | Oversight topology - cross-workspace supervision hierarchy |
cross-workspace-tasks / xw | Cross-workspace operations - task delegation and data sharing between workspaces |
change-requests | Change request workflows - approval chains for data and configuration changes |
consent | Consent records and policy management |
cron | Scheduled maintenance and sync jobs |
external-connections | External connection management - OAuth tokens, connection health, and sync status |
partners / portal-access | Partner and portal access - partner onboarding, portal token management |
c | Client portal - public client-facing endpoints |