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 Site Journals API

The Project Site Journals API from Capmo — 2 operation(s) for project site journals.

Capmo Project Site Journals 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 Site Journals. 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 8 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 8 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 Project Site Journals 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.

Project Site Journals 5
GET
/api/v1/projects/{projectId}/site-journals
Gets all the site journals in a paginated response.
getSiteJournalsPaginated 6 params → 200400401403500
POST
/api/v1/projects/{projectId}/site-journals
Creates a new project site journal.
createSiteJournal 2 params body → 201400401403409500
GET
/api/v1/projects/{projectId}/site-journals/{siteJournalId}
Retrieves a single project site journal by ID.
getSiteJournal 3 params → 200400401403404500
PATCH
/api/v1/projects/{projectId}/site-journals/{siteJournalId}
Updates a project site journal. When the properties to be updated are objects, they are completely replaced. This means that attendances, visits or weather observation will always be replaced in case…
updateSiteJournal 3 params body → 200400401403404500
DELETE
/api/v1/projects/{projectId}/site-journals/{siteJournalId}
This endpoint deletes a project site journal and all its associated entries (company attendances, visits, weather observations).
deleteSiteJournal 3 params → 200400401403404500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ReadSiteJournalDto (8 properties), CreateSiteJournalDto (6 properties), SiteJournalWorkerEntryDto (6 properties), UpdateSiteJournalDto (6 properties). Each schema is shown below with its type and property counts.

SiteJournalCustomTextDto
object
1 property 1 required
SiteJournalVisitDto
object
4 properties 4 required
PaginatedOutputDto
object
3 properties 3 required
CreateSiteJournalDto
object
6 properties 1 required
UpdateSiteJournalDto
object
6 properties
SiteJournalWorkerEntryDto
object
6 properties 6 required
ReadSiteJournalDto
object
8 properties 7 required
SiteJournalCompanyAttendanceDto
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

capmo-project-site-journals-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 Plans API