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

OpenProject Attachments API

Attachments are files that were uploaded to OpenProject. Each attachment belongs to a singlecontainer (e.g. a work package or a board message).## Actions| Link | Description | Condition ||:-------------------:|----------------------------------------------------------------------| -------------------------------------------- || delete | Deletes this attachment | **Permission**: edit on attachment container or being the author for attachments without container |## Linked Properties| Link | Description | Type | Constraints | Supported operations ||:----------------:| --------------------------------------------------- | ------------- | ----------- | -------------------- || self | This attachment | Attachment | not null | READ || container | The object (e.g. WorkPackage) housing the attachment| Anything | not null | READ || author | The user who uploaded the attachment | User | not null | READ || downloadLocation | Direct download link to the attachment | - | not null | READ |## Local Properties| Property | Description | Type | Constraints | Supported operations ||:------------:| ----------------------------------------------- | ----------- | ----------- | -------------------- || id | Attachment's id | Integer | x > 0 | READ || title | The name of the file | String | not null | READ || fileName | The name of the uploaded file | String | not null | READ || fileSize | The size of the uploaded file in Bytes | Integer | x >= 0 | READ || description | A user provided description of the file | Formattable | not null | READ || contentType | The files MIME-Type as determined by the server | String | not null | READ || digest | A checksum for the files content | Digest | not null | READ || createdAt | Time of creation | DateTime | not null | READ |

OpenProject Attachments API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Attachments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 7 paths, and defines 8 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.

13 operations 7 paths 8 schemas 1 DELETE6 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.2
API Version
3
Base URL
https://community.openproject.org/api/v3
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

OpenProject Attachments API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 13

Across 7 paths, the API surfaces 13 operations — 1 DELETE, 6 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Attachments 13

Attachments are files that were uploaded to OpenProject. Each attachment belongs to a single container (e.g. a work package or a board message). Actions | Link | Description | Con…

GET
/api/v3/activities/{id}/attachments
List attachments by activity
list_activity_attachments 1 param → 200404
POST
/api/v3/activities/{id}/attachments
Add attachment to activity
create_activity_attachment 1 param body → 200400403404406415422
POST
/api/v3/attachments
Create Attachment
create_attachment → 200400403406415422
DELETE
/api/v3/attachments/{id}
Delete attachment
delete_attachment 1 param → 204403404406415
GET
/api/v3/attachments/{id}
View attachment
view_attachment 1 param → 200404
GET
/api/v3/meetings/{id}/attachments
List attachments by meeting
List_attachments_by_meeting 1 param → 200404
POST
/api/v3/meetings/{id}/attachments
Add attachment to meeting
Add_attachment_to_meeting 1 param → 200400403404406415422
GET
/api/v3/posts/{id}/attachments
List attachments by post
List_attachments_by_post 1 param → 200404
POST
/api/v3/posts/{id}/attachments
Add attachment to post
Add_attachment_to_post 1 param → 200400403404406415422
GET
/api/v3/wiki_pages/{id}/attachments
List attachments by wiki page
List_attachments_by_wiki_page 1 param → 200404
POST
/api/v3/wiki_pages/{id}/attachments
Add attachment to wiki page
Add_attachment_to_wiki_page 1 param → 200400403404406415422
GET
/api/v3/work_packages/{id}/attachments
List attachments by work package
list_work_package_attachments 1 param → 200404
POST
/api/v3/work_packages/{id}/attachments
Create work package attachment
create_work_package_attachment 1 param → 200400403404406415422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are AttachmentModel (9 properties), Link (7 properties), CollectionModel (4 properties), ErrorResponse (4 properties). Each schema is shown below with its type and property counts.

CollectionModel
object
4 properties 4 required
AttachmentModel
object
9 properties 6 required
FileUploadForm
object
2 properties
CollectionLinks
object
1 property 1 required
Formattable
object
3 properties 1 required
Link
object
7 properties 1 required
Attachments_Model
ErrorResponse
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openproject-attachments-api-openapi.yml Raw ↑

Other APIs OpenProject publishes across the network.

OpenProject Actions & Capabilities API
OpenProject Activities API
OpenProject Budgets API
OpenProject Categories API
OpenProject Collections API
OpenProject Configuration API
OpenProject Custom actions API
OpenProject Custom Field Items API
OpenProject Custom Fields API
OpenProject Custom Options API
OpenProject Documents API
OpenProject EmojiReactions API
Where this information came from

This is an independent, third-party profile of OpenProject Attachments 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.