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 Organisation Projects API

The Organisation Projects API from Capmo — 2 operation(s) for organisation projects.

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

This API exposes 3 operations across 2 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 2 paths 6 schemas 1 DELETE1 GET1 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 Organisation 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 3

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

Organisation Projects 3
GET
/api/v1/organisation/projects
This can be used to list all projects owned by your organisation in a paginated response. Project templates are excluded.
getOrganisationProjects 5 params → 200400401403404409500
POST
/api/v1/organisation/projects/{projectId}/membership
This can be used to join an organisation project. The API-key user must be an organisation admin, and the project must be owned by the user's organisation. If the user previously left the project (so…
joinOwnOrganisationProject 2 params → 201400401403404409500
DELETE
/api/v1/organisation/projects/{projectId}/membership
This can be used to leave an organisation project. The API-key user must be an organisation admin, and the project must be owned by the user's organisation. The user's project membership and associat…
leaveOwnOrganisationProject 2 params → 200400401403404409500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ReadProjectDto (34 properties), PaginatedOutputDto (3 properties). Each schema is shown below with its type and property counts.

ReadProjectDto
object
34 properties 33 required
PaginatedOutputDto
object
3 properties 3 required
ProjectContactType
string
The type of the project owner reference.
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.

Source

capmo-organisation-projects-api-openapi.yml Raw ↑

Other APIs Capmo publishes across the network.

Capmo Organisation Companies API
Capmo Organisation Memberships API
Capmo Organisation People 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
Capmo Project Room Listings API