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

The Project Memberships API from Capmo — 2 operation(s) for project memberships.

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

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

4 operations 2 paths 4 schemas 1 DELETE2 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 Project Memberships 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 4

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

Project Memberships 4
GET
/api/v1/projects/{projectId}/memberships
This can be used to list all project memberships in a paginated response.
getProjectMemberships 6 params → 200400401403404409500
POST
/api/v1/projects/{projectId}/memberships
This can be used to invite a project contact book person to a project identified by projectId. As a result, a project membership for them will be created.
inviteProjectPerson 2 params body → 201400401403404409500
GET
/api/v1/projects/{projectId}/memberships/{membershipId}
This can be used to retrieve a specific project membership by membershipId from a project identified by projectId.
getProjectMembership 3 params → 200400401403404409500
DELETE
/api/v1/projects/{projectId}/memberships/{membershipId}
This can be used to revoke a project membership.
revokeProjectMembership 3 params → 200400401403404409500

Schemas 4

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

InviteProjectMemberDto
object
3 properties 1 required
ReadProjectMembershipDto
object
13 properties 13 required
PaginatedOutputDto
object
3 properties 3 required
ProjectRole
string
The role assigned to the user in the project.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

capmo-project-memberships-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 People API
Capmo Project Permission Sets API
Capmo Project Plans API
Capmo Project Room Listings API