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

The Organisation Companies API from Capmo — 2 operation(s) for organisation companies.

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

This API exposes 5 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.

5 operations 2 paths 4 schemas 1 DELETE2 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 Organisation Companies 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 5

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

Organisation Companies 5
GET
/api/v1/organisation/companies
This can be used to list all organisation contact book companies in a paginated response.
getOrganisationCompanies 6 params → 200400401403404409500
POST
/api/v1/organisation/companies
This can be used to add a new organisation contact book company.
createOrganisationCompany 1 param body → 201400401403404409500
GET
/api/v1/organisation/companies/{companyId}
This can be used to retrieve a specific organisation company by its ID.
getOrganisationCompany 2 params → 200400401403404409500
PATCH
/api/v1/organisation/companies/{companyId}
This can be used to update a specific organisation contact book company by its ID.
updateOrganisationCompany 2 params body → 200400401403404409500
DELETE
/api/v1/organisation/companies/{companyId}
This can be used to delete an organisation contact book company.
deleteOrganisationCompany 2 params → 200400401403404409500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ReadOrganisationCompanyDto (18 properties), CreateOrganisationCompanyDto (9 properties), UpdateOrganisationCompanyDto (8 properties), PaginatedOutputDto (3 properties). Each schema is shown below with its type and property counts.

CreateOrganisationCompanyDto
object
9 properties 1 required
PaginatedOutputDto
object
3 properties 3 required
UpdateOrganisationCompanyDto
object
8 properties
ReadOrganisationCompanyDto
object
18 properties 17 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Capmo publishes across the network.

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 Plans API
Capmo Project Room Listings API