Qualio Documents API
The Documents API from Qualio — 12 operation(s) for documents.
Qualio Documents API is one of 11 APIs that Qualio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 26 operations across 12 paths, and defines 27 schemas. It is described by OpenAPI 3.1.0, at version 0.1.
Requests are made against a single base URL, https://api.qualio.com.
26 operations
12 paths
27 schemas
10 GET12 OPTIONS2 PATCH1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Qualio Documents API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-Api-Key (api_key).
By default, every request must be authenticated.
Paths & Operations 26
Across 12 paths, the API surfaces 26 operations — 10 GET, 12 OPTIONS, 2 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Documents 26
GET
/v1/documents/document/{documentId}
Retrieve a document
/v1/documents/document/{documentId}
Retrieves a single document version by its numeric id, with full details including title, status, version, owner, reviewers/approvers, and tags. In Qualio, each version of a document has its own nume…
PATCH
/v1/documents/document/{documentId}
Update document people and tags
GET
/v1/documents/document/{documentId}/content
Retrieve document content
/v1/documents/document/{documentId}/content
Retrieves the section content of a specific document version, identified by its numeric id. Content is returned per section (each with a title and HTML body). Use GET /v1/documents/document/{document…
PATCH
/v1/documents/document/{documentId}/content
Update document content
PUT
/v1/documents/document/{documentId}/status
Change document status
/v1/documents/document/{documentId}/status
Advances or reverts the lifecycle status of a document. The document must be accessible to the API key's user. The transition must be valid for the document's current status. Invalid transitions are…
GET
/v1/documents/document/{documentId}/versions
List document versions by ID
/v1/documents/document/{documentId}/versions
Lists every version of a document, identified by the numeric id of any one of its versions, sorted newest version first. All versions of a document share the same code (e.g. SOP-1) but each has its o…
GET
/v1/documents/document/{documentId}/comments
List comments on a document
/v1/documents/document/{documentId}/comments
Lists the comment and suggestion threads on a document version, identified by its numeric id. Each thread includes its status (Open, Resolved, Removed, Accepted, or Rejected), the commented-on conten…
GET
/v1/documents/document/code/{code}/versions
List document versions by code
/v1/documents/document/code/{code}/versions
Lists every version of a document, identified by its document code (e.g. SOP-1, POL-42), sorted newest version first. The code is shared across all versions of a document; each version has its own id…
GET
/v1/documents/query
Query documents
/v1/documents/query
Queries documents across your Qualio instance, returning a light summary of each (code, title, status, version, owner, etc.). Filter by document status (draft, forreview, forapproval, approved, effec…
GET
/v1/documents/templates
List document templates
/v1/documents/templates
Lists all active document templates for your instance. A document template defines a document type â its section structure and the code prefix used to generate document codes (e.g. an 'SOP' templat…
GET
/v1/documents/templates/{templateId}
Retrieve a document template
/v1/documents/templates/{templateId}
Retrieves a single document template by id. A document template defines a document type, its section structure, and the code prefix used for documents created from it.
GET
/v1/documents/templates/{templateId}/content
Retrieve template content
/v1/documents/templates/{templateId}/content
Retrieves the section structure and default content of a document template, including each section's title and position. Use these positions when supplying section content to create or update a docum…
GET
/v1/documents/attachments/{id}
Retrieve an attachment
/v1/documents/attachments/{id}
Retrieves metadata for a single attachment by its numeric id. Pass download=true as a query parameter to trigger a file download instead of returning JSON metadata. When downloading, also send Accept…
POST
/v1/documents/document
Create a draft document
/v1/documents/document
Creates a new draft document. The template (via its templatematrixid) determines the document type and its section structure. The document is created in draft status; use the change-status endpoint t…
Schemas 27
The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are documentDetailed (19 properties), documentStatusChangeResponse (14 properties), createDocumentResponse (14 properties), createDocumentPayload (8 properties). Each schema is shown below with its type and property counts.
generic404
A generic response when a resource can't be found
attachmentId
number
A unique identifier for an attachment
updateDocumentContentPayload
object
A partial update to the HTML section content of a draft document. Only sections included in the request are modified; all other sections retain their existing…
1 property
1 required
documentContentResponse
object
The content of a particular Qualio document version
1 property
1 required
documentStatusChangeResponse
object
The document with its updated status and key metadata, confirming the transition completed
14 properties
14 required
offsetParam
number
A start point for the batch to be returned. For example, a value of 5 will start at the 6th element in the overall population
limitParam
number
The maximum number of results to return. This is typically used with offset to paginate results.
genericBadRequest400ParametersResponse
object
2 properties
2 required
updateDocumentPayload
object
A partial update to the people and tags on a draft document. Supply only the fields you want to change â omitted fields are left unchanged. Each supplied lis…
5 properties
createDocumentPayload
object
A request to create a new draft document. The template matrix id determines the type of the document created. Section positions start at 1, and the number of s…
8 properties
5 required
attachment
object
Metadata for a Qualio attachment
4 properties
4 required
documentTemplatesQueryResponse
object
A list of document templates
2 properties
2 required
documentCommentsResponse
object
The comment threads on a Qualio document version
2 properties
2 required
documentVersionsResponse
object
All versions of a Qualio document, with a summary of each version
2 properties
2 required
documentTemplateContentResponse
object
The content of a document template
1 property
1 required
documentTemplateResponse
object
A document template
5 properties
5 required
documentDetailed
object
A Qualio document version, with additional details
19 properties
19 required
documentId
number
A unique identifier for a document version
documentSummaryResponse
object
A summary of the main attributes of a Qualio document version
2 properties
2 required
throttledResponse
object
1 property
1 required
changeDocumentStatusPayload
object
A request to advance or revert the lifecycle status of a draft document.
2 properties
1 required
createDocumentResponse
object
The newly created draft document, including its generated identifiers (documentid, code) and url
14 properties
14 required
genericForbiddenResponse
object
1 property
1 required
genericBadRequest400PathResponse
object
2 properties
2 required
documentCode
string
A unique code identifier for a document (e.g. SOP-1, POL-42)
documentStatus
string
The different states of a document in Qualio
genericBadRequestResponse
object
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Qualio 10
Other APIs Qualio publishes across the network.
Qualio Audit Trail API
Qualio Change Management API
Qualio Compliance Intelligence API
Qualio Design Controls API
Qualio Events API
Qualio Resource Library API
Qualio Suppliers API
Qualio Tags API
Qualio Training API
Qualio User Management API
#Documents