OpenProject Documents API
A document is a file containing a list of attachments.*Please note, that the endpoint is only a stub for now.*## ActionsNone yet## Linked Properties| Link | Description | Type | Constraints | Supported operations | Condition || :-----------: | ------------------------------------- | ------------- | --------------------- | -------------------- | ----------------------------------------- || self | This document | Document | not null | READ | || project | The project the document is in | Project | not null | READ / WRITE | || attachments | The attachments belonging to the document | []Attachment | not null | READ / WRITE | |## Local Properties| Property | Description | Type | Constraints | Supported operations | Condition || :----------: | --------------------------------------------------------- | -------- | ---------------------------------------------------- | -------------------- | ----------------------------------------------------------- || id | Document's id | Integer | x > 0 | READ | || title | The title chosen for the collection of documents | String | max 60 characters | READ | || description | A text describing the documents | String | | READ | || createdAt | The time the document was created at | DateTime | | READ | |
OpenProject Documents API is one of 62 APIs that OpenProject 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 and API documentation.
This API exposes 3 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.2, at version 3.
Requests are made against 3 base URLs: https://qa.openproject-edge.com, https://qa.openproject-stage.com, https://community.openproject.org.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
OpenProject Documents API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.
A document is a file containing a list of attachments. Please note, that the endpoint is only a stub for now. Actions None yet Linked Properties | Link | Description | Type | Cons…
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Link (7 properties), DocumentModel (5 properties), ErrorResponse (4 properties), Formattable (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from OpenProject 12
Other APIs OpenProject publishes across the network.
This is an independent, third-party profile of OpenProject 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.