Documents

Document management operations

List all documents

get

Returns all documents accessible to the authenticated user within their organization

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Responses

200

List of documents

application/json

401

Not authenticated

403

Access denied

500

Server error

get

/documents

HTTPcURLJavaScriptPython

GET /api/documents HTTP/1.1
Accept: */*

[
  {
    "id": 1,
    "name": "Q1 Financial Report.pdf",
    "description": "Quarterly financial summary",
    "type": "application/pdf",
    "url": "/uploads/documents/q1-report.pdf",
    "uploaderId": 5,
    "organizationId": 1,
    "createdAt": "2026-03-18T12:44:06.770Z",
    "uploader": {
      "id": 1,
      "username": "text",
      "fullName": "text"
    },
    "projects": [
      {
        "documentId": 1,
        "projectId": 1,
        "project": {
          "id": 1,
          "title": "text"
        }
      }
    ]
  }
]

Create a new document

post

Creates a new document record

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Body

application/json

namestringRequired

Document name

Example: Contract Draft.docx

descriptionstring · nullableOptional

Document description

typestringRequired

Document type/format

Example: application/vnd.openxmlformats-officedocument.wordprocessingml.document

urlstringRequired

URL to the document

organizationIdinteger · nullableOptional

Organization to associate with

projectIdinteger · nullableOptional

Project to link document to

Responses

200

Document created successfully

application/json

idintegerRequired

Unique document identifier

Example: 1

namestringRequired

Document name

Example: Q1 Financial Report.pdf

descriptionstring · nullableOptional

Document description

Example: Quarterly financial summary

typestringRequired

Document type/format

Example: application/pdf

urlstringRequired

URL to access the document

Example: /uploads/documents/q1-report.pdf

uploaderIdintegerRequired

User ID who uploaded the document

Example: 5

organizationIdinteger · nullableOptional

Associated organization ID

createdAtstring · date-timeRequired

Upload timestamp

400

Validation error

401

Not authenticated

403

Permission denied

500

Server error

post

/documents

HTTPcURLJavaScriptPython

POST /api/documents HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "name": "Contract Draft.docx",
  "description": "text",
  "type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
  "url": "text",
  "organizationId": 1,
  "projectId": 1
}

{
  "id": 1,
  "name": "Q1 Financial Report.pdf",
  "description": "Quarterly financial summary",
  "type": "application/pdf",
  "url": "/uploads/documents/q1-report.pdf",
  "uploaderId": 5,
  "organizationId": 1,
  "createdAt": "2026-03-18T12:44:06.770Z"
}

Update a document

patch

Updates an existing document's metadata

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

idintegerRequired

Document ID

Body

application/json

namestringOptional

descriptionstring · nullableOptional

typestringOptional

urlstringOptional

Responses

200

Document updated successfully

application/json

idintegerRequired

Unique document identifier

Example: 1

namestringRequired

Document name

Example: Q1 Financial Report.pdf

descriptionstring · nullableOptional

Document description

Example: Quarterly financial summary

typestringRequired

Document type/format

Example: application/pdf

urlstringRequired

URL to access the document

Example: /uploads/documents/q1-report.pdf

uploaderIdintegerRequired

User ID who uploaded the document

Example: 5

organizationIdinteger · nullableOptional

Associated organization ID

createdAtstring · date-timeRequired

Upload timestamp

401

Not authenticated

403

Permission denied

404

Document not found

500

Server error

patch

/documents/{id}

HTTPcURLJavaScriptPython

PATCH /api/documents/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "name": "text",
  "description": "text",
  "type": "text",
  "url": "text"
}

{
  "id": 1,
  "name": "Q1 Financial Report.pdf",
  "description": "Quarterly financial summary",
  "type": "application/pdf",
  "url": "/uploads/documents/q1-report.pdf",
  "uploaderId": 5,
  "organizationId": 1,
  "createdAt": "2026-03-18T12:44:06.770Z"
}

List documents for a project

get

Returns all documents associated with a specific project

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

projectIdintegerRequired

Project ID

Responses

200

List of project documents

application/json

401

Not authenticated

403

Access denied

500

Server error

get

/documents/{projectId}

HTTPcURLJavaScriptPython

GET /api/documents/{projectId} HTTP/1.1
Accept: */*

[
  {
    "id": 1,
    "name": "Q1 Financial Report.pdf",
    "description": "Quarterly financial summary",
    "type": "application/pdf",
    "url": "/uploads/documents/q1-report.pdf",
    "uploaderId": 5,
    "organizationId": 1,
    "createdAt": "2026-03-18T12:44:06.770Z",
    "uploader": {
      "id": 1,
      "username": "text",
      "fullName": "text"
    },
    "projects": [
      {
        "documentId": 1,
        "projectId": 1,
        "project": {
          "id": 1,
          "title": "text"
        }
      }
    ]
  }
]

Link document to project

post

Associates a document with a project

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

documentIdintegerRequired

Document ID

projectIdintegerRequired

Project ID

Responses

200

Document linked to project successfully

No content

401

Not authenticated

403

Permission denied

404

Document or project not found

500

Server error

post

/documents/{documentId}/projects/{projectId}

HTTPcURLJavaScriptPython

POST /api/documents/{documentId}/projects/{projectId} HTTP/1.1
Accept: */*

No content

Unlink document from project

delete

Removes the association between a document and a project

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

documentIdintegerRequired

Document ID

projectIdintegerRequired

Project ID

Responses

200

Document unlinked from project successfully

No content

401

Not authenticated

403

Permission denied

404

Association not found

500

Server error

delete

/documents/{documentId}/projects/{projectId}

HTTPcURLJavaScriptPython

DELETE /api/documents/{documentId}/projects/{projectId} HTTP/1.1
Accept: */*

No content

Upload a file

post

Uploads a file and returns the file URL

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Body

multipart/form-data

filestring · binaryRequired

The file to upload

Responses

200

File uploaded successfully

application/json

urlstringOptional

URL of the uploaded file

400

No file uploaded

401

Not authenticated

500

Server error

post

/upload

HTTPcURLJavaScriptPython

POST /api/upload HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "url": "text"
}