https://app.docbrilliant.com|Format: JSON|382 endpointsAuthentication
X-Service-API-Key headerAuthorization: Bearer tokenAuthentication
11 endpointsEndpoints for user authentication, session management, and token exchange. DocBrilliant uses Azure AD (Microsoft SSO) with JWT session cookies.
/api/auth/sso-exchangeExchange SSO token for session
/api/auth/token-exchangeExchange authorization code for tokens
/api/auth/complete-loginComplete login redirect
/api/auth/tenant-loginInitiate tenant-scoped login
/api/auth/tenant-login/callbackTenant login callback
/api/auth/msal-sessionCreate session from MSAL token
/api/auth/app-tokenGet app-only access token
/api/auth/refreshRefresh session token
/api/auth/logoutLogout and clear session
/api/auth/rolesGet current user roles
Documents
47 endpointsCore document management endpoints for creating, reading, updating, and deleting policy documents. Supports versioning, locking, AI generation, workflow integration, and SharePoint storage.
/api/documentsList documents
/api/documentsCreate a document
/api/documents/[id]Get document by ID
/api/documents/[id]Update a document
/api/documents/[id]Soft-delete a document
/api/documents/searchAdvanced document search
/api/documents/statsGet document statistics
/api/documents/expiringGet expiring documents
/api/documents/namesGet document names lookup
/api/documents/bulkBulk create documents
/api/documents/bulkBulk update documents
/api/documents/bulkBulk delete documents
/api/documents/syncSync documents with SharePoint
/api/documents/compareCompare document versions
/api/documents/create-from-templateCreate document from template
/api/documents/create-with-fileCreate document with file upload
/api/documents/generate-aiGenerate AI description and tags
/api/documents/generate-ai-bulkBulk generate AI metadata
/api/documents/generate-contentGenerate AI document content
/api/documents/[id]/cloneClone a document
/api/documents/[id]/publishPublish a document
/api/documents/[id]/mark-finalMark document as final
/api/documents/[id]/lockLock a document
/api/documents/[id]/unlockUnlock a document
/api/documents/[id]/lock-statusGet document lock status
/api/documents/[id]/can-editCheck edit permission
/api/documents/[id]/permissionsGet document permissions
/api/documents/[id]/blobGet document file content
/api/documents/[id]/revisionsList document revisions
/api/documents/[id]/revisionsCreate a new revision
/api/documents/[id]/signaturesGet document signatures
/api/documents/[id]/submitSubmit document for approval
/api/documents/[id]/start-workflowStart document workflow
/api/documents/[id]/workflowGet active document workflow
/api/documents/[id]/workflow-templateGet matching workflow template
/api/documents/[id]/submission-packagesGet submission packages
/api/documents/[id]/validateValidate document for submission
/api/documents/[id]/ai-reviewAI document review
/api/documents/[id]/checklistGet document checklist
/api/documents/[id]/checklistCreate document checklist
/api/documents/[id]/checklistUpdate document checklist
/api/documents/[id]/checklist/items/[itemId]Get checklist item
/api/documents/[id]/checklist/items/[itemId]Update checklist item
/api/documents/[id]/checklist/stakeholdersList checklist stakeholders
/api/documents/[id]/checklist/stakeholdersAdd checklist stakeholder
/api/documents/[id]/checklist/stakeholders/[stakeholderId]Update checklist stakeholder
/api/documents/[id]/checklist/stakeholders/[stakeholderId]Remove checklist stakeholder
Workflows
14 endpointsManage multi-step approval workflows for documents. Supports sequential and parallel steps, role-based assignment, delegation, and template-driven configuration.
/api/workflowsList workflows
/api/workflowsCreate a workflow
/api/workflows/[id]Get workflow by ID
/api/workflows/[id]Update a workflow
/api/workflows/[id]Cancel a workflow
/api/workflows/[id]/steps/[stepId]Get workflow step
/api/workflows/[id]/steps/[stepId]Act on a workflow step
/api/workflows/activeGet active workflows for user
/api/workflows/templatesList workflow templates
/api/workflows/templatesCreate a workflow template
/api/workflows/templates/[id]Get workflow template
/api/workflows/templates/[id]Update a workflow template
/api/workflows/templates/[id]Delete a workflow template
/api/workflows/templates/[id]/cloneClone a workflow template
Workflow Statuses
7 endpointsManage the document status definitions used throughout the workflow lifecycle. Statuses are database-driven and configurable per tenant.
/api/workflow-statusesList workflow statuses
/api/workflow-statusesCreate a workflow status
/api/workflow-statuses/[id]Get workflow status
/api/workflow-statuses/[id]Update a workflow status
/api/workflow-statuses/[id]Delete a workflow status
/api/workflow-statuses/[id]/dependenciesGet status dependencies
/api/workflow-statuses/reorderReorder workflow statuses
Approvals
3 endpointsEndpoints for querying pending approvals and generating approval summaries. Used by the Approvals page to show documents awaiting the current user's action.
/api/approvals/pendingGet pending approvals
/api/approvals/trackingTrack approval status
/api/approvals/ai-summaryGenerate AI approval summary
E-Signatures
8 endpointsElectronic signature management with DocuSign integration. Supports drawn, uploaded, and typed signatures as well as DocuSign envelope-based signing flows.
/api/esignature/statusGet e-signature configuration status
/api/esignature/testTest DocuSign connection
/api/esignature/envelopesList signing envelopes
/api/esignature/envelopesCreate a signing envelope
/api/esignature/envelopes/[envelopeId]Get envelope details
/api/esignature/envelopes/[envelopeId]Void an envelope
/api/esignature/envelopes/[envelopeId]/signGet signing URL
/api/esignature/complete-approvalComplete approval with signature
Categories
10 endpointsManage document categories (domains) such as IT, HR, HSE, Finance. Categories are used to organize documents and scope workflow templates.
/api/categoriesList categories
/api/categoriesCreate a category
/api/categories/[id]Get category by ID
/api/categories/[id]Update a category
/api/categories/[id]Delete a category
/api/categories/[id]/dependenciesGet category dependencies
/api/categories/[id]/reassignReassign category documents
/api/categories/reorderReorder categories
/api/categories/seedSeed default categories
/api/categories/syncSync categories with SharePoint
Classifications
10 endpointsManage document classification levels (e.g., Public, Internal, Confidential, Strictly Confidential). Classifications control access and handling requirements.
/api/classificationsList classifications
/api/classificationsCreate a classification
/api/classifications/[id]Get classification by ID
/api/classifications/[id]Update a classification
/api/classifications/[id]Delete a classification
/api/classifications/[id]/dependenciesGet classification dependencies
/api/classifications/[id]/reassignReassign classification documents
/api/classifications/reorderReorder classifications
/api/classifications/seedSeed default classifications
/api/classifications/syncSync classifications with SharePoint
Document Types
10 endpointsManage document type definitions (e.g., Policy, Procedure, Standard, Guideline, Manual). Types affect document numbering and workflow template matching.
/api/document-typesList document types
/api/document-typesCreate a document type
/api/document-types/[id]Get document type by ID
/api/document-types/[id]Update a document type
/api/document-types/[id]Delete a document type
/api/document-types/[id]/dependenciesGet document type dependencies
/api/document-types/[id]/reassignReassign document type documents
/api/document-types/reorderReorder document types
/api/document-types/seedSeed default document types
/api/document-types/syncSync document types with SharePoint
Document Statuses
10 endpointsManage document status definitions. Statuses track a document's lifecycle from DRAFT through workflow stages to PUBLISHED. Configurable per tenant with initial/final flags.
/api/document-statusesList document statuses
/api/document-statusesCreate a document status
/api/document-statuses/[id]Get document status by ID
/api/document-statuses/[id]Update a document status
/api/document-statuses/[id]Delete a document status
/api/document-statuses/[id]/dependenciesGet document status dependencies
/api/document-statuses/[id]/reassignReassign document status
/api/document-statuses/reorderReorder document statuses
/api/document-statuses/seedSeed default document statuses
/api/document-statuses/syncSync document statuses with SharePoint
Companies
19 endpointsManage company (entity) records within a tenant. Companies are organizational units that own documents and have associated SharePoint document libraries and logo assets.
/api/companiesList companies
/api/companiesCreate a company
/api/companies/[id]Get company by ID
/api/companies/[id]Update a company
/api/companies/[id]Delete a company
/api/companies/[id]/dependenciesGet company dependencies
/api/companies/[id]/reassignReassign company documents
/api/companies/[id]/default-workflowGet default workflow template
/api/companies/[id]/default-workflowSet default workflow template
/api/companies/[id]/document-setsList SharePoint document sets
/api/companies/[id]/document-setsCreate SharePoint document set
/api/companies/[id]/document-setsDelete SharePoint document set
/api/companies/[id]/libraryGet SharePoint library
/api/companies/[id]/libraryCreate SharePoint library
/api/companies/[id]/libraryDelete SharePoint library config
/api/companies/[id]/logoGet company logo
/api/companies/[id]/logoUpload company logo
/api/companies/[id]/logoDelete company logo
/api/companies/library-readyCheck library readiness
Tenant Management
21 endpointsEndpoints for tenant provisioning, configuration, usage tracking, billing management, and multi-tenant operations. Tenants are the top-level isolation unit in DocBrilliant.
/api/tenants/provisionProvision a new tenant
/api/tenants/check-slugCheck subdomain availability
/api/tenants/check-emailCheck email availability
/api/tenants/check-domainCheck domain availability
/api/tenant/settingsGet tenant settings
/api/tenant/settingsUpdate tenant settings
/api/tenant/trial-statusGet trial status
/api/tenant/usageGet tenant usage
/api/tenant/billingGet billing information
/api/tenant/invitationsList pending invitations
/api/tenant/invitationsSend user invitation
/api/tenant/invitationsRevoke an invitation
/api/tenant/custom-domainGet custom domain
/api/tenant/custom-domainAdd custom domain
/api/tenant/custom-domainRemove custom domain
/api/tenant/custom-domain/verifyVerify custom domain DNS
/api/tenant/sharepoint/auto-createAuto-create SharePoint site
/api/tenant/download-documentsDownload all documents
/api/tenant/exportExport tenant data
/api/tenant/alertsGet tenant alerts
/api/tenant/alertsDismiss an alert
Users
9 endpointsManage user profiles, preferences, roles, and signatures. User accounts are created automatically via SSO and scoped to a tenant.
/api/users/photo/[userId]Get user photo
/api/users/[userId]/preferencesGet user preferences
/api/users/[userId]/preferencesUpdate user preferences
/api/users/[userId]/rolesGet user roles
/api/users/[userId]/rolesAssign role to user
/api/users/[userId]/roles/[roleId]Remove role from user
/api/users/[userId]/signatureGet user signature
/api/users/[userId]/signatureSave user signature
/api/users/[userId]/signatureDelete user signature
Audit Logs
9 endpointsComprehensive audit trail system with 7-year retention. Tracks all user actions, document changes, workflow events, and system operations. Supports filtering, export, and compliance reporting.
/api/audit-logsList audit logs
/api/audit-logs/[logId]Get audit log entry
/api/audit-logs/[logId]Delete audit log entry
/api/audit-logs/recentGet recent audit logs
/api/audit-logs/summaryGet audit log summary
/api/audit-logs/document/[documentId]Get document audit trail
/api/audit-logs/user/[userId]Get user audit trail
/api/audit-logs/exportExport audit logs
/api/audit-logs/bulk-deleteBulk delete audit logs
Reports
12 endpointsReporting and analytics endpoints for document publishing metrics, compliance tracking, and performance dashboards. Supports filtering by company, department, and date range.
/api/reports/my-publishedMy published documents
/api/reports/company-publishedCompany published documents
/api/reports/department-publishedDepartment published documents
/api/reports/near-expiryNear-expiry documents
/api/reports/exportExport report data
/api/reports/filter-options/companiesGet company filter options
/api/reports/filter-options/departmentsGet department filter options
/api/reports/filter-options/domainsGet domain filter options
/api/reports/performance/publishedPublishing performance metrics
/api/reports/performance/publishing-timeAverage publishing time
/api/reports/performance/viewsDocument view analytics
/api/reports/performance/admin-logAdmin activity log
Acknowledgements
11 endpointsEmployee acknowledgement and training campaigns. Allows administrators to create campaigns that require users to read and acknowledge specific documents, optionally with quizzes.
/api/acknowledgementsList acknowledgements
/api/acknowledgementsRecord an acknowledgement
/api/acknowledgements/[id]Get acknowledgement details
/api/acknowledgements/[id]Update an acknowledgement
/api/acknowledgements/[id]Delete an acknowledgement
/api/acknowledgements/campaignsList acknowledgement campaigns
/api/acknowledgements/campaignsCreate an acknowledgement campaign
/api/acknowledgements/campaigns/[id]Get campaign details
/api/acknowledgements/campaigns/[id]Update a campaign
/api/acknowledgements/campaigns/[id]Delete a campaign
/api/acknowledgements/campaigns/[id]/launchLaunch a campaign
Admin Settings
99 endpointsPlatform administration endpoints for system settings, user management, group management, column configuration, permissions, deleted item recovery, and SharePoint management. Requires admin role.
/api/admin/settingsGet all admin settings
/api/admin/settingsUpdate admin settings
/api/admin/settings/tenantGet tenant settings
/api/admin/settings/tenantUpdate tenant settings
/api/admin/settings/securityGet security settings
/api/admin/settings/securityUpdate security settings
/api/admin/settings/sharepointGet SharePoint settings
/api/admin/settings/sharepointUpdate SharePoint settings
/api/admin/settings/docusignGet DocuSign settings
/api/admin/settings/docusignUpdate DocuSign settings
/api/admin/settings/docusign/seedSeed DocuSign templates
/api/admin/settings/databaseGet database settings
/api/admin/settings/databaseUpdate database settings
/api/admin/settings/deployment-notificationsGet deployment notification settings
/api/admin/settings/deployment-notificationsCreate deployment notification
/api/admin/settings/deployment-notificationsUpdate deployment notification
/api/admin/settings/test-connectionTest external connection
/api/admin/settings/document-number-format/previewPreview document number format
/api/admin/settings/secretsGet secret settings
/api/admin/settings/secretsUpdate secret settings
/api/admin/settings/app-configurationGet app configuration
/api/admin/settings/app-configurationUpdate app configuration
/api/admin/usersList all users
/api/admin/usersCreate a user
/api/admin/users/[userId]Get user details
/api/admin/users/[userId]Update a user
/api/admin/users/[userId]Deactivate a user
/api/admin/users/[userId]/reactivateReactivate a user
/api/admin/users/[userId]/rolesGet user roles (admin)
/api/admin/users/[userId]/rolesAssign role (admin)
/api/admin/users/[userId]/rolesRemove role (admin)
/api/admin/users/[userId]/sp-accessGrant SharePoint access
/api/admin/users/searchSearch users
/api/admin/users/statsGet user statistics
/api/admin/users/syncSync users from Azure AD
/api/admin/groupsList groups
/api/admin/groupsCreate a group
/api/admin/groups/[groupId]Get group details
/api/admin/groups/[groupId]Update a group
/api/admin/groups/[groupId]Delete a group
/api/admin/groups/[groupId]/membersList group members
/api/admin/groups/[groupId]/membersAdd group member
/api/admin/groups/[groupId]/membersRemove group member
/api/admin/groups/[groupId]/membersUpdate group member
/api/admin/groups/[groupId]/cloneClone a group
/api/admin/groups/filterFilter groups
/api/admin/groups/reorderReorder groups
/api/admin/groups/syncSync groups from Azure AD
/api/admin/columnsList column configurations
/api/admin/columnsCreate a column
/api/admin/columnsUpdate columns
/api/admin/columnsDelete a column
/api/admin/columns/syncSync columns with SharePoint
/api/admin/columns/reset-syncReset column sync
/api/admin/columns/set-essential-fieldsSet essential fields
/api/admin/document-templates/uploadUpload document template
/api/admin/checklist-itemsList checklist item templates
/api/admin/checklist-itemsCreate checklist item template
/api/admin/checklist-items/[key]Get checklist item template
/api/admin/checklist-items/[key]Update checklist item template
/api/admin/checklist-items/[key]Delete checklist item template
/api/admin/checklist-items/reorderReorder checklist items
/api/admin/app-configGet all app config
/api/admin/app-configCreate app config entry
/api/admin/app-config/[category]Get config by category
/api/admin/app-config/[category]/[key]Get config value
/api/admin/app-config/[category]/[key]Update config value
/api/admin/app-config/[category]/[key]Delete config value
/api/admin/permissionsList all permissions
/api/admin/permissionsCreate permission entry
/api/admin/permissionsUpdate permissions
/api/admin/permissions/[role]Get role permissions
/api/admin/permissions/[role]Update role permissions
/api/admin/permissions/[role]Add permission to role
/api/admin/permissions/[role]Remove permission from role
/api/admin/workflow-configGet workflow configuration
/api/admin/workflow-configUpdate workflow configuration
/api/admin/workflow-configReset workflow configuration
/api/admin/archived-documentsList archived documents
/api/admin/archived-documentsArchive/restore documents
/api/admin/deleted-itemsList deleted items
/api/admin/deleted-items/[model]/[id]/dependenciesGet deleted item dependencies
/api/admin/deleted-items/[model]/[id]/restoreRestore a deleted item
/api/admin/deleted-items/[model]/[id]/permanentPermanently delete an item
/api/admin/deleted-items/bulk-restoreBulk restore deleted items
/api/admin/deleted-items/bulk-permanent-deleteBulk permanently delete items
/api/admin/deletion-requestsList deletion requests
/api/admin/deletion-requestsCreate a deletion request
/api/admin/deletion-requests/[id]/approveApprove deletion request
/api/admin/deletion-requests/[id]/rejectReject deletion request
/api/admin/email/upload-imageUpload email template image
/api/admin/email/upload-imageDelete email template image
/api/admin/create-ai-columnsCreate AI metadata columns
/api/admin/mark-content-aiMark content as AI-generated
/api/admin/sync-owner-namesSync owner display names
/api/admin/companiesList companies (admin)
/api/admin/sharepoint/createCreate SharePoint resources
/api/admin/sharepoint/resetReset SharePoint configuration
/api/admin/sharepoint/sync-permissionsSync SharePoint permissions
Internal APIs
44 endpointsService-to-service APIs consumed by the DocBrilliant Admin dashboard. Authenticated via X-Service-API-Key header. Used for tenant management, metrics, billing sync, and system configuration.
/api/internal/healthHealth check
/api/internal/metricsPlatform metrics
/api/internal/usage-trendsUsage trend data
/api/internal/ai-statusAI service status
/api/internal/audit-logs/summaryPlatform audit summary
/api/internal/tenantsList all tenants
/api/internal/tenants/[tenantId]Get tenant details
/api/internal/tenants/[tenantId]Update tenant
/api/internal/tenants/[tenantId]Suspend a tenant
/api/internal/tenants/[tenantId]/configGet tenant configuration
/api/internal/tenants/[tenantId]/configUpdate tenant configuration
/api/internal/tenants/[tenantId]/restoreRestore a suspended tenant
/api/internal/tenants/[tenantId]/permanent-deletePermanently delete tenant
/api/internal/tenants/[tenantId]/subscriptionGet tenant subscription
/api/internal/tenants/[tenantId]/subscriptionUpdate tenant subscription
/api/internal/tenants/[tenantId]/invoicesGet tenant invoices
/api/internal/plans/syncSync plans from admin
/api/internal/settings/syncSync platform settings
/api/internal/system-configGet system configuration
/api/internal/system-configUpdate system configuration
/api/internal/workflow-configGet workflow config (internal)
/api/internal/workflow-configUpdate workflow config (internal)
/api/internal/workflow-statusesList workflow statuses (internal)
/api/internal/workflow-statusesCreate workflow status (internal)
/api/internal/workflow-statuses/[id]Get workflow status (internal)
/api/internal/workflow-statuses/[id]Update workflow status (internal)
/api/internal/workflow-statuses/[id]Delete workflow status (internal)
/api/internal/workflow-statuses/[id]/dependenciesGet status dependencies (internal)
/api/internal/workflow-statuses/reorderReorder workflow statuses (internal)
/api/internal/stripe-configGet Stripe configuration
/api/internal/stripe-configUpdate Stripe configuration
/api/internal/stripe-configTest Stripe connection
/api/internal/creem-configGet Creem configuration
/api/internal/creem-configUpdate Creem configuration
/api/internal/creem-configTest Creem connection
/api/internal/stripe/sync-planSync plan to Stripe
/api/internal/stripe/invoicesList Stripe invoices
/api/internal/stripe/revenueGet revenue metrics
/api/internal/stripe/subscriptionsList Stripe subscriptions
/api/internal/paddle/sync-planSync plan to Paddle
/api/internal/lemonsqueezy/sync-planSync plan to LemonSqueezy
/api/internal/creem/sync-planSync plan to Creem
/api/internal/custom-domainsList custom domains
/api/internal/custom-domains/[domainId]Update custom domain
Billing & Webhooks
6 endpointsWebhook receivers for payment processors and external services. These endpoints receive asynchronous notifications and update tenant billing status accordingly.
/api/billing/webhookStripe webhook
/api/billing/paddle-webhookPaddle webhook
/api/billing/lemonsqueezy-webhookLemonSqueezy webhook
/api/billing/creem-webhookCreem webhook
/api/webhooks/docusignDocuSign webhook
/api/webhooks/vercel/deploymentVercel deployment webhook
Cron Jobs
6 endpointsScheduled task endpoints triggered by system cron jobs. Authenticated via Bearer token (CRON_SECRET). Handle trial expiration, tenant cleanup, document expiry notifications, and domain verification.
/api/cron/trial-expiryProcess trial expirations
/api/cron/tenant-cleanupClean up expired tenants
/api/cron/expiry-notificationsSend document expiry notifications
/api/cron/archive-expiredArchive expired documents
/api/cron/verify-domainsVerify custom domains
/api/cron/provision-sslProvision SSL certificates
AI & Chat
4 endpointsAI-powered features including conversational document assistant, semantic search enhancement, and document insights. Powered by Claude (Anthropic) via Azure OpenAI gateway.
/api/chatAI chat (streaming)
/api/chat/documentsAI document chat
/api/search/enhanceAI-enhanced search
/api/insightsGet document insights
Configuration
12 endpointsPublic and authenticated endpoints for application configuration, health checks, plan information, and miscellaneous lookups.
/api/healthPublic health check
/api/app-configGet public app configuration
/api/configGet system configuration
/api/configUpdate system configuration
/api/config/uiGet UI configuration
/api/config/uiUpdate UI configuration
/api/config/filtersGet filter configuration
/api/plans/publicGet public plan list
/api/departmentsList departments
/api/departmentsCreate a department
/api/owner/archived-documentsGet my archived documents
/api/submission-packages/[trackingNumber]Get submission package by tracking number