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 Uploads API

The Uploads API from Capmo — 3 operation(s) for uploads.

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

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

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

3 operations 3 paths 6 schemas 3 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 Uploads 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 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Uploads 3
POST
/api/v1/upload/projects/{projectId}/document-files
This can be used to obtain an upload URL for a new project document.
getDocumentUploadUrl 2 params body → 200400401403404409500
POST
/api/v1/upload/plans
This can be used to obtain an upload URL for a new plan file.
getPlanUploadUrl 1 param body → 200400401403404409500
POST
/api/v1/upload/ticket-attachments
This can be used to obtain an upload URL for a new ticket attachment.
getTicketAttachmentUploadUrl 1 param body → 200400401403404409500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ReadTicketAttachmentUploadDto (4 properties), ReadDocumentFileUploadDto (4 properties), ReadPlanFileUploadDto (4 properties), WriteDocumentFileUploadDto (1 property). Each schema is shown below with its type and property counts.

WritePlanFileUploadDto
object
1 property 1 required
ReadPlanFileUploadDto
object
4 properties 4 required
ReadDocumentFileUploadDto
object
4 properties 4 required
ReadTicketAttachmentUploadDto
object
4 properties 4 required
WriteTicketAttachmentUploadDto
object
1 property 1 required
WriteDocumentFileUploadDto
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

capmo-uploads-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 Documents API
Capmo Project Memberships API
Capmo Project People API
Capmo Project Permission Sets API
Capmo Project Plans API