Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Capmo Project Documents API

The Project Documents API from Capmo — 4 operation(s) for project documents.

Capmo Project Documents API is one of 23 APIs that Capmo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Project Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://api.capmo.de.

10 operations 4 paths 8 schemas 2 DELETE4 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.capmo.de/api/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Capmo Project Documents API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (CapmoAuth).

  • CapmoAuth — For authentication, use the custom prefix followed by a space and then your API key. Example: "Capmo YOURAPIKEY".

Paths & Operations 10

Across 4 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Project Documents 10
POST
/api/v1/projects/{projectId}/document-files
This can be used to create a new project document. This must be called after obtaining an upload URL.
createProjectDocument 2 params body → 200400401403404409500
GET
/api/v1/projects/{projectId}/document-files
This can be used to list all project documents in a paginated response.
getProjectDocumentsPaginated 6 params → 200400401403404409500
GET
/api/v1/projects/{projectId}/document-files/{fileId}
This can be used to get a single project document.
getProjectDocument 3 params → 200400401403404409500
PATCH
/api/v1/projects/{projectId}/document-files/{fileId}
This can be used to rename a specific project document by its ID.
renameDocument 3 params body → 200400401403404409500
DELETE
/api/v1/projects/{projectId}/document-files/{fileId}
This can be used to delete a project document.
deleteProjectDocument 3 params → 200400401403404409500
GET
/api/v1/projects/{projectId}/document-folders
This can be used to list all project document folders in a paginated response.
getProjectDocumentFolders 10 params → 200400401403404409500
POST
/api/v1/projects/{projectId}/document-folders
This can be used to create a new project document folder.
createProjectDocumentFolder 2 params body → 201400401403404409500
GET
/api/v1/projects/{projectId}/document-folders/{folderId}
This can be used to retrieve a specific project document folder by its ID.
getProjectDocumentFolder 3 params → 200400401403404409500
PATCH
/api/v1/projects/{projectId}/document-folders/{folderId}
This can be used to rename a project document folder.
renameProjectDocumentFolder 3 params body → 400401403404409500
DELETE
/api/v1/projects/{projectId}/document-folders/{folderId}
This can be used to delete a project document folder.
deleteProjectDocumentFolder 3 params → 400401403404409500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ReadDocumentWithSignedUrlDto (13 properties), ReadDocumentDto (12 properties), ReadDocumentFolderDto (8 properties), FileCreateInputDto (6 properties). Each schema is shown below with its type and property counts.

ReadDocumentFolderDto
object
8 properties 7 required
PaginatedOutputDto
object
3 properties 3 required
FileCreateInputDto
object
6 properties 2 required
ReadDocumentDto
object
12 properties 11 required
ReadDocumentWithSignedUrlDto
object
13 properties 12 required
RenameDocumentFolderDto
object
1 property 1 required
CreateDocumentFolderDto
object
3 properties 2 required
RenameDocumentDto
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

capmo-project-documents-api-openapi.yml Raw ↑

Other APIs Capmo publishes across the network.

Capmo Organisation Companies API
Capmo Organisation Memberships API
Capmo Organisation People API
Capmo Organisation Projects API
Capmo Other API
Capmo Project Change Orders API
Capmo Project Companies API
Capmo Project Memberships API
Capmo Project People API
Capmo Project Permission Sets API
Capmo Project Plans API
Capmo Project Room Listings API