Complete API surface
- This catalog is generated from
apps/api/src/index.tsandapps/api/src/routes/*.ts. - Regenerate it with
pnpm --filter @dealmeld/docs run generate:api-surfaceafter route changes. - It is a source-backed route inventory, not a replacement for the interactive OpenAPI schema.
- The OpenAPI reference should be expanded until every public tenant automation endpoint has request and response schemas.
Coverage summary
| Metric | Count |
|---|---|
| Mounted source operations | 546 |
| Operations currently represented in the interactive OpenAPI reference | 506 |
| Tenant/user/agent-callable operations in this catalog | 468 |
| Platform admin or operator operations | 61 |
The interactive API Reference currently covers the initial public schema slice. This catalog is broader: it enumerates every mounted route so agents and implementers can see the actual platform surface while schema coverage catches up.
Audience tags
| Audience | Meaning |
|---|---|
| Public | Does not require a user JWT or tenant API access key. Often used for marketing, signup, public rooms, or signed inbound webhooks. |
| Capability discovery | Exposes connector metadata, agent manifests, and workflow templates without tenant data. |
| Tenant scoped | Requires a user JWT or tenant API access key plus tenant context and permissions. This is the main customer and agent automation surface. |
| Signed webhook | Public ingress route that authenticates with provider-specific signatures instead of bearer auth. |
| Platform admin | Internal/operator route. Do not expose to customer agents unless they are explicitly acting as a platform administrator. |
Activities, comments, reactions, and saved views
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | /api/activities | Tenant scoped | List, search, or inspect activities records. | Yes | apps/api/src/routes/activities.ts |
POST | /api/activities | Tenant scoped | Create activities records or child resources. | Yes | apps/api/src/routes/activities.ts |
GET | /api/comments | Tenant scoped | List, search, or inspect comments records. | Yes | apps/api/src/routes/comments.ts |
POST | /api/comments | Tenant scoped | Create comments records or child resources. | Yes | apps/api/src/routes/comments.ts |
DELETE | /api/comments/{id} | Tenant scoped | Delete or revoke comments state. | Yes | apps/api/src/routes/comments.ts |
GET | /api/reactions | Tenant scoped | List, search, or inspect reactions records. | Yes | apps/api/src/routes/reactions.ts |
POST | /api/reactions | Tenant scoped | Create reactions records or child resources. | Yes | apps/api/src/routes/reactions.ts |
GET | /api/saved-views | Tenant scoped | List, search, or inspect saved views records. | Yes | apps/api/src/routes/saved-views.ts |
POST | /api/saved-views | Tenant scoped | Create saved views records or child resources. | Yes | apps/api/src/routes/saved-views.ts |
DELETE | /api/saved-views/{id} | Tenant scoped | Delete or revoke saved views state. | Yes | apps/api/src/routes/saved-views.ts |
GET | /api/saved-views/{id} | Tenant scoped | Read one saved views record. | Yes | apps/api/src/routes/saved-views.ts |
PATCH | /api/saved-views/{id} | Tenant scoped | Update saved views state. | Yes | apps/api/src/routes/saved-views.ts |
Agent actions and approvals
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | /api/agent/actions/approvals | Tenant scoped | List, search, or inspect agent records. | Yes | apps/api/src/routes/agent-actions.ts |
GET | /api/agent/actions/approvals/{approvalId} | Tenant scoped | Read one agent record. | Yes | apps/api/src/routes/agent-actions.ts |
POST | /api/agent/actions/approvals/{approvalId}/approve | Tenant scoped | Run the approve action. | Yes | apps/api/src/routes/agent-actions.ts |
POST | /api/agent/actions/approvals/{approvalId}/reject | Tenant scoped | Run the reject action. | Yes | apps/api/src/routes/agent-actions.ts |
GET | /api/agent/actions/policy | Tenant scoped | List, search, or inspect agent records. | Yes | apps/api/src/routes/agent-actions.ts |
PATCH | /api/agent/actions/policy | Tenant scoped | Update agent state. | Yes | apps/api/src/routes/agent-actions.ts |
POST | /api/agent/actions/proposals | Tenant scoped | Create agent records or child resources. | Yes | apps/api/src/routes/agent-actions.ts |
Agent discovery
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | /api/agent/a2a-card.json | Capability discovery | List, search, or inspect agent records. | Yes | apps/api/src/routes/agent.ts |
GET | /api/agent/capabilities | Capability discovery | List, search, or inspect agent records. | Yes | apps/api/src/routes/agent.ts |
GET | /api/agent/capabilities/custom-objects | Capability discovery | List, search, or inspect agent records. | Yes | apps/api/src/routes/agent-custom-objects.ts |
GET | /api/agent/connectors/{target} | Capability discovery | Read one agent record. | Yes | apps/api/src/routes/agent.ts |
GET | /api/agent/mcp | Capability discovery | List, search, or inspect agent records. | Yes | apps/api/src/routes/agent-mcp-runtime.ts |
POST | /api/agent/mcp | Capability discovery | Create agent records or child resources. | Yes | apps/api/src/routes/agent-mcp-runtime.ts |
GET | /api/agent/mcp.json | Capability discovery | List, search, or inspect agent records. | Yes | apps/api/src/routes/agent.ts |
GET | /api/agent/openapi.json | Capability discovery | List, search, or inspect agent records. | Yes | apps/api/src/routes/agent.ts |
GET | /api/agent/templates | Capability discovery | List, search, or inspect agent records. | Yes | apps/api/src/routes/agent.ts |
GET | /api/agent/templates/{key} | Capability discovery | Read one agent record. | Yes | apps/api/src/routes/agent.ts |
GET | /api/agent/templates/{key}/render/{target} | Capability discovery | Read one agent record. | Yes | apps/api/src/routes/agent.ts |
Authentication and onboarding
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
POST | /api/auth/admin-reauth | Tenant scoped | Create auth records or child resources. | Yes | apps/api/src/routes/auth.ts |
POST | /api/auth/domain-membership | Tenant scoped | Create auth records or child resources. | Yes | apps/api/src/routes/auth.ts |
POST | /api/auth/forgot-password | Tenant scoped | Create auth records or child resources. | Yes | apps/api/src/routes/auth.ts |
POST | /api/auth/login/discover | Tenant scoped | Create auth records or child resources. | Yes | apps/api/src/routes/auth.ts |
POST | /api/auth/login/password | Tenant scoped | Create auth records or child resources. | Yes | apps/api/src/routes/auth.ts |
POST | /api/auth/login/sso | Tenant scoped | Create auth records or child resources. | Yes | apps/api/src/routes/auth.ts |
GET | /api/auth/me | Tenant scoped | List, search, or inspect auth records. | Yes | apps/api/src/routes/auth.ts |
POST | /api/auth/signup | Tenant scoped | Create auth records or child resources. | Yes | apps/api/src/routes/auth.ts |
POST | /api/auth/signup-with-invite | Tenant scoped | Create auth records or child resources. | Yes | apps/api/src/routes/auth.ts |
POST | /api/auth/tenants | Tenant scoped | Create auth records or child resources. | Yes | apps/api/src/routes/auth.ts |
POST | /api/invites | Tenant scoped | Create invites records or child resources. | Yes | apps/api/src/routes/invites.ts |
DELETE | /api/invites/{token} | Tenant scoped | Delete or revoke invites state. | Yes | apps/api/src/routes/invites.ts |
GET | /api/invites/{token} | Tenant scoped | Read one invites record. | Yes | apps/api/src/routes/invites.ts |
POST | /api/invites/{token}/accept | Tenant scoped | Create invites records or child resources. | Yes | apps/api/src/routes/invites.ts |
GET | /api/invites/{token}/auth-target | Tenant scoped | List, search, or inspect invites records. | Yes | apps/api/src/routes/invites.ts |
POST | /api/invites/{token}/resend | Tenant scoped | Run the resend action. | Yes | apps/api/src/routes/invites.ts |
POST | /api/invites/auto-accept | Tenant scoped | Create invites records or child resources. | Yes | apps/api/src/routes/invites.ts |
GET | /api/tenants/check-slug | Tenant scoped | List, search, or inspect tenants records. | Yes | apps/api/src/index.ts |
Billing and checkout
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
POST | /api/billing/cancel | Tenant scoped | Run the cancel action. | Yes | apps/api/src/routes/checkout.ts |
POST | /api/billing/checkout/lifetime | Tenant scoped | Create billing records or child resources. | Yes | apps/api/src/routes/billing.ts |
GET | /api/billing/checkout/lifetime/session/{sessionId} | Tenant scoped | Read one billing record. | Yes | apps/api/src/routes/billing.ts |
POST | /api/billing/complete | Tenant scoped | Run the complete action. | Yes | apps/api/src/routes/checkout.ts |
GET | /api/billing/disputes | Tenant scoped | List, search, or inspect billing records. | Yes | apps/api/src/routes/billing.ts |
POST | /api/billing/disputes/{id}/evidence | Tenant scoped | Create billing records or child resources. | Yes | apps/api/src/routes/billing.ts |
GET | /api/billing/plans | Public | List, search, or inspect billing records. | Yes | apps/api/src/routes/checkout.ts |
POST | /api/billing/refund | Tenant scoped | Create billing records or child resources. | Yes | apps/api/src/routes/billing.ts |
GET | /api/billing/refunds | Tenant scoped | List, search, or inspect billing records. | Yes | apps/api/src/routes/billing.ts |
POST | /api/billing/session | Tenant scoped | Create billing records or child resources. | Yes | apps/api/src/routes/checkout.ts |
GET | /api/billing/subscription | Tenant scoped | List, search, or inspect billing records. | Yes | apps/api/src/routes/checkout.ts |
POST | /api/billing/webhooks/stripe | Signed webhook | Create billing records or child resources. | Yes | apps/api/src/index.ts |
POST | /api/checkout/cancel | Tenant scoped | Run the cancel action. | Yes | apps/api/src/routes/checkout.ts |
POST | /api/checkout/complete | Tenant scoped | Run the complete action. | Yes | apps/api/src/routes/checkout.ts |
GET | /api/checkout/plans | Public | List, search, or inspect checkout records. | Yes | apps/api/src/routes/checkout.ts |
POST | /api/checkout/session | Tenant scoped | Create checkout records or child resources. | Yes | apps/api/src/routes/checkout.ts |
GET | /api/checkout/subscription | Tenant scoped | List, search, or inspect checkout records. | Yes | apps/api/src/routes/checkout.ts |
Clients, competitors, pulse, and content
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | /api/clients | Tenant scoped | List, search, or inspect clients records. | Yes | apps/api/src/routes/clients.ts |
POST | /api/clients | Tenant scoped | Create or link a client by company-owned domain, assign a client number, and associate matching contacts. | Yes | apps/api/src/routes/clients.ts |
GET | /api/clients/{id} | Tenant scoped | Read one clients record. | Yes | apps/api/src/routes/clients.ts |
GET | /api/clients/{id}/handoff-health | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/clients.ts |
GET | /api/competitors | Tenant scoped | List, search, or inspect competitors records. | Yes | apps/api/src/routes/competitors.ts |
POST | /api/competitors | Tenant scoped | Create competitors records or child resources. | Yes | apps/api/src/routes/competitors.ts |
DELETE | /api/competitors/{id} | Tenant scoped | Delete or revoke competitors state. | Yes | apps/api/src/routes/competitors.ts |
GET | /api/competitors/{id} | Tenant scoped | Read one competitors record. | Yes | apps/api/src/routes/competitors.ts |
PUT | /api/competitors/{id} | Tenant scoped | Replace or upsert competitors configuration. | Yes | apps/api/src/routes/competitors.ts |
GET | /api/competitors/{id}/battlecard | Tenant scoped | List, search, or inspect competitors records. | Yes | apps/api/src/routes/competitors.ts |
GET | /api/competitors/{id}/comparisons | Tenant scoped | List, search, or inspect competitors records. | Yes | apps/api/src/routes/competitors.ts |
POST | /api/competitors/{id}/comparisons | Tenant scoped | Create competitors records or child resources. | Yes | apps/api/src/routes/competitors.ts |
POST | /api/competitors/{id}/enrich | Tenant scoped | Run the enrich action. | Yes | apps/api/src/routes/competitors.ts |
DELETE | /api/competitors/comparisons/{compId} | Tenant scoped | Delete or revoke competitors state. | Yes | apps/api/src/routes/competitors.ts |
PUT | /api/competitors/comparisons/{compId} | Tenant scoped | Replace or upsert competitors configuration. | Yes | apps/api/src/routes/competitors.ts |
POST | /api/content/adapt | Tenant scoped | Create content records or child resources. | Yes | apps/api/src/routes/content.ts |
GET | /api/content/delivery-jobs | Tenant scoped | List, search, or inspect content records. | Yes | apps/api/src/routes/content.ts |
POST | /api/content/delivery-jobs | Tenant scoped | Create content records or child resources. | Yes | apps/api/src/routes/content.ts |
POST | /api/content/delivery-jobs/{id}/retry | Tenant scoped | Run the retry action. | Yes | apps/api/src/routes/content.ts |
GET | /api/content/drafts | Tenant scoped | List, search, or inspect content records. | Yes | apps/api/src/routes/content.ts |
POST | /api/content/drafts | Tenant scoped | Create content records or child resources. | Yes | apps/api/src/routes/content.ts |
DELETE | /api/content/drafts/{id} | Tenant scoped | Delete or revoke content state. | Yes | apps/api/src/routes/content.ts |
GET | /api/content/drafts/{id} | Tenant scoped | Read one content record. | Yes | apps/api/src/routes/content.ts |
PATCH | /api/content/drafts/{id} | Tenant scoped | Update content state. | Yes | apps/api/src/routes/content.ts |
POST | /api/content/drafts/{id}/media | Tenant scoped | Create content records or child resources. | Yes | apps/api/src/routes/content.ts |
DELETE | /api/content/drafts/{id}/media/{mediaId} | Tenant scoped | Delete or revoke content state. | Yes | apps/api/src/routes/content.ts |
GET | /api/content/drafts/{id}/media/{mediaId}/download | Tenant scoped | List, search, or inspect content records. | Yes | apps/api/src/routes/content.ts |
POST | /api/content/import-source | Tenant scoped | Create content records or child resources. | Yes | apps/api/src/routes/content.ts |
POST | /api/content/multiplex | Tenant scoped | Generate selected channel drafts from source content; returns data.sourceType and data.outputs[]. | Yes | apps/api/src/routes/content.ts |
GET | /api/pulse/dashboard | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/pulse.ts |
GET | /api/pulse/signals | Tenant scoped | List, search, or inspect pulse records. | Yes | apps/api/src/routes/pulse.ts |
POST | /api/pulse/signals | Tenant scoped | Create pulse records or child resources. | Yes | apps/api/src/routes/pulse.ts |
GET | /api/pulse/summary/{companyId} | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/pulse.ts |
Communications, calls, campaigns, and outreach
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | /api/call-recordings | Tenant scoped | List, search, or inspect call recordings records. | Yes | apps/api/src/routes/call-recordings.ts |
POST | /api/call-recordings | Tenant scoped | Create call recordings records or child resources. | Yes | apps/api/src/routes/call-recordings.ts |
DELETE | /api/call-recordings/{id} | Tenant scoped | Delete or revoke call recordings state. | Yes | apps/api/src/routes/call-recordings.ts |
GET | /api/call-recordings/{id} | Tenant scoped | Read one call recordings record. | Yes | apps/api/src/routes/call-recordings.ts |
PATCH | /api/call-recordings/{id} | Tenant scoped | Update call recordings state. | Yes | apps/api/src/routes/call-recordings.ts |
GET | /api/call-templates | Tenant scoped | List, search, or inspect call templates records. | Yes | apps/api/src/routes/call-templates.ts |
POST | /api/call-templates | Tenant scoped | Create call templates records or child resources. | Yes | apps/api/src/routes/call-templates.ts |
DELETE | /api/call-templates/{id} | Tenant scoped | Delete or revoke call templates state. | Yes | apps/api/src/routes/call-templates.ts |
PATCH | /api/call-templates/{id} | Tenant scoped | Update call templates state. | Yes | apps/api/src/routes/call-templates.ts |
GET | /api/calls | Tenant scoped | List, search, or inspect calls records. | Yes | apps/api/src/routes/calls.ts |
POST | /api/calls | Tenant scoped | Create calls records or child resources. | Yes | apps/api/src/routes/calls.ts |
DELETE | /api/calls/{id} | Tenant scoped | Delete or revoke calls state. | Yes | apps/api/src/routes/calls.ts |
GET | /api/calls/{id} | Tenant scoped | Read one calls record. | Yes | apps/api/src/routes/calls.ts |
PATCH | /api/calls/{id} | Tenant scoped | Update calls state. | Yes | apps/api/src/routes/calls.ts |
GET | /api/calls/{id}/attachments | Tenant scoped | List, search, or inspect calls records. | Yes | apps/api/src/routes/calls.ts |
POST | /api/calls/{id}/attachments | Tenant scoped | Create calls records or child resources. | Yes | apps/api/src/routes/calls.ts |
DELETE | /api/calls/{id}/attachments/{attachmentId} | Tenant scoped | Delete or revoke calls state. | Yes | apps/api/src/routes/calls.ts |
GET | /api/calls/settings/notifications | Tenant scoped | List, search, or inspect calls records. | Yes | apps/api/src/routes/calls.ts |
PATCH | /api/calls/settings/notifications | Tenant scoped | Update calls state. | Yes | apps/api/src/routes/calls.ts |
GET | /api/campaigns | Tenant scoped | List, search, or inspect campaigns records. | Yes | apps/api/src/routes/campaigns.ts |
POST | /api/campaigns | Tenant scoped | Create campaigns records or child resources. | Yes | apps/api/src/routes/campaigns.ts |
DELETE | /api/campaigns/{id} | Tenant scoped | Delete or revoke campaigns state. | Yes | apps/api/src/routes/campaigns.ts |
GET | /api/campaigns/{id} | Tenant scoped | Read one campaigns record. | Yes | apps/api/src/routes/campaigns.ts |
PATCH | /api/campaigns/{id} | Tenant scoped | Update campaigns state. | Yes | apps/api/src/routes/campaigns.ts |
GET | /api/campaigns/{id}/contacts | Tenant scoped | List, search, or inspect campaigns records. | Yes | apps/api/src/routes/campaigns.ts |
POST | /api/campaigns/{id}/contacts | Tenant scoped | Create campaigns records or child resources. | Yes | apps/api/src/routes/campaigns.ts |
POST | /api/campaigns/{id}/launch | Tenant scoped | Run the launch action. | Yes | apps/api/src/routes/campaigns.ts |
POST | /api/campaigns/{id}/pause | Tenant scoped | Run the pause action. | Yes | apps/api/src/routes/campaigns.ts |
GET | /api/communications | Tenant scoped | List, search, or inspect communications records. | Yes | apps/api/src/routes/communications.ts |
DELETE | /api/communications/{id} | Tenant scoped | Delete or revoke communications state. | Yes | apps/api/src/routes/communications.ts |
GET | /api/communications/{id} | Tenant scoped | Read one communications record. | Yes | apps/api/src/routes/communications.ts |
PATCH | /api/communications/{id} | Tenant scoped | Update communications state. | Yes | apps/api/src/routes/communications.ts |
GET | /api/communications/{id}/attachments | Tenant scoped | List, search, or inspect communications records. | Yes | apps/api/src/routes/communications.ts |
POST | /api/communications/{id}/attachments | Tenant scoped | Create communications records or child resources. | Yes | apps/api/src/routes/communications.ts |
DELETE | /api/communications/{id}/attachments/{attachmentId} | Tenant scoped | Delete or revoke communications state. | Yes | apps/api/src/routes/communications.ts |
POST | /api/communications/{id}/attachments/preview | Tenant scoped | Run the preview action. | Yes | apps/api/src/routes/communications.ts |
PATCH | /api/communications/{id}/status | Tenant scoped | Update communications state. | Yes | apps/api/src/routes/communications.ts |
POST | /api/communications/bulk-status | Tenant scoped | Create communications records or child resources. | Yes | apps/api/src/routes/communications.ts |
GET | /api/communications/engagement-timeline | Tenant scoped | List, search, or inspect communications records. | Yes | apps/api/src/routes/communications.ts |
GET | /api/communications/legacy/calls | Tenant scoped | List, search, or inspect communications records. | Yes | apps/api/src/routes/communications.ts |
POST | /api/communications/log | Tenant scoped | Create communications records or child resources. | Yes | apps/api/src/routes/communications.ts |
POST | /api/communications/schedule | Tenant scoped | Create communications records or child resources. | Yes | apps/api/src/routes/communications.ts |
GET | /api/communications/upload-limits | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/communications.ts |
GET | /api/outreach | Tenant scoped | List, search, or inspect outreach records. | Yes | apps/api/src/routes/outreach.ts |
POST | /api/outreach | Tenant scoped | Create outreach records or child resources. | Yes | apps/api/src/routes/outreach.ts |
DELETE | /api/outreach/{id} | Tenant scoped | Delete or revoke outreach state. | Yes | apps/api/src/routes/outreach.ts |
PATCH | /api/outreach/{id} | Tenant scoped | Update outreach state. | Yes | apps/api/src/routes/outreach.ts |
GET | /api/outreach/stats | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/outreach.ts |
CRM accounts, contacts, and deals
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | /api/companies | Tenant scoped | List, search, or inspect companies records. | Yes | apps/api/src/routes/companies-crud.ts |
POST | /api/companies | Tenant scoped | Create companies records or child resources. | Yes | apps/api/src/routes/companies-crud.ts |
DELETE | /api/companies/{id} | Tenant scoped | Delete or revoke companies state. | Yes | apps/api/src/routes/companies-crud.ts |
GET | /api/companies/{id} | Tenant scoped | Read one companies record. | Yes | apps/api/src/routes/companies-crud.ts |
PATCH | /api/companies/{id} | Tenant scoped | Update companies state. | Yes | apps/api/src/routes/companies-crud.ts |
GET | /api/companies/{id}/activities | Tenant scoped | List, search, or inspect companies records. | Yes | apps/api/src/routes/companies-enrichment.ts |
PATCH | /api/companies/{id}/byob | Tenant scoped | Update companies state. | Yes | apps/api/src/routes/companies-crud.ts |
PATCH | /api/companies/{id}/client-status | Tenant scoped | Update companies state. | Yes | apps/api/src/routes/companies-crud.ts |
GET | /api/companies/{id}/contacts | Tenant scoped | List, search, or inspect companies records. | Yes | apps/api/src/routes/companies-enrichment.ts |
GET | /api/companies/{id}/deals | Tenant scoped | List, search, or inspect companies records. | Yes | apps/api/src/routes/companies-enrichment.ts |
GET | /api/companies/{id}/dossier | Tenant scoped | List, search, or inspect companies records. | Yes | apps/api/src/routes/dossier.ts |
POST | /api/companies/{id}/enrich | Tenant scoped | Run the enrich action. | Yes | apps/api/src/routes/dossier.ts |
GET | /api/companies/{id}/identifiers | Tenant scoped | List company websites and email domains. | Yes | apps/api/src/routes/companies-crud.ts |
POST | /api/companies/{id}/identifiers | Tenant scoped | Add a company website or email domain. | Yes | apps/api/src/routes/companies-crud.ts |
DELETE | /api/companies/{id}/identifiers/{identifierId} | Tenant scoped | Delete a company website or email domain. | Yes | apps/api/src/routes/companies-crud.ts |
PATCH | /api/companies/{id}/identifiers/{identifierId} | Tenant scoped | Update a company website or email domain. | Yes | apps/api/src/routes/companies-crud.ts |
POST | /api/companies/{id}/intelligence | Tenant scoped | Create companies records or child resources. | Yes | apps/api/src/routes/dossier.ts |
POST | /api/companies/{id}/merge | Tenant scoped | Merge a duplicate company into the selected primary company and reparent related CRM records. | Yes | apps/api/src/routes/companies-crud.ts |
GET | /api/companies/{id}/notes | Tenant scoped | List, search, or inspect companies records. | Yes | apps/api/src/routes/companies-notes.ts |
POST | /api/companies/{id}/notes | Tenant scoped | Create companies records or child resources. | Yes | apps/api/src/routes/companies-notes.ts |
DELETE | /api/companies/{id}/notes/{noteId} | Tenant scoped | Delete or revoke companies state. | Yes | apps/api/src/routes/companies-notes.ts |
POST | /api/companies/bulk-enrich | Tenant scoped | Run the bulk enrich action. | Yes | apps/api/src/routes/dossier.ts |
GET | /api/companies/enrichment-stats | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/companies-enrichment.ts |
GET | /api/contacts | Tenant scoped | List, search, or inspect contacts records. | Yes | apps/api/src/routes/contacts.ts |
POST | /api/contacts | Tenant scoped | Create contacts records or child resources. | Yes | apps/api/src/routes/contacts.ts |
DELETE | /api/contacts/{id} | Tenant scoped | Delete or revoke contacts state. | Yes | apps/api/src/routes/contacts.ts |
GET | /api/contacts/{id} | Tenant scoped | Read one contacts record. | Yes | apps/api/src/routes/contacts.ts |
PATCH | /api/contacts/{id} | Tenant scoped | Update contacts state. | Yes | apps/api/src/routes/contacts.ts |
GET | /api/contacts/{id}/activities | Tenant scoped | List, search, or inspect contacts records. | Yes | apps/api/src/routes/contacts.ts |
GET | /api/contacts/{id}/deals | Tenant scoped | List, search, or inspect contacts records. | Yes | apps/api/src/routes/contacts.ts |
POST | /api/contacts/{id}/enrich | Tenant scoped | Run the enrich action. | Yes | apps/api/src/routes/contacts.ts |
POST | /api/contacts/{id}/merge | Tenant scoped | Merge a duplicate contact into the selected primary contact and reparent related CRM records. | Yes | apps/api/src/routes/contacts.ts |
GET | /api/contacts/{id}/notes | Tenant scoped | List, search, or inspect contacts records. | Yes | apps/api/src/routes/contacts.ts |
POST | /api/contacts/{id}/notes | Tenant scoped | Create contacts records or child resources. | Yes | apps/api/src/routes/contacts.ts |
DELETE | /api/contacts/{id}/notes/{noteId} | Tenant scoped | Delete or revoke contacts state. | Yes | apps/api/src/routes/contacts.ts |
GET | /api/contacts/{id}/relationship-summary | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/contacts.ts |
POST | /api/contacts/actions/backfill-company-associations | Tenant scoped | Create contacts records or child resources. | Yes | apps/api/src/routes/contacts.ts |
POST | /api/contacts/bulk-enrich | Tenant scoped | Run the bulk enrich action. | Yes | apps/api/src/routes/contacts.ts |
GET | /api/contacts/enrichment-stats | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/contacts.ts |
GET | /api/contacts/with-projects | Tenant scoped | List, search, or inspect contacts records. | Yes | apps/api/src/routes/contacts.ts |
GET | /api/deals | Tenant scoped | List, search, or inspect deals records. | Yes | apps/api/src/routes/deals.ts |
POST | /api/deals | Tenant scoped | Create deals records or child resources. | Yes | apps/api/src/routes/deals.ts |
DELETE | /api/deals/{id} | Tenant scoped | Delete or revoke deals state. | Yes | apps/api/src/routes/deals.ts |
GET | /api/deals/{id} | Tenant scoped | Read one deals record. | Yes | apps/api/src/routes/deals.ts |
PATCH | /api/deals/{id} | Tenant scoped | Update deals state. | Yes | apps/api/src/routes/deals.ts |
POST | /api/deals/{id}/convert | Tenant scoped | Run the convert action. | Yes | apps/api/src/routes/deals.ts |
GET | /api/deals/{id}/handoff-health | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/deals.ts |
GET | /api/deals/{id}/lineage | Tenant scoped | List, search, or inspect deals records. | Yes | apps/api/src/routes/deal-lineage.ts |
GET | /api/deals/{id}/project | Tenant scoped | List, search, or inspect deals records. | Yes | apps/api/src/routes/deals.ts |
POST | /api/deals/{id}/proposal | Tenant scoped | Create deals records or child resources. | Yes | apps/api/src/routes/deals.ts |
GET | /api/deals/{id}/proposal/pdf | Tenant scoped | List, search, or inspect deals records. | Yes | apps/api/src/routes/deals.ts |
PATCH | /api/deals/{id}/reschedule | Tenant scoped | Update deals state. | No | apps/api/src/routes/deals.ts |
PATCH | /api/deals/{id}/stage | Tenant scoped | Update deals state. | Yes | apps/api/src/routes/deals.ts |
GET | /api/deals/pipeline | Tenant scoped | List, search, or inspect deals records. | Yes | apps/api/src/routes/deals.ts |
GET | /api/deals/sla/summary | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/deal-lineage.ts |
Delivery projects, tasks, quotes, work orders, and invoices
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | /api/invoices | Tenant scoped | List, search, or inspect invoices records. | Yes | apps/api/src/routes/invoices.ts |
POST | /api/invoices | Tenant scoped | Create invoices records or child resources. | Yes | apps/api/src/routes/invoices.ts |
DELETE | /api/invoices/{id} | Tenant scoped | Delete or revoke invoices state. | Yes | apps/api/src/routes/invoices.ts |
GET | /api/invoices/{id} | Tenant scoped | Read one invoices record. | Yes | apps/api/src/routes/invoices.ts |
PATCH | /api/invoices/{id} | Tenant scoped | Update invoices state. | Yes | apps/api/src/routes/invoices.ts |
GET | /api/invoices/{id}/pdf | Tenant scoped | List, search, or inspect invoices records. | Yes | apps/api/src/routes/invoices.ts |
GET | /api/my-work | Tenant scoped | List, search, or inspect my work records. | Yes | apps/api/src/routes/my-work.ts |
GET | /api/project-templates | Tenant scoped | List, search, or inspect project templates records. | Yes | apps/api/src/routes/project-templates.ts |
POST | /api/project-templates | Tenant scoped | Create project templates records or child resources. | Yes | apps/api/src/routes/project-templates.ts |
DELETE | /api/project-templates/{id} | Tenant scoped | Delete or revoke project templates state. | Yes | apps/api/src/routes/project-templates.ts |
GET | /api/project-templates/{id} | Tenant scoped | Read one project templates record. | Yes | apps/api/src/routes/project-templates.ts |
PUT | /api/project-templates/{id} | Tenant scoped | Replace or upsert project templates configuration. | Yes | apps/api/src/routes/project-templates.ts |
GET | /api/projects | Tenant scoped | List, search, or inspect projects records. | Yes | apps/api/src/routes/projects.ts |
POST | /api/projects | Tenant scoped | Create projects records or child resources. | Yes | apps/api/src/routes/projects.ts |
DELETE | /api/projects/{id} | Tenant scoped | Delete or revoke projects state. | Yes | apps/api/src/routes/projects.ts |
GET | /api/projects/{id} | Tenant scoped | Read one projects record. | Yes | apps/api/src/routes/projects.ts |
PUT | /api/projects/{id} | Tenant scoped | Replace or upsert projects configuration. | Yes | apps/api/src/routes/projects.ts |
GET | /api/projects/{id}/contacts | Tenant scoped | List, search, or inspect projects records. | Yes | apps/api/src/routes/projects.ts |
POST | /api/projects/{id}/contacts | Tenant scoped | Create projects records or child resources. | Yes | apps/api/src/routes/projects.ts |
DELETE | /api/projects/{id}/contacts/{contactId} | Tenant scoped | Delete or revoke projects state. | Yes | apps/api/src/routes/projects.ts |
GET | /api/projects/{id}/handoff-health | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/projects.ts |
GET | /api/projects/{id}/health | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/projects.ts |
GET | /api/projects/{id}/partners | Tenant scoped | List, search, or inspect projects records. | Yes | apps/api/src/routes/projects.ts |
POST | /api/projects/{id}/partners | Tenant scoped | Create projects records or child resources. | Yes | apps/api/src/routes/projects.ts |
DELETE | /api/projects/{id}/partners/{companyId} | Tenant scoped | Delete or revoke projects state. | Yes | apps/api/src/routes/projects.ts |
PATCH | /api/projects/{id}/partners/{companyId} | Tenant scoped | Update projects state. | Yes | apps/api/src/routes/projects.ts |
POST | /api/projects/{id}/transition | Tenant scoped | Run the transition action. | Yes | apps/api/src/routes/projects.ts |
GET | /api/projects/{id}/transitions | Tenant scoped | List, search, or inspect projects records. | Yes | apps/api/src/routes/projects.ts |
GET | /api/projects/{id}/updates | Tenant scoped | List, search, or inspect projects records. | Yes | apps/api/src/routes/projects.ts |
POST | /api/projects/{id}/updates | Tenant scoped | Create projects records or child resources. | Yes | apps/api/src/routes/projects.ts |
POST | /api/projects/admin-create | Tenant scoped | Create projects records or child resources. | Yes | apps/api/src/routes/projects.ts |
GET | /api/projects/client-companies | Tenant scoped | List, search, or inspect projects records. | Yes | apps/api/src/routes/projects.ts |
GET | /api/projects/dashboard | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/projects.ts |
GET | /api/quotes | Tenant scoped | List, search, or inspect quotes records. | Yes | apps/api/src/routes/quotes.ts |
POST | /api/quotes | Tenant scoped | Create quotes records or child resources. | Yes | apps/api/src/routes/quotes.ts |
DELETE | /api/quotes/{id} | Tenant scoped | Delete or revoke quotes state. | Yes | apps/api/src/routes/quotes.ts |
GET | /api/quotes/{id} | Tenant scoped | Read one quotes record. | Yes | apps/api/src/routes/quotes.ts |
PATCH | /api/quotes/{id} | Tenant scoped | Update quotes state. | Yes | apps/api/src/routes/quotes.ts |
GET | /api/quotes/{id}/pdf | Tenant scoped | List, search, or inspect quotes records. | Yes | apps/api/src/routes/quotes.ts |
GET | /api/tasks | Tenant scoped | List, search, or inspect tasks records. | Yes | apps/api/src/routes/tasks.ts |
POST | /api/tasks | Tenant scoped | Create tasks records or child resources. | Yes | apps/api/src/routes/tasks.ts |
DELETE | /api/tasks/{id} | Tenant scoped | Delete or revoke tasks state. | Yes | apps/api/src/routes/tasks.ts |
GET | /api/tasks/{id} | Tenant scoped | Read one tasks record. | Yes | apps/api/src/routes/tasks.ts |
PUT | /api/tasks/{id} | Tenant scoped | Replace or upsert tasks configuration. | Yes | apps/api/src/routes/tasks.ts |
GET | /api/tasks/{id}/activity | Tenant scoped | List, search, or inspect tasks records. | Yes | apps/api/src/routes/tasks.ts |
PATCH | /api/tasks/{id}/reschedule | Tenant scoped | Update tasks state. | No | apps/api/src/routes/tasks.ts |
POST | /api/tasks/check-overdue | Tenant scoped | Run the check overdue action. | Yes | apps/api/src/routes/tasks.ts |
GET | /api/tasks/project/{projectId}/progress | Tenant scoped | List, search, or inspect tasks records. | Yes | apps/api/src/routes/tasks.ts |
GET | /api/work-orders | Tenant scoped | List, search, or inspect work orders records. | Yes | apps/api/src/routes/work-orders.ts |
POST | /api/work-orders | Tenant scoped | Create work orders records or child resources. | Yes | apps/api/src/routes/work-orders.ts |
DELETE | /api/work-orders/{id} | Tenant scoped | Delete or revoke work orders state. | Yes | apps/api/src/routes/work-orders.ts |
GET | /api/work-orders/{id} | Tenant scoped | Read one work orders record. | Yes | apps/api/src/routes/work-orders.ts |
PATCH | /api/work-orders/{id} | Tenant scoped | Update work orders state. | Yes | apps/api/src/routes/work-orders.ts |
GET | /api/work-orders/{id}/pdf | Tenant scoped | List, search, or inspect work orders records. | Yes | apps/api/src/routes/work-orders.ts |
Health and runtime
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | / | Public | API root health response. | Yes | apps/api/src/index.ts |
GET | /api/access-control/deals/{dealId} | Tenant scoped | Read operational or aggregate state. | No | apps/api/src/routes/deal-access-management.ts |
POST | /api/access-control/deals/{dealId}/shares | Tenant scoped | Create access control records or child resources. | No | apps/api/src/routes/deal-access-management.ts |
DELETE | /api/access-control/deals/{dealId}/shares/{shareId} | Tenant scoped | Delete or revoke access control state. | No | apps/api/src/routes/deal-access-management.ts |
DELETE | /api/access-control/deals/{dealId}/teams/{teamId} | Tenant scoped | Delete or revoke access control state. | No | apps/api/src/routes/deal-access-management.ts |
PUT | /api/access-control/deals/{dealId}/teams/{teamId} | Tenant scoped | Replace or upsert access control configuration. | No | apps/api/src/routes/deal-access-management.ts |
GET | /api/access-control/teams | Tenant scoped | Read operational or aggregate state. | No | apps/api/src/routes/deal-access-management.ts |
POST | /api/access-control/teams | Tenant scoped | Create access control records or child resources. | No | apps/api/src/routes/deal-access-management.ts |
DELETE | /api/access-control/teams/{teamId} | Tenant scoped | Delete or revoke access control state. | No | apps/api/src/routes/deal-access-management.ts |
DELETE | /api/access-control/teams/{teamId}/members/{userId} | Tenant scoped | Delete or revoke access control state. | No | apps/api/src/routes/deal-access-management.ts |
PUT | /api/access-control/teams/{teamId}/members/{userId} | Tenant scoped | Replace or upsert access control configuration. | No | apps/api/src/routes/deal-access-management.ts |
POST | /api/assistant/chat | Tenant scoped | Create assistant records or child resources. | Yes | apps/api/src/routes/assistant.ts |
GET | /api/assistant/settings | Tenant scoped | List, search, or inspect assistant records. | Yes | apps/api/src/routes/assistant.ts |
PATCH | /api/assistant/settings | Tenant scoped | Update assistant state. | Yes | apps/api/src/routes/assistant.ts |
DELETE | /api/attachments/{attachmentId} | Tenant scoped | Delete or revoke attachments state. | Yes | apps/api/src/routes/crm-attachments.ts |
GET | /api/attachments/{attachmentId}/download | Tenant scoped | List, search, or inspect attachments records. | Yes | apps/api/src/routes/crm-attachments.ts |
POST | /api/attachments/{attachmentId}/links | Tenant scoped | Create attachments records or child resources. | Yes | apps/api/src/routes/crm-attachments.ts |
GET | /api/audit-logs | Tenant scoped | List, search, or inspect audit logs records. | Yes | apps/api/src/routes/audit-logs.ts |
GET | /api/command-center/agent-telemetry | Tenant scoped | List, search, or inspect command center records. | Yes | apps/api/src/routes/agent-telemetry.ts |
GET | /api/custom-fields | Tenant scoped | List, search, or inspect custom fields records. | Yes | apps/api/src/routes/custom-fields.ts |
POST | /api/custom-fields | Tenant scoped | Create custom fields records or child resources. | Yes | apps/api/src/routes/custom-fields.ts |
DELETE | /api/custom-fields/{id} | Tenant scoped | Delete or revoke custom fields state. | Yes | apps/api/src/routes/custom-fields.ts |
GET | /api/custom-fields/{id} | Tenant scoped | Read one custom fields record. | Yes | apps/api/src/routes/custom-fields.ts |
PATCH | /api/custom-fields/{id} | Tenant scoped | Update custom fields state. | Yes | apps/api/src/routes/custom-fields.ts |
GET | /api/custom-fields/values/{entity_type}/{entity_id} | Tenant scoped | Read one custom fields record. | Yes | apps/api/src/routes/custom-fields.ts |
PUT | /api/custom-fields/values/{entity_type}/{entity_id} | Tenant scoped | Replace or upsert custom fields configuration. | Yes | apps/api/src/routes/custom-fields.ts |
GET | /api/custom-objects | Tenant scoped | List, search, or inspect custom objects records. | No | apps/api/src/routes/custom-objects.ts |
POST | /api/custom-objects | Tenant scoped | Create custom objects records or child resources. | No | apps/api/src/routes/custom-objects.ts |
GET | /api/custom-objects/{id} | Tenant scoped | Read one custom objects record. | No | apps/api/src/routes/custom-objects.ts |
PATCH | /api/custom-objects/{id} | Tenant scoped | Update custom objects state. | No | apps/api/src/routes/custom-objects.ts |
POST | /api/custom-objects/{id}/fields | Tenant scoped | Create custom objects records or child resources. | No | apps/api/src/routes/custom-objects.ts |
PATCH | /api/custom-objects/{id}/fields/{fieldId} | Tenant scoped | Update custom objects state. | No | apps/api/src/routes/custom-objects.ts |
PATCH | /api/custom-objects/{id}/fields/reorder | Tenant scoped | Update custom objects state. | No | apps/api/src/routes/custom-objects.ts |
GET | /api/custom-objects/{id}/records | Tenant scoped | List, search, or inspect custom objects records. | Yes | apps/api/src/routes/custom-objects.ts |
POST | /api/custom-objects/{id}/records | Tenant scoped | Create custom objects records or child resources. | Yes | apps/api/src/routes/custom-objects.ts |
DELETE | /api/custom-objects/{id}/records/{recordId} | Tenant scoped | Delete or revoke custom objects state. | Yes | apps/api/src/routes/custom-objects.ts |
GET | /api/custom-objects/{id}/records/{recordId} | Tenant scoped | Read one custom objects record. | Yes | apps/api/src/routes/custom-objects.ts |
PATCH | /api/custom-objects/{id}/records/{recordId} | Tenant scoped | Update custom objects state. | Yes | apps/api/src/routes/custom-objects.ts |
GET | /api/custom-objects/{id}/records/export | Tenant scoped | List, search, or inspect custom objects records. | No | apps/api/src/routes/custom-objects.ts |
POST | /api/custom-objects/{id}/records/import | Tenant scoped | Create custom objects records or child resources. | No | apps/api/src/routes/custom-objects.ts |
GET | /api/custom-objects/active | Tenant scoped | List, search, or inspect custom objects records. | Yes | apps/api/src/routes/custom-objects.ts |
GET | /api/custom-objects/permissions | Tenant scoped | List, search, or inspect custom objects records. | No | apps/api/src/routes/custom-objects.ts |
GET | /api/health | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/health.ts |
GET | /api/health/batch-worker | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/health.ts |
POST | /api/numbering/next | Tenant scoped | Create numbering records or child resources. | Yes | apps/api/src/routes/numbering.ts |
POST | /api/numbering/override | Tenant scoped | Create numbering records or child resources. | Yes | apps/api/src/routes/numbering.ts |
GET | /api/numbering/sequences | Tenant scoped | List, search, or inspect numbering records. | Yes | apps/api/src/routes/numbering.ts |
PATCH | /api/numbering/sequences/{id} | Tenant scoped | Update numbering state. | Yes | apps/api/src/routes/numbering.ts |
GET | /api/numbering/templates | Tenant scoped | List, search, or inspect numbering records. | Yes | apps/api/src/routes/numbering.ts |
PUT | /api/numbering/templates | Tenant scoped | Replace or upsert numbering configuration. | Yes | apps/api/src/routes/numbering.ts |
POST | /api/public/mailing-list | Public | Create public records or child resources. | Yes | apps/api/src/routes/public.ts |
GET | /api/public/mailing-list/admin/export | Public | List, search, or inspect public records. | Yes | apps/api/src/routes/public.ts |
GET | /api/public/mailing-list/unsubscribe | Public | List, search, or inspect public records. | Yes | apps/api/src/routes/public.ts |
POST | /api/public/mailing-list/unsubscribe | Public | Create public records or child resources. | Yes | apps/api/src/routes/public.ts |
GET | /api/reporting-dashboards | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/reporting-dashboards.ts |
POST | /api/reporting-dashboards | Tenant scoped | Create reporting dashboards records or child resources. | Yes | apps/api/src/routes/reporting-dashboards.ts |
DELETE | /api/reporting-dashboards/{id} | Tenant scoped | Delete or revoke reporting dashboards state. | Yes | apps/api/src/routes/reporting-dashboards.ts |
GET | /api/reporting-dashboards/{id} | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/reporting-dashboards.ts |
PATCH | /api/reporting-dashboards/{id} | Tenant scoped | Update reporting dashboards state. | Yes | apps/api/src/routes/reporting-dashboards.ts |
POST | /api/reporting-dashboards/{id}/filters | Tenant scoped | Create reporting dashboards records or child resources. | No | apps/api/src/routes/reporting-dashboards.ts |
POST | /api/reporting-dashboards/{id}/tabs | Tenant scoped | Create reporting dashboards records or child resources. | No | apps/api/src/routes/reporting-dashboards.ts |
DELETE | /api/reporting-dashboards/filters/{filterId} | Tenant scoped | Delete or revoke reporting dashboards state. | No | apps/api/src/routes/reporting-dashboards.ts |
GET | /api/reporting-dashboards/manage-access | Tenant scoped | Read operational or aggregate state. | No | apps/api/src/routes/reporting-dashboards.ts |
POST | /api/reporting-dashboards/query | Tenant scoped | Create reporting dashboards records or child resources. | Yes | apps/api/src/routes/reporting-dashboards.ts |
DELETE | /api/reporting-dashboards/tabs/{tabId} | Tenant scoped | Delete or revoke reporting dashboards state. | No | apps/api/src/routes/reporting-dashboards.ts |
POST | /api/reporting-dashboards/tabs/{tabId}/widgets | Tenant scoped | Create reporting dashboards records or child resources. | No | apps/api/src/routes/reporting-dashboards.ts |
DELETE | /api/reporting-dashboards/widgets/{widgetId} | Tenant scoped | Delete or revoke reporting dashboards state. | No | apps/api/src/routes/reporting-dashboards.ts |
PUT | /api/reporting-dashboards/widgets/{widgetId} | Tenant scoped | Replace or upsert reporting dashboards configuration. | No | apps/api/src/routes/reporting-dashboards.ts |
GET | /api/tenant-health | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/tenant-health.ts |
POST | /api/workflow-hooks/{workflowId}/{token} | Tenant scoped | Create workflow hooks records or child resources. | No | apps/api/src/routes/workflow-hooks.ts |
GET | /api/workflows | Tenant scoped | List, search, or inspect workflows records. | No | apps/api/src/routes/workflows.ts |
POST | /api/workflows | Tenant scoped | Create workflows records or child resources. | No | apps/api/src/routes/workflows.ts |
PUT | /api/workflows/{id}/draft | Tenant scoped | Replace or upsert workflows configuration. | No | apps/api/src/routes/workflows.ts |
POST | /api/workflows/{id}/publish | Tenant scoped | Create workflows records or child resources. | No | apps/api/src/routes/workflows.ts |
POST | /api/workflows/{id}/retry/{runId} | Tenant scoped | Run the runId action. | No | apps/api/src/routes/workflows.ts |
POST | /api/workflows/{id}/run | Tenant scoped | Create workflows records or child resources. | No | apps/api/src/routes/workflows.ts |
POST | /api/workflows/{id}/status | Tenant scoped | Create workflows records or child resources. | No | apps/api/src/routes/workflows.ts |
GET | /api/workflows/runs | Tenant scoped | List, search, or inspect workflows records. | No | apps/api/src/routes/workflows.ts |
Imports and jobs
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
POST | /api/import/execute | Tenant scoped | Run the execute action. | Yes | apps/api/src/routes/import.ts |
POST | /api/import/execute-hubspot | Tenant scoped | Run the execute hubspot action. | Yes | apps/api/src/routes/import.ts |
GET | /api/import/history | Tenant scoped | List, search, or inspect import records. | Yes | apps/api/src/routes/import.ts |
POST | /api/import/preview | Tenant scoped | Run the preview action. | Yes | apps/api/src/routes/import.ts |
GET | /api/import/progress/{jobId} | Tenant scoped | Read one import record. | Yes | apps/api/src/routes/import.ts |
POST | /api/import/upload | Tenant scoped | Run the upload action. | Yes | apps/api/src/routes/import.ts |
GET | /api/jobs/{id} | Tenant scoped | Read one jobs record. | Yes | apps/api/src/routes/jobs.ts |
GET | /api/jobs/batch | Tenant scoped | List, search, or inspect jobs records. | Yes | apps/api/src/routes/batch-jobs.ts |
GET | /api/jobs/batch/{batchJobId} | Tenant scoped | Read one jobs record. | Yes | apps/api/src/routes/batch-jobs.ts |
POST | /api/jobs/batch/{batchJobId}/cancel | Tenant scoped | Run the cancel action. | Yes | apps/api/src/routes/batch-jobs.ts |
GET | /api/jobs/batch/{batchJobId}/stream | Tenant scoped | Stream job or progress events. | Yes | apps/api/src/index.ts |
GET | /api/jobs/side-effects/summary | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/jobs.ts |
POST | /api/pm-import/projects | Tenant scoped | Create pm import records or child resources. | Yes | apps/api/src/routes/pm-import.ts |
POST | /api/pm-import/tasks | Tenant scoped | Create pm import records or child resources. | Yes | apps/api/src/routes/pm-import.ts |
Notifications and support
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | /api/notifications | Tenant scoped | List, search, or inspect notifications records. | Yes | apps/api/src/routes/notifications.ts |
DELETE | /api/notifications/{id} | Tenant scoped | Delete or revoke notifications state. | Yes | apps/api/src/routes/notifications.ts |
POST | /api/notifications/{id}/read | Tenant scoped | Create notifications records or child resources. | Yes | apps/api/src/routes/notifications.ts |
PUT | /api/notifications/{id}/read | Tenant scoped | Replace or upsert notifications configuration. | Yes | apps/api/src/routes/notifications.ts |
POST | /api/notifications/read-all | Tenant scoped | Run the read all action. | Yes | apps/api/src/routes/notifications.ts |
PUT | /api/notifications/read-all | Tenant scoped | Replace or upsert notifications configuration. | Yes | apps/api/src/routes/notifications.ts |
GET | /api/notifications/unread-count | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/notifications.ts |
GET | /api/support/attachment-limits | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/support.ts |
GET | /api/support/tickets | Tenant scoped | List, search, or inspect support records. | Yes | apps/api/src/routes/support.ts |
POST | /api/support/tickets | Tenant scoped | Create support records or child resources. | Yes | apps/api/src/routes/support.ts |
GET | /api/support/tickets/{id} | Tenant scoped | Read one support record. | Yes | apps/api/src/routes/support.ts |
GET | /api/support/tickets/{id}/attachments | Tenant scoped | List, search, or inspect support records. | Yes | apps/api/src/routes/support.ts |
POST | /api/support/tickets/{id}/attachments | Tenant scoped | Create support records or child resources. | Yes | apps/api/src/routes/support.ts |
DELETE | /api/support/tickets/{id}/attachments/{attachmentId} | Tenant scoped | Delete or revoke support state. | Yes | apps/api/src/routes/support.ts |
GET | /api/support/tickets/{id}/attachments/{attachmentId}/download | Tenant scoped | List, search, or inspect support records. | Yes | apps/api/src/routes/support.ts |
POST | /api/support/tickets/{id}/comments | Tenant scoped | Create support records or child resources. | Yes | apps/api/src/routes/support.ts |
GET | /api/support/tickets/{id}/history | Tenant scoped | List, search, or inspect support records. | Yes | apps/api/src/routes/support.ts |
Platform admin and operations
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | /api/admin/billing/disputes | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-billing.ts |
POST | /api/admin/billing/disputes/{id}/respond | Platform admin | Create admin records or child resources. | Yes | apps/api/src/routes/admin-billing.ts |
GET | /api/admin/billing/entitlements | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-billing.ts |
GET | /api/admin/billing/orders | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-billing.ts |
GET | /api/admin/billing/orders/{id} | Platform admin | Read one admin record. | Yes | apps/api/src/routes/admin-billing.ts |
GET | /api/admin/billing/refunds | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-billing.ts |
POST | /api/admin/billing/refunds | Platform admin | Create admin records or child resources. | Yes | apps/api/src/routes/admin-billing.ts |
GET | /api/admin/billing/stats | Platform admin | Read operational or aggregate state. | Yes | apps/api/src/routes/admin-billing.ts |
GET | /api/admin/billing/subscriptions | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-billing.ts |
GET | /api/admin/ops/access | Platform admin | Read operational or aggregate state. | Yes | apps/api/src/routes/admin.ts |
GET | /api/admin/ops/config | Platform admin | Read operational or aggregate state. | Yes | apps/api/src/routes/admin-ops.ts |
GET | /api/admin/ops/enrichment | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-ops.ts |
POST | /api/admin/ops/enrichment/retry-stale | Platform admin | Run the retry stale action. | Yes | apps/api/src/routes/admin-ops.ts |
GET | /api/admin/ops/health | Platform admin | Read operational or aggregate state. | Yes | apps/api/src/routes/admin-ops.ts |
GET | /api/admin/ops/jobs | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-ops.ts |
GET | /api/admin/ops/traffic | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-ops.ts |
GET | /api/admin/settings | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-settings.ts |
DELETE | /api/admin/settings/api-key | Platform admin | Delete or revoke admin state. | Yes | apps/api/src/routes/admin-settings.ts |
PUT | /api/admin/settings/api-key | Platform admin | Replace or upsert admin configuration. | Yes | apps/api/src/routes/admin-settings.ts |
POST | /api/admin/settings/api-key/rotate | Platform admin | Create admin records or child resources. | Yes | apps/api/src/routes/admin-settings.ts |
POST | /api/admin/settings/api-key/test | Platform admin | Run the test action. | No | apps/api/src/routes/admin-settings.ts |
GET | /api/admin/stats | Platform admin | Read operational or aggregate state. | Yes | apps/api/src/routes/admin-tenants.ts |
GET | /api/admin/support/assignees | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-support.ts |
GET | /api/admin/support/attachment-limits | Platform admin | Read operational or aggregate state. | Yes | apps/api/src/routes/admin-support.ts |
GET | /api/admin/support/dashboard/kpis | Platform admin | Read operational or aggregate state. | Yes | apps/api/src/routes/admin-support.ts |
GET | /api/admin/support/queue | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-support.ts |
DELETE | /api/admin/support/tickets/{id} | Platform admin | Delete or revoke admin state. | Yes | apps/api/src/routes/admin-support.ts |
GET | /api/admin/support/tickets/{id} | Platform admin | Read one admin record. | Yes | apps/api/src/routes/admin-support.ts |
PATCH | /api/admin/support/tickets/{id}/assignment | Platform admin | Update admin state. | Yes | apps/api/src/routes/admin-support.ts |
GET | /api/admin/support/tickets/{id}/attachments | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-support.ts |
POST | /api/admin/support/tickets/{id}/attachments | Platform admin | Create admin records or child resources. | Yes | apps/api/src/routes/admin-support.ts |
DELETE | /api/admin/support/tickets/{id}/attachments/{attachmentId} | Platform admin | Delete or revoke admin state. | Yes | apps/api/src/routes/admin-support.ts |
GET | /api/admin/support/tickets/{id}/attachments/{attachmentId}/download | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-support.ts |
POST | /api/admin/support/tickets/{id}/comments | Platform admin | Create admin records or child resources. | Yes | apps/api/src/routes/admin-support.ts |
POST | /api/admin/support/tickets/{id}/notes | Platform admin | Create admin records or child resources. | Yes | apps/api/src/routes/admin-support.ts |
PATCH | /api/admin/support/tickets/{id}/status | Platform admin | Update admin state. | Yes | apps/api/src/routes/admin-support.ts |
POST | /api/admin/system/actions/invalidate-metrics-cache | Platform admin | Create admin records or child resources. | Yes | apps/api/src/routes/admin-system.ts |
POST | /api/admin/system/actions/recheck | Platform admin | Run the recheck action. | Yes | apps/api/src/routes/admin-system.ts |
POST | /api/admin/system/actions/recover-stale-enrichments | Platform admin | Run the recover stale enrichments action. | Yes | apps/api/src/routes/admin-system.ts |
GET | /api/admin/system/overview | Platform admin | Read operational or aggregate state. | Yes | apps/api/src/routes/admin-system.ts |
GET | /api/admin/tenants | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-tenants.ts |
POST | /api/admin/tenants | Platform admin | Create admin records or child resources. | Yes | apps/api/src/routes/admin-tenants.ts |
DELETE | /api/admin/tenants/{id} | Platform admin | Delete or revoke admin state. | Yes | apps/api/src/routes/admin-tenants.ts |
GET | /api/admin/tenants/{id} | Platform admin | Read one admin record. | Yes | apps/api/src/routes/admin-tenants.ts |
GET | /api/admin/tenants/{id}/audit-log | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-tenants.ts |
GET | /api/admin/tenants/{id}/invites | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-tenants.ts |
GET | /api/admin/tenants/{id}/licenses | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-tenants.ts |
PATCH | /api/admin/tenants/{id}/licenses | Platform admin | Update admin state. | Yes | apps/api/src/routes/admin-tenants.ts |
GET | /api/admin/tenants/{id}/members | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-tenants.ts |
POST | /api/admin/tenants/{id}/members | Platform admin | Create admin records or child resources. | Yes | apps/api/src/routes/admin-tenants.ts |
PATCH | /api/admin/tenants/{id}/members/{userId}/license | Platform admin | Update admin state. | Yes | apps/api/src/routes/admin-tenants.ts |
GET | /api/admin/tenants/{id}/settings | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-tenants.ts |
GET | /api/admin/tenants/{id}/usage | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-tenants.ts |
GET | /api/admin/users | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-users.ts |
DELETE | /api/admin/users/{id} | Platform admin | Delete or revoke admin state. | Yes | apps/api/src/routes/admin-users.ts |
GET | /api/admin/users/{id} | Platform admin | Read one admin record. | Yes | apps/api/src/routes/admin-users.ts |
PATCH | /api/admin/users/{id} | Platform admin | Update admin state. | Yes | apps/api/src/routes/admin-users.ts |
GET | /api/admin/users/{id}/activity | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-users.ts |
PATCH | /api/admin/users/{id}/disable | Platform admin | Update admin state. | Yes | apps/api/src/routes/admin-users.ts |
GET | /api/admin/users/{id}/invite-link | Platform admin | List, search, or inspect admin records. | Yes | apps/api/src/routes/admin-users.ts |
POST | /api/admin/users/{id}/resend-setup | Platform admin | Run the resend setup action. | Yes | apps/api/src/routes/admin-users.ts |
Relationship intelligence, mission control, and outcomes
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | /api/relationship-mission-control/signals | Tenant scoped | List, search, or inspect relationship mission control records. | Yes | apps/api/src/routes/relationship-mission-control.ts |
GET | /api/relationship-outcomes | Tenant scoped | List, search, or inspect relationship outcomes records. | Yes | apps/api/src/routes/relationship-outcomes.ts |
POST | /api/relationship-outcomes | Tenant scoped | Create relationship outcomes records or child resources. | Yes | apps/api/src/routes/relationship-outcomes.ts |
DELETE | /api/relationship-outcomes/{id} | Tenant scoped | Delete or revoke relationship outcomes state. | Yes | apps/api/src/routes/relationship-outcomes.ts |
GET | /api/relationship-outcomes/{id} | Tenant scoped | Read one relationship outcomes record. | Yes | apps/api/src/routes/relationship-outcomes.ts |
PATCH | /api/relationship-outcomes/{id} | Tenant scoped | Update relationship outcomes state. | Yes | apps/api/src/routes/relationship-outcomes.ts |
POST | /api/relationship-outcomes/{id}/confirm | Tenant scoped | Create relationship outcomes records or child resources. | Yes | apps/api/src/routes/relationship-outcomes.ts |
POST | /api/relationship-outcomes/{id}/promote | Tenant scoped | Create relationship outcomes records or child resources. | Yes | apps/api/src/routes/relationship-outcomes.ts |
Rooms and public room collaboration
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | /api/rooms | Tenant scoped | List, search, or inspect rooms records. | Yes | apps/api/src/routes/rooms.ts |
POST | /api/rooms | Tenant scoped | Create rooms records or child resources. | Yes | apps/api/src/routes/rooms.ts |
DELETE | /api/rooms/{id} | Tenant scoped | Delete or revoke rooms state. | Yes | apps/api/src/routes/rooms.ts |
GET | /api/rooms/{id} | Tenant scoped | Read one rooms record. | Yes | apps/api/src/routes/rooms.ts |
PATCH | /api/rooms/{id} | Tenant scoped | Update rooms state. | Yes | apps/api/src/routes/rooms.ts |
POST | /api/rooms/{id}/comments | Tenant scoped | Create rooms records or child resources. | Yes | apps/api/src/routes/rooms.ts |
POST | /api/rooms/{id}/events | Tenant scoped | Create rooms records or child resources. | Yes | apps/api/src/routes/rooms.ts |
POST | /api/rooms/{id}/items | Tenant scoped | Create rooms records or child resources. | Yes | apps/api/src/routes/rooms.ts |
DELETE | /api/rooms/{id}/items/{itemId} | Tenant scoped | Delete or revoke rooms state. | Yes | apps/api/src/routes/rooms.ts |
PATCH | /api/rooms/{id}/items/{itemId} | Tenant scoped | Update rooms state. | Yes | apps/api/src/routes/rooms.ts |
POST | /api/rooms/demo | Tenant scoped | Create rooms records or child resources. | Yes | apps/api/src/routes/rooms.ts |
GET | /api/rooms/public/{token} | Public | Read one rooms record. | Yes | apps/api/src/routes/rooms.ts |
POST | /api/rooms/public/{token}/signing-link | Public | Create rooms records or child resources. | Yes | apps/api/src/routes/rooms.ts |
Settings, credentials, and API access
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | /api/settings/agents | Tenant scoped | List, search, or inspect settings records. | Yes | apps/api/src/routes/agent-credentials.ts |
POST | /api/settings/agents | Tenant scoped | Create settings records or child resources. | Yes | apps/api/src/routes/agent-credentials.ts |
POST | /api/settings/agents/{agentId}/revoke | Tenant scoped | Create settings records or child resources. | Yes | apps/api/src/routes/agent-credentials.ts |
POST | /api/settings/agents/{agentId}/tokens | Tenant scoped | Create settings records or child resources. | Yes | apps/api/src/routes/agent-credentials.ts |
POST | /api/settings/agents/{agentId}/tokens/{tokenId}/revoke | Tenant scoped | Create settings records or child resources. | Yes | apps/api/src/routes/agent-credentials.ts |
GET | /api/settings/api-access | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/agent-credentials.ts |
POST | /api/settings/api-access | Tenant scoped | Create settings records or child resources. | Yes | apps/api/src/routes/agent-credentials.ts |
POST | /api/settings/api-access/{agentId}/revoke | Tenant scoped | Create settings records or child resources. | Yes | apps/api/src/routes/agent-credentials.ts |
POST | /api/settings/api-access/{agentId}/tokens | Tenant scoped | Create settings records or child resources. | Yes | apps/api/src/routes/agent-credentials.ts |
POST | /api/settings/api-access/{agentId}/tokens/{tokenId}/revoke | Tenant scoped | Create settings records or child resources. | Yes | apps/api/src/routes/agent-credentials.ts |
GET | /api/settings/api-keys | Tenant scoped | List, search, or inspect settings records. | Yes | apps/api/src/routes/api-keys.ts |
DELETE | /api/settings/api-keys/{provider} | Tenant scoped | Delete or revoke settings state. | Yes | apps/api/src/routes/api-keys.ts |
PUT | /api/settings/api-keys/{provider} | Tenant scoped | Replace or upsert settings configuration. | Yes | apps/api/src/routes/api-keys.ts |
GET | /api/settings/enterprise-identity | Tenant scoped | List, search, or inspect settings records. | Yes | apps/api/src/routes/enterprise-identity.ts |
PUT | /api/settings/enterprise-identity/break-glass | Tenant scoped | Replace or upsert settings configuration. | Yes | apps/api/src/routes/enterprise-identity.ts |
POST | /api/settings/enterprise-identity/email-domains | Tenant scoped | Create settings records or child resources. | Yes | apps/api/src/routes/enterprise-identity.ts |
DELETE | /api/settings/enterprise-identity/email-domains/{id} | Tenant scoped | Delete or revoke settings state. | Yes | apps/api/src/routes/enterprise-identity.ts |
PATCH | /api/settings/enterprise-identity/email-domains/{id} | Tenant scoped | Update settings state. | Yes | apps/api/src/routes/enterprise-identity.ts |
POST | /api/settings/enterprise-identity/email-domains/{id}/verify | Tenant scoped | Create settings records or child resources. | Yes | apps/api/src/routes/enterprise-identity.ts |
PUT | /api/settings/enterprise-identity/invite-policy | Tenant scoped | Replace or upsert settings configuration. | Yes | apps/api/src/routes/enterprise-identity.ts |
POST | /api/settings/enterprise-identity/providers | Tenant scoped | Create settings records or child resources. | Yes | apps/api/src/routes/enterprise-identity.ts |
DELETE | /api/settings/enterprise-identity/providers/{id} | Tenant scoped | Delete or revoke settings state. | Yes | apps/api/src/routes/enterprise-identity.ts |
PUT | /api/settings/enterprise-identity/providers/{id} | Tenant scoped | Replace or upsert settings configuration. | Yes | apps/api/src/routes/enterprise-identity.ts |
PUT | /api/settings/enterprise-identity/providers/{id}/enabled | Tenant scoped | Replace or upsert settings configuration. | Yes | apps/api/src/routes/enterprise-identity.ts |
POST | /api/settings/enterprise-identity/providers/{id}/test | Tenant scoped | Run the test action. | Yes | apps/api/src/routes/enterprise-identity.ts |
POST | /api/settings/enterprise-identity/workspace-domains | Tenant scoped | Create settings records or child resources. | Yes | apps/api/src/routes/enterprise-identity.ts |
DELETE | /api/settings/enterprise-identity/workspace-domains/{id} | Tenant scoped | Delete or revoke settings state. | Yes | apps/api/src/routes/enterprise-identity.ts |
POST | /api/settings/enterprise-identity/workspace-domains/{id}/verify | Tenant scoped | Create settings records or child resources. | Yes | apps/api/src/routes/enterprise-identity.ts |
GET | /api/settings/models | Tenant scoped | List, search, or inspect settings records. | Yes | apps/api/src/routes/model-settings.ts |
PATCH | /api/settings/models | Tenant scoped | Update settings state. | Yes | apps/api/src/routes/model-settings.ts |
GET | /api/settings/models/user | Tenant scoped | List, search, or inspect settings records. | Yes | apps/api/src/routes/model-settings.ts |
PATCH | /api/settings/models/user | Tenant scoped | Update settings state. | Yes | apps/api/src/routes/model-settings.ts |
Tenants, users, roles, and profile
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
GET | /api/profile | Tenant scoped | List, search, or inspect profile records. | Yes | apps/api/src/routes/profile.ts |
PUT | /api/profile | Tenant scoped | Replace or upsert profile configuration. | Yes | apps/api/src/routes/profile.ts |
GET | /api/profile/{userId} | Tenant scoped | Read one profile record. | Yes | apps/api/src/routes/profile.ts |
GET | /api/profile/hidden-features | Tenant scoped | List, search, or inspect profile records. | Yes | apps/api/src/routes/profile.ts |
PUT | /api/profile/hidden-features | Tenant scoped | Replace or upsert profile configuration. | Yes | apps/api/src/routes/profile.ts |
GET | /api/profile/team/list | Tenant scoped | List, search, or inspect profile records. | Yes | apps/api/src/routes/profile.ts |
GET | /api/roles | Tenant scoped | List, search, or inspect roles records. | Yes | apps/api/src/routes/roles.ts |
POST | /api/roles | Tenant scoped | Create roles records or child resources. | Yes | apps/api/src/routes/roles.ts |
DELETE | /api/roles/{id} | Tenant scoped | Delete or revoke roles state. | Yes | apps/api/src/routes/roles.ts |
GET | /api/roles/{id} | Tenant scoped | Read one roles record. | Yes | apps/api/src/routes/roles.ts |
PATCH | /api/roles/{id} | Tenant scoped | Update roles state. | Yes | apps/api/src/routes/roles.ts |
GET | /api/roles/{id}/permissions | Tenant scoped | List, search, or inspect roles records. | Yes | apps/api/src/routes/roles.ts |
GET | /api/team/activity | Tenant scoped | List, search, or inspect team records. | Yes | apps/api/src/routes/team.ts |
GET | /api/team/stats | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/team.ts |
GET | /api/tenants/{id} | Tenant scoped | Read one tenants record. | Yes | apps/api/src/routes/tenants.ts |
PATCH | /api/tenants/{id} | Tenant scoped | Update tenants state. | Yes | apps/api/src/routes/tenants.ts |
GET | /api/tenants/{id}/ai-providers | Tenant scoped | List, search, or inspect tenants records. | Yes | apps/api/src/routes/tenants.ts |
GET | /api/tenants/{id}/ai-providers/custom | Tenant scoped | List, search, or inspect tenants records. | Yes | apps/api/src/routes/tenants.ts |
POST | /api/tenants/{id}/ai-providers/custom | Tenant scoped | Create tenants records or child resources. | Yes | apps/api/src/routes/tenants.ts |
DELETE | /api/tenants/{id}/ai-providers/custom/{providerId} | Tenant scoped | Delete or revoke tenants state. | Yes | apps/api/src/routes/tenants.ts |
PATCH | /api/tenants/{id}/ai-providers/custom/{providerId} | Tenant scoped | Update tenants state. | Yes | apps/api/src/routes/tenants.ts |
POST | /api/tenants/{id}/ai-providers/custom/{providerId}/test | Tenant scoped | Run the test action. | Yes | apps/api/src/routes/tenants.ts |
POST | /api/tenants/{id}/ai-providers/custom/test | Tenant scoped | Run the test action. | Yes | apps/api/src/routes/tenants.ts |
GET | /api/tenants/{id}/api-keys | Tenant scoped | List, search, or inspect tenants records. | Yes | apps/api/src/routes/tenants.ts |
PUT | /api/tenants/{id}/api-keys | Tenant scoped | Replace or upsert tenants configuration. | Yes | apps/api/src/routes/tenants.ts |
GET | /api/tenants/{id}/dossier-config | Tenant scoped | Read operational or aggregate state. | Yes | apps/api/src/routes/tenants.ts |
PUT | /api/tenants/{id}/dossier-config | Tenant scoped | Replace or upsert tenants configuration. | Yes | apps/api/src/routes/tenants.ts |
GET | /api/tenants/{id}/enrichment-usage | Tenant scoped | List, search, or inspect tenants records. | Yes | apps/api/src/routes/tenants.ts |
GET | /api/tenants/{id}/features | Tenant scoped | List, search, or inspect tenants records. | Yes | apps/api/src/routes/tenants.ts |
PUT | /api/tenants/{id}/features | Tenant scoped | Replace or upsert tenants configuration. | Yes | apps/api/src/routes/tenants.ts |
GET | /api/tenants/{id}/features/audit | Tenant scoped | List, search, or inspect tenants records. | Yes | apps/api/src/routes/tenants.ts |
GET | /api/tenants/{id}/invites | Tenant scoped | List, search, or inspect tenants records. | Yes | apps/api/src/routes/tenants.ts |
GET | /api/tenants/{id}/licenses | Tenant scoped | List, search, or inspect tenants records. | Yes | apps/api/src/routes/tenants.ts |
PATCH | /api/tenants/{id}/licenses | Tenant scoped | Update tenants state. | Yes | apps/api/src/routes/tenants.ts |
POST | /api/tenants/{id}/licenses/purchase | Tenant scoped | Create tenants records or child resources. | Yes | apps/api/src/routes/tenants.ts |
GET | /api/tenants/{id}/members | Tenant scoped | List, search, or inspect tenants records. | Yes | apps/api/src/routes/tenants.ts |
DELETE | /api/tenants/{id}/members/{userId} | Tenant scoped | Delete or revoke tenants state. | Yes | apps/api/src/routes/tenants.ts |
PATCH | /api/tenants/{id}/members/{userId} | Tenant scoped | Update tenants state. | Yes | apps/api/src/routes/tenants.ts |
PATCH | /api/tenants/{id}/members/{userId}/disable | Tenant scoped | Update tenants state. | Yes | apps/api/src/routes/tenants.ts |
PATCH | /api/tenants/{id}/members/{userId}/enable | Tenant scoped | Update tenants state. | Yes | apps/api/src/routes/tenants.ts |
POST | /api/tenants/{id}/members/{userId}/resend-setup | Tenant scoped | Run the resend setup action. | Yes | apps/api/src/routes/tenants.ts |
GET | /api/users | Tenant scoped | List, search, or inspect users records. | Yes | apps/api/src/routes/users.ts |
GET | /api/users/{id} | Tenant scoped | Read one users record. | Yes | apps/api/src/routes/users.ts |
GET | /api/users/{id}/activities | Tenant scoped | List, search, or inspect users records. | Yes | apps/api/src/routes/users.ts |
POST | /api/users/avatar | Tenant scoped | Create users records or child resources. | Yes | apps/api/src/routes/users.ts |
DELETE | /api/users/me | Tenant scoped | Delete or revoke users state. | Yes | apps/api/src/routes/users.ts |
PATCH | /api/users/me/byob | Tenant scoped | Update users state. | Yes | apps/api/src/routes/users.ts |
GET | /api/users/me/export | Tenant scoped | List, search, or inspect users records. | Yes | apps/api/src/routes/users-export.ts |
Webhooks and signing
| Method | Path | Audience | Capability | OpenAPI | Source |
|---|---|---|---|---|---|
POST | /api/signing/artifacts/purge | Tenant scoped | Create signing records or child resources. | Yes | apps/api/src/routes/signing.ts |
GET | /api/signing/documents | Tenant scoped | List, search, or inspect signing records. | Yes | apps/api/src/routes/signing.ts |
POST | /api/signing/documents | Tenant scoped | Create signing records or child resources. | Yes | apps/api/src/routes/signing.ts |
GET | /api/signing/documents/{id} | Tenant scoped | Read one signing record. | Yes | apps/api/src/routes/signing.ts |
GET | /api/signing/documents/{id}/artifacts/{kind}/download | Tenant scoped | List, search, or inspect signing records. | Yes | apps/api/src/routes/signing.ts |
POST | /api/signing/documents/{id}/resend | Tenant scoped | Run the resend action. | Yes | apps/api/src/routes/signing.ts |
POST | /api/signing/documents/{id}/revoke | Tenant scoped | Create signing records or child resources. | Yes | apps/api/src/routes/signing.ts |
POST | /api/signing/documents/{id}/send | Tenant scoped | Create signing records or child resources. | Yes | apps/api/src/routes/signing.ts |
GET | /api/signing/templates | Tenant scoped | List, search, or inspect signing records. | Yes | apps/api/src/routes/signing.ts |
POST | /api/signing/templates | Tenant scoped | Create signing records or child resources. | Yes | apps/api/src/routes/signing.ts |
GET | /api/signing/templates/{id} | Tenant scoped | Read one signing record. | Yes | apps/api/src/routes/signing.ts |
PATCH | /api/signing/templates/{id} | Tenant scoped | Update signing state. | Yes | apps/api/src/routes/signing.ts |
POST | /api/signing/webhooks/opensign | Signed webhook | Create signing records or child resources. | Yes | apps/api/src/index.ts |
GET | /api/webhooks | Tenant scoped | List, search, or inspect webhooks records. | Yes | apps/api/src/routes/webhooks.ts |
POST | /api/webhooks | Tenant scoped | Create webhooks records or child resources. | Yes | apps/api/src/routes/webhooks.ts |
DELETE | /api/webhooks/{id} | Tenant scoped | Delete or revoke webhooks state. | Yes | apps/api/src/routes/webhooks.ts |
PATCH | /api/webhooks/{id} | Tenant scoped | Update webhooks state. | Yes | apps/api/src/routes/webhooks.ts |
GET | /api/webhooks/{id}/deliveries | Tenant scoped | List, search, or inspect webhooks records. | Yes | apps/api/src/routes/webhooks.ts |
GET | /api/webhooks/events | Tenant scoped | List, search, or inspect webhooks records. | Yes | apps/api/src/routes/webhooks.ts |
POST | /api/webhooks/payments/{provider} | Signed webhook | Create webhooks records or child resources. | Yes | apps/api/src/routes/payment-webhooks.ts |