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

Manage automations

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

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

This API exposes 6 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 0.0.1.

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

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

Paths & Operations 6

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

Automations 6

Manage automations

GET
/{recordType}/{alias}/automations
List automations under an app or element
listAutomations 2 params → 200400401403404422429500
POST
/{recordType}/{alias}/automations
Create an automation under an app or element
createAutomation 2 params body → 201400401403404422429500
POST
/{recordType}/{alias}/automations/validate
Validate an automation definition without creating it
validateAutomation 2 params body → 200400401403404422429500
GET
/{recordType}/{alias}/automations/{id}
Get an automation by ID
getAutomation 3 params → 200400401403404422429500
PUT
/{recordType}/{alias}/automations/{id}
Update an automation by ID
updateAutomation 3 params body → 200400401403404422429500
DELETE
/{recordType}/{alias}/automations/{id}
Delete an automation by ID
deleteAutomation 3 params → 200400401403404422429500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

AutomationList
array
An automation's active and/or draft workflow, each in full-state form (with triggers, tasks, and output properties).
PassthroughObject
object
Free-form JSON object forwarded to/from the downstream service.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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