How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.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.

Specification
OpenAPI 3.2.0
API Version
0.1
Base URL
https://api.qualio.com
Authentication
API Key
Resource Areas
1

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
getDocument 1 param → 200400403404429
OPTIONS
/v1/documents/document/{documentId}
Get document options
getDocumentOptions 1 param → 200
PATCH
/v1/documents/document/{documentId}
Update document people and tags
updateDocument 1 param body → 200400403404429
GET
/v1/documents/document/{documentId}/content
Retrieve document content
getDocumentContent 1 param → 200400403404429
OPTIONS
/v1/documents/document/{documentId}/content
Get document content options
getDocumentContentOptions 1 param → 200
PATCH
/v1/documents/document/{documentId}/content
Update document content
updateDocumentContent 1 param body → 200400403404429
PUT
/v1/documents/document/{documentId}/status
Change document status
changeDocumentStatus 1 param body → 200400403404429
OPTIONS
/v1/documents/document/{documentId}/status
Change document status options
changeDocumentStatusOptions 1 param → 200
GET
/v1/documents/document/{documentId}/versions
List document versions by ID
listDocumentVersions 1 param → 200400403404429
OPTIONS
/v1/documents/document/{documentId}/versions
List document versions options
listDocumentVersionsOptions 1 param → 200
GET
/v1/documents/document/{documentId}/comments
List comments on a document
listDocumentComments 1 param → 200400403404429
OPTIONS
/v1/documents/document/{documentId}/comments
List document comments options
listDocumentCommentsOptions 1 param → 200
GET
/v1/documents/document/code/{code}/versions
List document versions by code
listDocumentVersionsByCode 1 param → 200400403404429
OPTIONS
/v1/documents/document/code/{code}/versions
List document versions by code options
listDocumentVersionsByCodeOptions 1 param → 200
GET
/v1/documents/query
Query documents
queryDocuments 3 params → 200400403429
OPTIONS
/v1/documents/query
Query documents options
queryDocumentsOptions 3 params → 200
GET
/v1/documents/templates
List document templates
listDocumentTemplates → 200403429
OPTIONS
/v1/documents/templates
List document templates options
listDocumentTemplatesOptions → 200
GET
/v1/documents/templates/{templateId}
Retrieve a document template
getDocumentTemplate 1 param → 200400403404429
OPTIONS
/v1/documents/templates/{templateId}
Get document template options
getDocumentTemplateOptions 1 param → 200
GET
/v1/documents/templates/{templateId}/content
Retrieve template content
getDocumentTemplateContent 1 param → 200400403404429
OPTIONS
/v1/documents/templates/{templateId}/content
Get document template content options
getDocumentTemplateContentOptions 1 param → 200
GET
/v1/documents/attachments/{id}
Retrieve an attachment
getAttachment 2 params → 200400403404429
OPTIONS
/v1/documents/attachments/{id}
Get attachment options
getAttachmentOptions 2 params → 200
POST
/v1/documents/document
Create a draft document
createDocument body → 200400403429
OPTIONS
/v1/documents/document
Create document options
createDocumentOptions → 200

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.

genericBadRequest400PathResponse
object
2 properties 2 required
generic404
A generic response when a resource can't be found
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
documentContentResponse
object
The content of a particular Qualio document version
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
documentCode
string
A unique code identifier for a document (e.g. SOP-1, POL-42)
documentCommentsResponse
object
The comment threads on a Qualio document version
2 properties 2 required
documentId
number
A unique identifier for a document version
attachment
object
Metadata for a Qualio attachment
4 properties 4 required
limitParam
number
The maximum number of results to return. This is typically used with offset to paginate results.
genericBadRequestResponse
object
2 properties 2 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
changeDocumentStatusPayload
object
A request to advance or revert the lifecycle status of a draft document.
2 properties 1 required
genericBadRequest400ParametersResponse
object
2 properties 2 required
createDocumentResponse
object
The newly created draft document, including its generated identifiers (documentid, code) and url
14 properties 14 required
documentTemplatesQueryResponse
object
A list of document templates
2 properties 2 required
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
documentStatusChangeResponse
object
The document with its updated status and key metadata, confirming the transition completed
14 properties 14 required
genericForbiddenResponse
object
1 property 1 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
documentTemplateContentResponse
object
The content of a document template
1 property 1 required
documentStatus
string
The different states of a document in Qualio
throttledResponse
object
1 property 1 required
documentVersionsResponse
object
All versions of a Qualio document, with a summary of each version
2 properties 2 required
documentSummaryResponse
object
A summary of the main attributes of a Qualio document version
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qualio-documents-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Qualio Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.