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

Elementum Watchers API

Manage the watchers of a record

Elementum Watchers API is one of 18 APIs that Elementum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Watchers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 1 path, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 0.0.1.

Requests are made against a single base URL, /v1.

3 operations 1 paths 5 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
0.0.1
Base URL
https://api.elementum.io/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Elementum Watchers API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (ClientCredentials) using the clientCredentials flow.

Paths & Operations 3

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

Watchers 3

Manage the watchers of a record

GET
/{recordType}/{alias}/{id}/watchers
Get the list of watchers
listRecordWatchers 7 params → 200400401403404422429500
POST
/{recordType}/{alias}/{id}/watchers
Add a watcher
createRecordWatchers 3 params body → 201400401403404422429500
DELETE
/{recordType}/{alias}/{id}/watchers
Delete a watcher
deleteRecordWatchers 3 params body → 200400401403404422429500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are WatcherTarget (6 properties), PagingState (4 properties), WatcherPagedList (3 properties), Watcher (2 properties). Each schema is shown below with its type and property counts.

PagingState
object
4 properties
WatcherPagedList
object
3 properties
Watcher
object
2 properties
WatcherTarget
object
6 properties
WatcherListInput
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elementum-watchers-api-openapi.yml Raw ↑

Other APIs Elementum publishes across the network.

Elementum Access Token API
Elementum Agents API
Elementum Apps API
Elementum Attachments API
Elementum Automations API
Elementum Comments API
Elementum Domains API
Elementum Elements API
Elementum Flows API
Elementum Groups API
Elementum Records API
Elementum Related-items API