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

Manage groups and group membership

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

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

This API exposes 9 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.0.1, at version 0.0.1.

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

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

Paths & Operations 9

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

Groups 9

Manage groups and group membership

GET
/groups
List groups in your organization
listGroups 4 params → 200400401403404422429500
POST
/groups
Create a group
createGroup body → 201400401403404422429500
GET
/groups/{groupId}
Get a group by ID
getGroup 1 param → 200400401403404422429500
PUT
/groups/{groupId}
Update a group
updateGroup 1 param body → 200400401403404422429500
GET
/groups/{groupId}/users
List users in a group
listGroupUsers 5 params → 200400401403404422429500
POST
/groups/{groupId}/users
Add users to a group
addUsersToGroup 1 param body → 201400401403404422429500
DELETE
/groups/{groupId}/users
Remove users from a group
removeUsersFromGroup 1 param body → 200400401403404422429500
POST
/groups/{groupId}/domains
Add email domains to a group
addDomainsToGroup 1 param body → 201400401403404422429500
DELETE
/groups/{groupId}/domains
Remove email domains from a group
removeDomainsFromGroup 1 param body → 200400401403404422429500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are GroupRequest (11 properties), Group (8 properties), User (6 properties), PagingState (4 properties). Each schema is shown below with its type and property counts.

PagingState
object
4 properties
GroupUserIdsInput
object
1 property 1 required
Group
object
8 properties
GroupDomain
object
2 properties
UserPagedList
object
3 properties
GroupRequest
object
11 properties
GroupDomainsInput
object
1 property 1 required
GroupDomainList
array
GroupPagedList
object
3 properties
User
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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