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

Manage the conversation of a record

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

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

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

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

2 operations 1 paths 4 schemas 1 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 Comments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (ClientCredentials) using the clientCredentials flow.

Paths & Operations 2

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

Comments 2

Manage the conversation of a record

GET
/{recordType}/{alias}/{id}/comment
Get the list of comments
listRecordComments 7 params → 200400401403404422429500
POST
/{recordType}/{alias}/{id}/comment
Add a comment
createRecordComment 3 params body → 201400401403404422429500

Schemas 4

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

Comment
object
5 properties
CommentPagedList
object
3 properties
PagingState
object
4 properties
User
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elementum-comments-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 Domains API
Elementum Elements API
Elementum Flows API
Elementum Groups API
Elementum Records API
Elementum Related-items API
Elementum Search Tables API