opbox

All API endpoints

The complete inventory of every route the Opbox front end exposes under /api, generated directly from the Next.js route handlers so it never drifts from the code. Path parameters are shown as :name; a *name segment is a catch-all. Every route is workspace-scoped and requires authentication (see Authentication); mutating routes additionally require a CSRF token.

Summary

StatValue
Endpoints (route files)944
Method + path pairs1329
Route groups93
HTTP methods in useDELETE, GET, PATCH, POST, PUT

accounting

MethodsEndpoint
GET/api/accounting/stats

addons

MethodsEndpoint
GET, POST/api/addons
DELETE, GET, PATCH/api/addons/:key

admin

MethodsEndpoint
POST/api/admin/agent-tasks/:id/approve
POST/api/admin/agent-tasks/:id/reject
GET/api/admin/agent-tasks/pending-review
GET, PUT/api/admin/ai-platform
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, POST/api/admin/breaches
GET, POST/api/admin/document-webhooks
DELETE, GET, PATCH/api/admin/document-webhooks/:id
GET, POST/api/admin/invites
DELETE/api/admin/invites/:id
GET/api/admin/invites/options
GET/api/admin/managed-hosts
PATCH/api/admin/managed-hosts/:orgId
POST/api/admin/managed-hosts/:orgId/backfill-cost-forwarding
POST/api/admin/managed-hosts/:orgId/hermes-credentials
GET/api/admin/organizations
PUT/api/admin/organizations/:orgId/byok
GET, POST/api/admin/organizations/:orgId/trusted-idps
DELETE, PATCH/api/admin/organizations/:orgId/trusted-idps/:idpId
POST/api/admin/organizations/:orgId/two-factor-policy
POST/api/admin/oversight-debug
GET, POST/api/admin/rag
GET/api/admin/security-events
POST/api/admin/skills/resync
DELETE/api/admin/users/:userId/erasure
GET, POST/api/admin/workspaces
DELETE, POST/api/admin/workspaces/:id/suspend

agent

MethodsEndpoint
GET, POST/api/agent/api-keys
DELETE, GET, PATCH/api/agent/api-keys/:id

agent-escalations

MethodsEndpoint
POST/api/agent-escalations/:id/decide

agent-tasks

MethodsEndpoint
GET, POST/api/agent-tasks
GET, PATCH/api/agent-tasks/:taskId
POST/api/agent-tasks/:taskId/claim
PATCH/api/agent-tasks/:taskId/complete
PATCH/api/agent-tasks/:taskId/progress
POST/api/agent-tasks/:taskId/retry

agents

MethodsEndpoint
GET, POST/api/agents
DELETE/api/agents/:agentId
GET/api/agents/activity
POST/api/agents/govern
GET/api/agents/roster
POST/api/agents/skills
GET/api/agents/tasks

ai

MethodsEndpoint
POST/api/ai/byok-request
POST/api/ai/chat
GET, POST/api/ai/chats
GET, PATCH/api/ai/chats/:id
POST/api/ai/chats/:id/generate-title
GET, POST/api/ai/chats/:id/messages
POST/api/ai/chats/:id/messages/:mid/rate
POST/api/ai/kernel-chat
POST/api/ai/kernel-chat/approve
GET/api/ai/models
POST/api/ai/passport-ocr
GET/api/ai/platform-status
GET, POST/api/ai/skills
DELETE, GET, POST/api/ai/skills/:id
GET/api/ai/status
POST/api/ai/transcribe
GET/api/ai/transcripts
DELETE, GET/api/ai/transcripts/:id
POST/api/ai/voice/govern
POST/api/ai/widget-configure

api-keys

MethodsEndpoint
DELETE, GET, POST/api/api-keys

approve-tokens

MethodsEndpoint
POST/api/approve-tokens/:token

audit

MethodsEndpoint
GET/api/audit
GET/api/audit/kernel-events
GET/api/audit/resource

auth

MethodsEndpoint
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
POST/api/auth/two-factor/disable
POST/api/auth/two-factor/regenerate-backup-codes
POST, PUT/api/auth/two-factor/setup
GET/api/auth/two-factor/status
POST/api/auth/two-factor/verify
GET/api/auth/validate-invite

billing

MethodsEndpoint
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

box-audit-head

MethodsEndpoint
POST/api/box-audit-head

c

MethodsEndpoint
GET/api/c/:token
GET/api/c/:token/calendar/:stepId
POST/api/c/:token/calendar/:stepId/confirm
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
POST/api/c/portal/generate

calendar

MethodsEndpoint
GET/api/calendar

change-requests

MethodsEndpoint
GET/api/change-requests
DELETE, GET/api/change-requests/:id
MethodsEndpoint
GET, POST/api/consent
DELETE, PATCH/api/consent/:id
GET/api/consent/check

cron

MethodsEndpoint
GET/api/cron/agent-gate-timeout
GET/api/cron/auto-approve-steps
GET/api/cron/backup-restore-drill
GET/api/cron/breach-overdue
GET/api/cron/calendar-reminders
GET/api/cron/compliance-degradation
GET/api/cron/cross-workspace-tasks
GET/api/cron/data-retention
GET/api/cron/db-backup
GET/api/cron/entity-edge-reconcile
GET/api/cron/erasure-verify
GET/api/cron/esop-vesting
GET/api/cron/expire-cost-events-prev-tokens
GET/api/cron/expire-file-grants
GET/api/cron/extraction-snapshot-cleanup
GET/api/cron/helpdesk-sla
POST/api/cron/hubspot-sync
GET/api/cron/identity-reconciliation
GET/api/cron/keepalive
GET/api/cron/managed-org-monthly-invoice
GET/api/cron/openrouter-sync
POST/api/cron/payment-rail-sweep
GET/api/cron/pipeline-enrichment
GET/api/cron/presence-reconciliation
GET/api/cron/prune-document-presence
GET/api/cron/purge-archived-documents
GET/api/cron/reconcile-budget-snapshots
GET/api/cron/retry-background-jobs
GET/api/cron/scheduled-tasks
GET/api/cron/sign-anchor-rollup
GET/api/cron/sign-reminders
GET/api/cron/sweep-abandoned-captures
GET/api/cron/tool-catalogue-notify
GET/api/cron/trigger-schedule
GET/api/cron/verify-ai-keys
GET/api/cron/verify-audit-chains
GET/api/cron/workflows

cross-workspace-tasks

MethodsEndpoint
GET/api/cross-workspace-tasks
GET/api/cross-workspace-tasks/:id
POST/api/cross-workspace-tasks/:id/action

csp

MethodsEndpoint
GET, POST/api/csp/bank-accounts
DELETE, GET, PATCH/api/csp/bank-accounts/:id
GET/api/csp/bridged-rows
GET/api/csp/compliance/calendar
GET/api/csp/compliance/kyc-expiry
GET, 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
GET/api/csp/entities/:entityId/document-coverage
GET/api/csp/entities/:entityId/files
GET/api/csp/entities/workbench-rows
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
GET/api/csp/individuals/:individualId/files
GET, POST/api/csp/kyc-documents
DELETE, GET, PATCH/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, POST/api/csp/risk-assessments
GET, 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, POST/api/csp/rules
DELETE, PATCH/api/csp/rules/:id
GET, POST/api/csp/source-of-funds
DELETE, GET, PATCH/api/csp/source-of-funds/:id
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

MethodsEndpoint
GET/api/csrf

dashboard

MethodsEndpoint
GET/api/dashboard/pending-actions

dashboards

MethodsEndpoint
GET, POST/api/dashboards
DELETE, GET, PUT/api/dashboards/:id
GET, POST/api/dashboards/:id/comments
DELETE, PATCH/api/dashboards/:id/comments/:commentId
DELETE, GET, POST/api/dashboards/:id/labels
DELETE, GET, POST/api/dashboards/:id/presence
POST/api/dashboards/:id/reactions
POST/api/dashboards/:id/request-access
GET, PUT/api/dashboards/:id/sharing
DELETE, GET, PUT/api/dashboards/:id/user-layout
GET, POST/api/dashboards/:id/versions
GET, POST/api/dashboards/:id/versions/:versionId
GET, POST/api/dashboards/:id/views
GET, POST/api/dashboards/:id/widget-data
GET/api/dashboards/labels

design-source

MethodsEndpoint
GET/api/design-source

dev

MethodsEndpoint
GET, PUT/api/dev/flags

docs

MethodsEndpoint
POST/api/docs/embed
GET/api/docs/gate
GET/api/docs/search

documents

MethodsEndpoint
GET, POST/api/documents
DELETE, GET/api/documents/:id
GET/api/documents/:id/compatibility-report
GET/api/documents/:id/compatibility-report/gate
GET/api/documents/:id/kernel-annotations
GET, POST/api/documents/:id/pdf-annotations
DELETE, PATCH/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
POST/api/documents/:id/sign-from-tokens
DELETE, GET, PUT/api/documents/doc/:id
POST/api/documents/doc/:id/access-request
POST/api/documents/doc/:id/access-request/decision
GET, POST/api/documents/doc/:id/acknowledge
POST/api/documents/doc/:id/archive
DELETE/api/documents/doc/:id/bookmarks/:name
GET, POST/api/documents/doc/:id/comments
DELETE, PATCH/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/file-intel
GET, PATCH/api/documents/doc/:id/headers-footers
DELETE, GET, POST/api/documents/doc/:id/labels
PATCH/api/documents/doc/:id/move
GET/api/documents/doc/:id/pagination
GET/api/documents/doc/:id/preview
POST/api/documents/doc/:id/reactions
POST/api/documents/doc/:id/reupload
POST/api/documents/doc/:id/scaffold-form
GET, POST, PUT/api/documents/doc/:id/sharing
GET, POST/api/documents/doc/:id/signoffs
DELETE, PATCH/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/styles
GET/api/documents/doc/:id/versions
GET, POST/api/documents/doc/:id/versions/:versionId
GET, POST/api/documents/doc/:id/views
GET, POST/api/documents/doc/:id/watch
GET/api/documents/docx-sources
GET, 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/kernel
GET/api/documents/labels
GET, POST/api/documents/packs
DELETE, GET, PUT/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, 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

entities

MethodsEndpoint
GET/api/entities/:tableId/:rowId
GET/api/entities/:tableId/:rowId/associations
GET/api/entities/:tableId/:rowId/backlinks
GET/api/entities/:tableId/:rowId/connections
GET/api/entities/:tableId/:rowId/document-intelligence
POST/api/entities/:tableId/:rowId/edges
GET/api/entities/:tableId/:rowId/graph
GET/api/entities/:tableId/:rowId/peers
GET/api/entities/:tableId/:rowId/timeline
GET/api/entities/:tableId/cross-workspace
GET/api/entities/by-matter/:id
GET/api/entities/dashboard
GET/api/entities/global-stakeholders/:id/equity-holdings
GET/api/entities/global-stakeholders/:id/intelligence
GET/api/entities/individuals/:id/equity-holdings
GET/api/entities/path
GET/api/entities/sidebar
GET/api/entities/sidebar/scopes

equity

MethodsEndpoint
GET, POST/api/equity/convertibles
DELETE, GET, PATCH/api/equity/convertibles/:id
POST/api/equity/convertibles/:id/convert
POST/api/equity/convertibles/:id/convert-via-mechanism
GET, POST/api/equity/entities
DELETE, GET, PATCH/api/equity/entities/:id
GET/api/equity/entities/:id/ocf-export
GET/api/equity/entities/:id/summary
GET, POST/api/equity/financings
DELETE, GET, PATCH/api/equity/financings/:id
GET, POST/api/equity/grants
DELETE, GET, PATCH/api/equity/grants/:id
POST/api/equity/grants/:id/cancel
POST/api/equity/grants/:id/exercise
POST/api/equity/grants/:id/transition
GET, POST/api/equity/holdings
DELETE, GET, PATCH/api/equity/holdings/:id
POST/api/equity/ocf-import
GET, POST/api/equity/option-plans
DELETE, GET, PATCH/api/equity/option-plans/:id
GET/api/equity/option-plans/:id/pool
GET, POST/api/equity/share-classes
DELETE, GET, PATCH/api/equity/share-classes/:id
GET/api/equity/transactions
GET/api/equity/transactions/:id
GET, POST/api/equity/valuations
DELETE, GET, PATCH/api/equity/valuations/:id
GET/api/equity/vesting-events
GET, POST/api/equity/vesting-terms
DELETE, GET, PATCH/api/equity/vesting-terms/:id
GET/api/equity/vesting-terms/:id/preview
GET, POST/api/equity/warrants
DELETE, GET, PATCH/api/equity/warrants/:id
POST/api/equity/warrants/:id/exercise

esop

MethodsEndpoint
GET/api/esop/pool
GET, POST/api/esop/setup

external-connections

MethodsEndpoint
GET, POST/api/external-connections
DELETE, GET, PATCH/api/external-connections/:connectionId
POST/api/external-connections/:connectionId/sync
GET/api/external-connections/:connectionId/tables
POST/api/external-connections/:connectionId/test

extraction

MethodsEndpoint
GET, POST/api/extraction/pending

files

MethodsEndpoint
GET, POST/api/files
DELETE, GET/api/files/:fileId
GET/api/files/:fileId/access-log
GET/api/files/:fileId/download
POST/api/files/:fileId/duplicate
POST/api/files/:fileId/extract
GET/api/files/:fileId/grants
DELETE/api/files/:fileId/grants/:grantId
POST/api/files/:fileId/links
DELETE/api/files/:fileId/links/:linkId
PUT/api/files/:fileId/move
POST/api/files/:fileId/request-access
POST/api/files/:fileId/retention
GET, PATCH/api/files/:fileId/sensitivity
DELETE, POST/api/files/:fileId/share
PUT/api/files/:fileId/star
GET, POST/api/files/:fileId/versions
GET/api/files/:fileId/view
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
DELETE, POST, PUT/api/files/folders
GET, POST/api/files/registry
GET, POST/api/files/registry-coverage
GET/api/files/registry/:fileId
GET/api/files/shared/:fileId

forms

MethodsEndpoint
GET, POST/api/forms
DELETE, GET, PATCH/api/forms/:id
GET, 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, POST/api/forms/:id/watch
GET/api/forms/kernel/envelopes
GET/api/forms/kernel/envelopes/:envelopeId
GET/api/forms/kernel/templates
GET/api/forms/kernel/templates/:templateId

health

MethodsEndpoint
GET/api/health
GET/api/health/preview

helpdesk

MethodsEndpoint
GET, POST/api/helpdesk/canned-responses
GET/api/helpdesk/stats
GET, POST/api/helpdesk/tickets
GET, PATCH/api/helpdesk/tickets/:id
POST/api/helpdesk/tickets/:id/reply

hubspot

MethodsEndpoint
GET/api/hubspot/pipelines
GET/api/hubspot/pipelines/:pipelineId/stages
GET/api/hubspot/properties

identity

MethodsEndpoint
GET/api/identity/reviews
POST/api/identity/reviews/:reviewId
GET/api/identity/row/:rowId/presence
POST/api/identity/row/:rowId/resolve

inbox

MethodsEndpoint
GET/api/inbox/kernel

integrations

MethodsEndpoint
GET, POST/api/integrations
DELETE, GET, PATCH/api/integrations/:id
POST/api/integrations/ai/execute
GET, POST/api/integrations/hubspot/mappings
DELETE, PATCH/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

internal

MethodsEndpoint
POST/api/internal/extraction/run
GET/api/internal/file/:key
POST/api/internal/identity/resolve
POST/api/internal/kyc/validate
GET/api/internal/matters/:id/bundle-source-files
GET/api/internal/matters/:id/line-items
POST/api/internal/oversight/approval
POST/api/internal/party/resolve

invoices

MethodsEndpoint
GET, POST/api/invoices
DELETE, GET, PATCH/api/invoices/:id
GET, POST/api/invoices/:id/comments
DELETE, PATCH/api/invoices/:id/comments/:commentId
POST/api/invoices/:id/comments/:commentId/resolve
GET, PATCH/api/invoices/:id/kernel
POST/api/invoices/:id/kernel/charge
POST/api/invoices/:id/kernel/credit-note
POST/api/invoices/:id/kernel/payment
POST/api/invoices/:id/kernel/refund
POST/api/invoices/:id/manual-payment
POST/api/invoices/:id/payment-request
POST/api/invoices/:id/payment-request/:requestId/cancel
GET/api/invoices/:id/payment-request/list
POST/api/invoices/:id/payments/:paymentId/manual-refund
POST/api/invoices/:id/payments/:paymentId/refund
GET/api/invoices/:id/pdf
POST/api/invoices/:id/sync
GET, POST/api/invoices/branding-themes
DELETE, PATCH/api/invoices/branding-themes/:id
GET, POST/api/invoices/credit-notes
GET, POST/api/invoices/kernel
GET, POST/api/invoices/kernel/defaults
PATCH/api/invoices/settings
GET/api/invoices/stats

kernel

MethodsEndpoint
POST/api/kernel/equity/authorised-capital
GET/api/kernel/equity/captable/:entityId
POST/api/kernel/equity/convert
POST/api/kernel/equity/grants
POST/api/kernel/equity/grants/:id/cancel
POST/api/kernel/equity/grants/:id/exercise
POST/api/kernel/equity/grants/:id/lapse
GET/api/kernel/equity/ocf-export/:entityId
POST/api/kernel/equity/ocf-import
POST/api/kernel/equity/plans
POST/api/kernel/equity/plans/:id/adopt
POST/api/kernel/equity/pools
GET/api/kernel/equity/pools/:id/status
POST/api/kernel/equity/pools/:id/topup
POST/api/kernel/equity/reclassify
GET/api/kernel/equity/register/:entityId
POST/api/kernel/equity/transfer
POST/api/kernel/equity/vesting/define
POST/api/kernel/equity/vesting/materialise
POST/api/kernel/equity/vesting/vest

matter-metadata-fields

MethodsEndpoint
DELETE, GET, PATCH, POST/api/matter-metadata-fields

matter-templates

MethodsEndpoint
GET, POST/api/matter-templates
DELETE, GET, PATCH/api/matter-templates/:id
GET/api/matter-templates/:id/versions
GET/api/matter-templates/:id/versions/:versionId
POST/api/matter-templates/:id/versions/:versionId/rollback
GET/api/matter-templates/options

matters

MethodsEndpoint
GET, POST/api/matters
DELETE, GET, PATCH/api/matters/:id
GET/api/matters/:id/activity
POST/api/matters/:id/advance
GET/api/matters/:id/bundle
GET/api/matters/:id/bundle/preflight
POST/api/matters/:id/cancel
GET, POST/api/matters/:id/comments
GET/api/matters/:id/compliance
GET, POST/api/matters/:id/compliance-exceptions
DELETE, GET, PATCH/api/matters/:id/compliance-exceptions/:exceptionId
GET, PATCH/api/matters/:id/data
GET/api/matters/:id/dependency-graph
GET, POST/api/matters/:id/documents
DELETE/api/matters/:id/documents/:docId
POST/api/matters/:id/documents/download
POST/api/matters/:id/duplicate
GET, POST/api/matters/:id/envelopes
DELETE, GET, PATCH/api/matters/:id/envelopes/:envelopeId
POST/api/matters/:id/envelopes/:envelopeId/docusign
GET/api/matters/:id/envelopes/providers
GET/api/matters/:id/files
POST/api/matters/:id/files/filing-folder
DELETE, GET, POST/api/matters/:id/follow
POST/api/matters/:id/goto
POST/api/matters/:id/hold
GET, PUT/api/matters/:id/kernel/billing-profile
GET, POST/api/matters/:id/kernel/remittance
GET, POST/api/matters/:id/kernel/time
PATCH/api/matters/:id/kernel/time/:entryId
DELETE, GET, POST/api/matters/:id/knowledge-links
DELETE, GET, PATCH, POST/api/matters/:id/line-items
GET, PATCH/api/matters/:id/metadata
GET/api/matters/:id/party-relationships
GET, POST/api/matters/:id/portal
GET/api/matters/:id/profiles
GET, POST/api/matters/:id/regulator-comments
DELETE, GET, PATCH/api/matters/:id/regulator-comments/:commentId
GET, POST/api/matters/:id/relations
DELETE/api/matters/:id/relations/:relationId
GET/api/matters/:id/sidebar-details
POST/api/matters/:id/spawn
POST/api/matters/:id/steps/:stepId/activate
GET/api/matters/:id/steps/:stepId/agent-task
POST/api/matters/:id/steps/:stepId/assign
GET/api/matters/:id/steps/:stepId/automation-context
PATCH, POST/api/matters/:id/steps/:stepId/calendar
POST/api/matters/:id/steps/:stepId/clear-form
POST/api/matters/:id/steps/:stepId/complete
PATCH/api/matters/:id/steps/:stepId/config
DELETE, POST/api/matters/:id/steps/:stepId/dependencies
POST/api/matters/:id/steps/:stepId/dispatch
PATCH/api/matters/:id/steps/:stepId/due-date
POST/api/matters/:id/steps/:stepId/execute-workflow
GET/api/matters/:id/steps/:stepId/form-status
POST/api/matters/:id/steps/:stepId/init-form
POST/api/matters/:id/steps/:stepId/invoice-generate
POST/api/matters/:id/steps/:stepId/invoice-send
POST/api/matters/:id/steps/:stepId/preview-document
POST/api/matters/:id/steps/:stepId/redispatch-acceptance-gate
POST/api/matters/:id/steps/:stepId/reject
POST/api/matters/:id/steps/:stepId/reopen
PATCH/api/matters/:id/steps/:stepId/requirement-tracker
POST/api/matters/:id/steps/:stepId/send-form
POST/api/matters/:id/steps/:stepId/skip
DELETE, POST/api/matters/:id/steps/:stepId/state-machine-transition
POST/api/matters/:id/steps/:stepId/subtasks
DELETE, PATCH/api/matters/:id/steps/:stepId/subtasks/:subtaskId
POST/api/matters/:id/steps/:stepId/subtasks/:subtaskId/toggle
GET, POST/api/matters/:id/support-tickets
GET, POST/api/matters/:id/views
DELETE, GET, PUT/api/matters/:id/xero-link
POST/api/matters/bulk-assign
GET/api/matters/labels
GET/api/matters/sidebar-tree
DELETE, GET, PATCH/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

MethodsEndpoint
GET, POST/api/mcp
GET/api/mcp/catalogue/diff
GET/api/mcp/catalogue/fingerprint
GET/api/mcp/catalogue/snapshots
GET/api/mcp/files/:fileId/download
GET/api/mcp/health
POST/api/mcp/keys
POST/api/mcp/tools/call
GET/api/mcp/tools/list

metrics

MethodsEndpoint
GET/api/metrics

notifications

MethodsEndpoint
GET, POST/api/notifications
DELETE, PATCH/api/notifications/:id
POST/api/notifications/mark-all-read

onboarding

MethodsEndpoint
POST/api/onboarding/organisation
POST/api/onboarding/workspace

onyx

MethodsEndpoint
POST/api/onyx/budget-check
POST/api/onyx/cost-events

organizations

MethodsEndpoint
GET, POST/api/organizations
DELETE, GET, PATCH/api/organizations/:orgId
GET, POST/api/organizations/:orgId/agent-access
GET, POST/api/organizations/:orgId/agent-autonomy
GET, POST/api/organizations/:orgId/ai-budget
DELETE, GET, PUT/api/organizations/:orgId/ai-config
GET, POST/api/organizations/:orgId/ai-credentials
DELETE, GET, PATCH/api/organizations/:orgId/ai-credentials/:id
DELETE, POST/api/organizations/:orgId/ai-credentials/:id/managed-agents
POST/api/organizations/:orgId/invites/:inviteId/resend
GET, POST/api/organizations/:orgId/members
DELETE, PATCH/api/organizations/:orgId/members/:memberId
POST/api/organizations/:orgId/members/:memberId/reset-2fa
POST/api/organizations/:orgId/members/:memberId/unlock-login
POST/api/organizations/:orgId/transfer-ownership
DELETE, GET, POST/api/organizations/:orgId/workspaces
GET, POST/api/organizations/:orgId/workspaces/:workspaceId/members
DELETE/api/organizations/:orgId/workspaces/:workspaceId/members/:memberId
POST/api/organizations/:orgId/workspaces/:workspaceId/transfer-ownership

oversight

MethodsEndpoint
GET/api/oversight/change-requests
GET/api/oversight/change-requests/:id
POST/api/oversight/change-requests/:id/approve
GET, POST/api/oversight/change-requests/:id/comments
POST/api/oversight/change-requests/:id/reject
GET/api/oversight/identities
GET, PATCH/api/oversight/identities/:globalIdentityId
GET/api/oversight/overseer-members
GET/api/oversight/relationships
DELETE, PATCH/api/oversight/relationships/:id
GET, POST/api/oversight/requests
DELETE, GET/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, POST/api/oversight/subordinates/:orgId/tables/:tableId/rows
PATCH/api/oversight/subordinates/:orgId/tables/:tableId/rows/:rowId

p

MethodsEndpoint
GET/api/p/:token
GET/api/p/:token/billing
GET/api/p/:token/cap-table/:entityId
GET, POST/api/p/:token/changes
GET, POST/api/p/:token/changes/:changeId
GET/api/p/:token/compliance/:entityId
GET/api/p/:token/dashboard
GET/api/p/:token/documents
GET/api/p/:token/entities
GET/api/p/:token/entities/:entityId
GET/api/p/:token/equity/:entityId
GET/api/p/:token/esop/:entityId
GET, POST/api/p/:token/helpdesk
GET, POST/api/p/:token/helpdesk/:ticketId
GET/api/p/:token/matters
GET/api/p/:token/matters/:matterId
GET, POST/api/p/:token/messages
GET/api/p/:token/pinca
POST/api/p/:token/pinca/submit
GET/api/p/:token/registers/:entityId/:registerType
GET, POST/api/p/:token/tasks

partners

MethodsEndpoint
GET, POST/api/partners
GET, PATCH/api/partners/:id
GET, POST/api/partners/invite
GET, POST/api/partners/register

pipelines

MethodsEndpoint
GET, POST/api/pipelines/connections
DELETE, GET, PATCH, PUT/api/pipelines/connections/:id
POST/api/pipelines/connections/:id/check
POST/api/pipelines/connections/:id/discover
GET, POST/api/pipelines/connections/:id/linkages
DELETE, GET, PATCH/api/pipelines/connections/:id/linkages/:linkageId
GET, POST/api/pipelines/connections/:id/runs
GET, 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
GET/api/pipelines/linkages
POST/api/pipelines/oauth/stripe-connect/authorize
GET/api/pipelines/oauth/stripe-connect/callback
POST/api/pipelines/oauth/wise/connect
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/runs/:runId/enrich
POST/api/pipelines/webhook/:token

portal-access

MethodsEndpoint
GET, POST/api/portal-access
DELETE, GET, PATCH/api/portal-access/:id

portals

MethodsEndpoint
GET, POST/api/portals
GET, PATCH/api/portals/:id
GET/api/portals/:id/activity
GET/api/portals/:id/changes
GET, PATCH/api/portals/:id/changes/:changeId
POST/api/portals/:id/changes/:changeId/apply
POST/api/portals/:id/changes/:changeId/review
GET, POST/api/portals/:id/links
PATCH/api/portals/:id/links/:linkId
POST/api/portals/:id/links/:linkId/send
GET, POST/api/portals/:id/messages
GET, POST/api/portals/:id/objects
DELETE, PATCH/api/portals/:id/objects/:objectId
GET, POST/api/portals/:id/tasks
GET/api/portals/kernel
GET/api/portals/kernel/:portalId
GET, POST/api/portals/templates
DELETE, GET, PATCH/api/portals/templates/:templateId
POST/api/portals/templates/:templateId/duplicate

profile-presets

MethodsEndpoint
GET/api/profile-presets
DELETE, GET, PUT/api/profile-presets/:entityType/:tabId

registry

MethodsEndpoint
GET, POST/api/registry/submissions
GET, PATCH/api/registry/submissions/:id

research-sessions

MethodsEndpoint
PATCH/api/research-sessions/:sessionId/decisions
POST/api/research-sessions/:sessionId/finalise

reviews

MethodsEndpoint
GET/api/reviews/kernel

scheduled-tasks

MethodsEndpoint
GET, POST/api/scheduled-tasks
DELETE, GET, PATCH/api/scheduled-tasks/:id
POST/api/scheduled-tasks/:id/pause
POST/api/scheduled-tasks/:id/run-now
GET/api/scheduled-tasks/:id/runs

scim

MethodsEndpoint
GET/api/scim/v2/ResourceTypes
GET/api/scim/v2/Schemas
GET/api/scim/v2/ServiceProviderConfig
GET, POST/api/scim/v2/Users
DELETE, GET, PATCH/api/scim/v2/Users/:userId
MethodsEndpoint
GET/api/search

security

MethodsEndpoint
POST/api/security/csp-report

settings

MethodsEndpoint
GET, PUT/api/settings/agent-config
POST/api/settings/agent-config/test-fire
GET, PUT/api/settings/ai-budget
DELETE, GET, PATCH, POST/api/settings/ai-config
POST/api/settings/ai-config/hermes/test-fire
DELETE, GET, PATCH/api/settings/ai-config/personal
POST/api/settings/ai-config/test
GET/api/settings/ai-context
GET, PUT/api/settings/ai-org-budget
GET/api/settings/ai-timeline
GET/api/settings/ai-usage
GET, PATCH/api/settings/jurisdiction
GET, POST/api/settings/retention
GET, POST/api/settings/sensitivity
GET, POST/api/settings/users
DELETE, GET, PATCH/api/settings/users/:id

share

MethodsEndpoint
GET/api/share/:token
GET/api/share/file/:token
GET/api/share/form/:id
POST/api/share/form/:id/submit
GET/api/share/view/:sharedId

sign

MethodsEndpoint
GET, POST/api/sign/envelopes
DELETE, GET, PATCH, POST/api/sign/envelopes/:id
GET/api/sign/envelopes/:id/audit-bundle
POST/api/sign/envelopes/:id/bulk-send
GET, POST/api/sign/envelopes/:id/fields
DELETE, PATCH/api/sign/envelopes/:id/fields/:fieldId
PUT/api/sign/envelopes/:id/recipients
POST/api/sign/envelopes/:id/send
GET/api/sign/kernel
GET/api/sign/kernel/:envelopeId
GET/api/sign/kernel/:envelopeId/chain
GET/api/sign/recipients/search
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, PUT/api/sign/sessions/:token/otp
GET/api/sign/sessions/:token/pdf
POST/api/sign/sessions/:token/sign
POST/api/sign/sessions/:token/submit
GET/api/sign/signatory-sources

skills

MethodsEndpoint
GET/api/skills
POST/api/skills/:skillKey/customize
DELETE, PATCH/api/skills/:skillKey/overlay
POST/api/skills/:skillKey/overlay/copy
POST/api/skills/:skillKey/overlay/review
GET/api/skills/by-document/:documentId

sql

MethodsEndpoint
POST/api/sql/execute
GET, POST/api/sql/saved
DELETE, PATCH/api/sql/saved/:id

stakeholders

MethodsEndpoint
GET/api/stakeholders/:id/files
GET/api/stakeholders/entities
GET, 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, 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
POST/api/stakeholders/merge
GET, POST/api/stakeholders/party
GET, PATCH/api/stakeholders/party/:partyId
POST/api/stakeholders/party/:partyId/kyc
POST/api/stakeholders/party/:partyId/verification
POST/api/stakeholders/party/link
PATCH/api/stakeholders/party/link/:id
GET, POST/api/stakeholders/sources
DELETE, PATCH/api/stakeholders/sources/:id
POST/api/stakeholders/sources/resolve

stored-files

MethodsEndpoint
GET/api/stored-files/:key

submissions

MethodsEndpoint
GET, POST/api/submissions
DELETE, GET, PATCH, PUT/api/submissions/:id
GET, POST/api/submissions/:id/comments
DELETE, PATCH/api/submissions/:id/comments/:commentId
DELETE, GET, POST/api/submissions/:id/documents
GET/api/submissions/:id/history
GET, 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
GET/api/submissions/:id/snapshots/:snapshotId
POST/api/submissions/:id/snapshots/:snapshotId/rollback
POST/api/submissions/:id/submit
GET, PUT/api/submissions/:id/visibility
GET, POST/api/submissions/drafts
DELETE, GET, PATCH/api/submissions/drafts/:id
GET/api/submissions/stats

tables

MethodsEndpoint
GET, POST/api/tables
DELETE, GET, PUT/api/tables/:tableId
POST/api/tables/:tableId/aggregate
POST/api/tables/:tableId/archive
GET/api/tables/:tableId/changes
GET, POST/api/tables/:tableId/children
GET, PATCH, POST/api/tables/:tableId/columns
DELETE, GET, PATCH/api/tables/:tableId/columns/:columnId
GET, POST/api/tables/:tableId/comments
DELETE, PATCH/api/tables/:tableId/comments/:commentId
GET, POST/api/tables/:tableId/document
POST/api/tables/:tableId/duplicate
DELETE, GET, POST/api/tables/:tableId/favourite
DELETE, GET, POST/api/tables/:tableId/follow
POST/api/tables/:tableId/move
GET, POST/api/tables/:tableId/page-views
DELETE, GET, POST/api/tables/:tableId/permissions
DELETE, GET, POST/api/tables/:tableId/presence
GET, POST/api/tables/:tableId/property-groups
DELETE, PATCH/api/tables/:tableId/property-groups/:groupId
PATCH/api/tables/:tableId/property-groups/reorder
POST/api/tables/:tableId/reactions
GET, POST/api/tables/:tableId/rows
DELETE, GET, PATCH/api/tables/:tableId/rows/:rowId
POST/api/tables/:tableId/rows/:rowId/archive
PATCH/api/tables/:tableId/rows/:rowId/cell
GET/api/tables/:tableId/rows/:rowId/files
DELETE, GET, POST/api/tables/:tableId/rows/:rowId/links
GET, 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, POST/api/tables/:tableId/snapshots
DELETE, GET/api/tables/:tableId/snapshots/:snapshotId
POST/api/tables/:tableId/snapshots/:snapshotId/restore
GET, POST/api/tables/:tableId/views
GET, POST/api/tables/:tableId/webhooks
DELETE, PATCH, POST/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
GET/api/tables/kernel
POST/api/tables/matter/backfill
POST/api/tables/matter/init
GET, POST/api/tables/registers
GET/api/tables/stats
POST/api/tables/system/init
GET/api/tables/tree

tasks

MethodsEndpoint
GET/api/tasks
DELETE, GET, POST/api/tasks/:dashboardId/share
POST/api/tasks/bulk
GET/api/tasks/my-dashboard
GET/api/tasks/shared

teams

MethodsEndpoint
GET, POST/api/teams
DELETE, GET, PATCH/api/teams/:teamId
POST/api/teams/:teamId/members
DELETE, PATCH/api/teams/:teamId/members/:userId
GET/api/teams/:teamId/workload

templates

MethodsEndpoint
GET, POST/api/templates
DELETE, GET, PATCH/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

MethodsEndpoint
POST/api/tools/web-to-pdf

upload

MethodsEndpoint
POST/api/upload

user

MethodsEndpoint
GET/api/user/erasure-certificate
DELETE/api/user/me
GET/api/user/me/agent-name
POST/api/user/me/erasure-request
GET/api/user/me/export
GET, PUT/api/user/preferences
GET, PUT/api/user/profile
GET, PUT/api/user/theme
GET, POST/api/user/themes
DELETE, GET, PATCH, PUT/api/user/themes/:id
DELETE, GET, PUT/api/user/themes/:id/tokens/:tokenKey
GET/api/user/themes/tokens
GET/api/user/workspaces

users

MethodsEndpoint
GET/api/users

v1

MethodsEndpoint
GET/api/v1/forms
GET/api/v1/forms/:id
GET, POST/api/v1/forms/:id/submissions
GET, POST/api/v1/matters
GET, PATCH/api/v1/matters/:id
GET/api/v1/matters/:id/steps
PATCH/api/v1/matters/:id/steps/:stepId
GET/api/v1/openapi
GET, POST/api/v1/webhooks
DELETE, PATCH/api/v1/webhooks/:id

views

MethodsEndpoint
DELETE, GET, PATCH/api/views/:viewId
POST/api/views/:viewId/duplicate

visa

MethodsEndpoint
GET/api/visa/filing-data/:matterId
GET, POST/api/visa/setup

webhooks

MethodsEndpoint
POST/api/webhooks/docusign
GET, POST/api/webhooks/onfido
POST/api/webhooks/stripe-connect
POST/api/webhooks/wise
POST/api/webhooks/xero

workflows

MethodsEndpoint
GET, POST/api/workflows
DELETE, GET, PATCH/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, POST/api/workflows/callback/:token
POST/api/workflows/internal/execute-node
POST/api/workflows/runs/:runId/resume
POST/api/workflows/send-email
GET/api/workflows/stats

workspace

MethodsEndpoint
POST/api/workspace/export
POST/api/workspace/export/wip-B
GET/api/workspace/skills
POST/api/workspace/switch

workspace-members

MethodsEndpoint
PATCH/api/workspace-members/:userId
GET/api/workspace-members/:userId/peek

workspaces

MethodsEndpoint
GET, POST/api/workspaces
DELETE, GET, PATCH/api/workspaces/:workspaceId
GET, PUT/api/workspaces/:workspaceId/audit-retention
DELETE/api/workspaces/:workspaceId/members/:userId/erasure
PUT/api/workspaces/:workspaceId/processing-role
DELETE, GET, PUT/api/workspaces/:workspaceId/sso
POST/api/workspaces/:workspaceId/sso/scim-tokens
DELETE/api/workspaces/:workspaceId/sso/scim-tokens/:tokenId

xero

MethodsEndpoint
GET/api/xero/connections
GET/api/xero/reports
GET/api/xero/search

xw

MethodsEndpoint
GET, POST/api/xw/:token
POST/api/xw/:token/action