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

The Project Plans API from Capmo — 4 operation(s) for project plans.

Capmo Project Plans 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 Plans. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 4 paths, and defines 10 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.

9 operations 4 paths 10 schemas 2 DELETE3 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 Plans 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 9

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

Project Plans 9
GET
/api/v1/projects/{projectId}/plan-folders
This can be used to list all project plan folders in a paginated response.
getPlanFolders 6 params → 200400401403404409500
POST
/api/v1/projects/{projectId}/plan-folders
This can be used to create a new project plan folder.
createPlanFolder 2 params body → 201400401403404409500
PATCH
/api/v1/projects/{projectId}/plan-folders/{folderId}
This can be used to rename a project plan folder.
updatePlanFolder 3 params body → 201400401403404409500
DELETE
/api/v1/projects/{projectId}/plan-folders/{folderId}
This can be used to delete a specific project plan folder by its ID.
deletePlanFolder 3 params → 200400401403404409500
POST
/api/v1/projects/{projectId}/plans
This can be used to create a new project plan.
createProjectPlan 2 params body → 200400401403404409500
GET
/api/v1/projects/{projectId}/plans
This can be used to list all project plans in a paginated response.
getProjectPlansList 6 params → 200400401403404409500
GET
/api/v1/projects/{projectId}/plans/{planId}
This can be used to get a single project plan.
getProjectPlan 3 params → 200400401403404409500
DELETE
/api/v1/projects/{projectId}/plans/{planId}
This can be used to delete a specific project plan by its ID.
deletePlan 3 params → 200400401403404409500
PATCH
/api/v1/projects/{projectId}/plans/{planId}
This can be used to update a specific project plan by its ID.
updateProjectPlan 3 params → 200400401403404409500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ReadPlanWithSignedUrlDto (23 properties), ReadPlanDto (21 properties), ReadPlanFolderDto (9 properties), CreatePlanFromDocumentDto (6 properties). Each schema is shown below with its type and property counts.

SourceTypes
string
Type of the plan source.
PaginatedOutputDto
object
3 properties 3 required
ReadPlanFolderDto
object
9 properties 8 required
ReadPlanDto
object
21 properties 20 required
CreatePlanFolderInputDto
object
2 properties 1 required
PlanRenderingStatus
string
Plan rendering status.
ReadPlanWithSignedUrlDto
object
23 properties 22 required
CreatePlanFromFileDto
object
6 properties 3 required
UpdatePlanFolderDto
object
2 properties 1 required
CreatePlanFromDocumentDto
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

capmo-project-plans-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 Room Listings API