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

Manage the attachments of a record

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

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

This API exposes 6 operations across 4 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.

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

Paths & Operations 6

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

Attachments 6

Manage the attachments of a record

GET
/{recordType}/{alias}/{id}/attachments
Get the list of attachments
listRecordAttachments 3 params → 200400401403404422429500
POST
/{recordType}/{alias}/{id}/attachments
Add an attachment
createRecordAttachment 3 params body → 202400401403404422429500
POST
/{recordType}/{alias}/{id}/attachments/url-links
Add a link
createRecordLink 3 params body → 201400401403404422429500
GET
/{recordType}/{alias}/{id}/attachments/{attachmentId}
Find an attachment by ID
getRecordAttachment 4 params → 200400401403404422429500
DELETE
/{recordType}/{alias}/{id}/attachments/{attachmentId}
Delete a record attachment
deleteRecordAttachments 4 params → 200400401403404422429500
GET
/{recordType}/{alias}/{id}/attachments/{attachmentId}/content
Download attachment content
downloadRecordAttachment 4 params → 200400401403404422429500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Attachment (9 properties), AttachmentLink (2 properties), File (1 property). Each schema is shown below with its type and property counts.

AttachmentLink
object
2 properties 1 required
File
object
1 property
AttachmentList
array
Attachment
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elementum-attachments-api-openapi.yml Raw ↑

Other APIs Elementum publishes across the network.

Elementum Access Token API
Elementum Agents API
Elementum Apps 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
Elementum Search Tables API