Capmo Projects API is one of 23 APIs that Capmo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Projects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
7 operations
across 3 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.
7 operations3 paths8 schemas2 DELETE2 GET1 PATCH1 POST1 PUT
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 Projects 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 7
Across 3 paths, the API surfaces 7 operations — 2 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Projects 7
GET
/api/v1/projects
This can be used to list all projects in a paginated response.
getProjects6 params→ 200400401403404409500
POST
/api/v1/projects
This can be used to create a new project, including creating a new project from a template. If projecttemplateid is provided, the project will be created from the template, otherwise a new blank proj…
createProject1 parambody→ 201400401403404409500
GET
/api/v1/projects/{projectId}
This can be used to retrieve a specific project by its ID.
getProject2 params→ 200400401403404409500
PATCH
/api/v1/projects/{projectId}
This can be used to update a specific project by its ID.
updateProject2 paramsbody→ 200400401403404409500
DELETE
/api/v1/projects/{projectId}
This can be used to delete a specific project by its ID.
deleteProject2 params→ 200400401403404409500
PUT
/api/v1/projects/{projectId}/archived
This can be used to archive a specific project by its ID. Archiving a project will also remove all pins associated with the project for the authenticated user.
archiveProject2 params→ 200400401403404409500
DELETE
/api/v1/projects/{projectId}/archived
This can be used to unarchive a specific project by its ID.
unarchiveProject2 params→ 200400401403404409500
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ReadProjectDto (34 properties), UpdateProjectDto (20 properties), CreateProjectDto (19 properties), PaginatedOutputDto (3 properties). Each schema is shown below with its type and property counts.
ReadProjectDto
object
34 properties33 required
CreateProjectDto
object
19 properties3 required
PaginatedOutputDto
object
3 properties3 required
ProjectContactType
string
The type of the project owner reference.
UpdateProjectDto
object
20 properties
ProjectType
string
The type of construction project.
ProjectStatus
string
The phase of the project.
BuildingType
string
The type of building being constructed.
Specification
The full machine-readable OpenAPI contract behind this narrative.
