Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/juescoryisus/QualityDocD/llms.txt

Use this file to discover all available pages before exploring further.

The dashboard endpoints give a quick operational overview of document activity within a tenant. GET /dashboard/summary returns aggregate counts across document version statuses, while GET /dashboard/recent returns the ten most recently created documents. Both endpoints are company-scoped by default — only a SUPER_ADMIN token bypasses the tenant filter and sees data across all companies.
Both endpoints are accessible to any authenticated user regardless of role. No additional role check is applied beyond the bearer token requirement.

GET /dashboard/summary

Returns the total number of document records and a breakdown of version counts by status for the authenticated company. Authentication: Bearer token required.

Request headers

Authorization
string
required
Bearer <token> — JWT issued by POST /auth/login.

Response — 200 OK

total
number
Total number of document records belonging to the company. For SUPER_ADMIN, this is the count across all companies.
byStatus
object
Breakdown of document version counts by status. A single document can have multiple versions; each version contributes independently to these counts.

Example

curl -X GET http://localhost:5000/dashboard/summary \
  -H "Authorization: Bearer <token>"

GET /dashboard/recent

Returns the 10 most recently created documents for the authenticated company, ordered by createdAt descending. Use this endpoint to populate a “recent activity” feed or a quick-access document list on the dashboard home screen. Authentication: Bearer token required.

Request headers

Authorization
string
required
Bearer <token> — JWT issued by POST /auth/login.

Response — 200 OK

An array of up to 10 document objects. The array is empty if the company has no documents.
[]
array
List of document objects ordered by createdAt descending.

Example

curl -X GET http://localhost:5000/dashboard/recent \
  -H "Authorization: Bearer <token>"

SUPER_ADMIN scope

When the token belongs to a SUPER_ADMIN, both endpoints remove the company-scoping filter entirely:
  • GET /dashboard/summary returns totals and version status counts across all companies in the system.
  • GET /dashboard/recent returns the 10 most recently created documents across all companies — each result still includes companyId so you can identify which tenant it belongs to.
All other roles see only data belonging to their own company, as determined by the companyId claim in the JWT.

Build docs developers (and LLMs) love