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 Change Orders API

The Project Change Orders API from Capmo — 3 operation(s) for project change orders.

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

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

6 operations 3 paths 5 schemas 1 DELETE3 GET1 PATCH1 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 Change Orders 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 6

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

Project Change Orders 6
GET
/api/v1/projects/{projectId}/change-orders
This can be used to list all project change orders in a paginated response.
getChangeOrdersPaginated 6 params → 200400401403404409500
POST
/api/v1/projects/{projectId}/change-orders
This can be used to create a new project change order.
createChangeOrder 2 params body → 201400401403404409500
GET
/api/v1/projects/{projectId}/change-orders/steps
This can be used to list all available workflow steps for change orders in a project.
getChangeOrderSteps 2 params → 200400401403404409500
GET
/api/v1/projects/{projectId}/change-orders/{changeOrderId}
This can be used to get a specific project change order by its ID.
getChangeOrder 3 params → 200400401403404409500
PATCH
/api/v1/projects/{projectId}/change-orders/{changeOrderId}
This can be used to update a specific project change order by its ID.
updateChangeOrder 3 params body → 200400401403404409500
DELETE
/api/v1/projects/{projectId}/change-orders/{changeOrderId}
This can be used to delete a specific project change order by its ID.
deleteChangeOrder 3 params → 200400401403404409500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ReadChangeOrderDto (26 properties), CreateChangeOrderDto (13 properties), UpdateChangeOrderDto (13 properties), ReadChangeOrderStepDto (4 properties). Each schema is shown below with its type and property counts.

UpdateChangeOrderDto
object
13 properties
PaginatedOutputDto
object
3 properties 3 required
ReadChangeOrderStepDto
object
4 properties 4 required
ReadChangeOrderDto
object
26 properties 26 required
CreateChangeOrderDto
object
13 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

capmo-project-change-orders-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 Companies API
Capmo Project Documents API
Capmo Project Memberships API
Capmo Project People API
Capmo Project Permission Sets API
Capmo Project Plans API
Capmo Project Room Listings API