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

Manage your records

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

Tagged areas include Records. 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.1, at version 0.0.1.

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

4 operations 2 paths 4 schemas 2 GET1 POST1 PUT

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

Paths & Operations 4

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

Records 4

Manage your records

GET
/{recordType}/{alias}
Get the list of records
recordList 7 params → 200400401403404422429500
POST
/{recordType}/{alias}
Create a record
createRecord 2 params body → 201400401403404422429500
GET
/{recordType}/{alias}/{id}
Find a record by ID
getRecord 3 params → 200400401403404422429500
PUT
/{recordType}/{alias}/{id}
Update a record
updateRecord 3 params body → 200400401403404422429500

Schemas 4

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

RecordListItem
object
2 properties
PagingState
object
4 properties
Record
object
RecordPagedList
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elementum-records-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 Related-items API
Elementum Search Tables API