How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vertesia User Groups API

User Group endpoints manage account-level groups and their membership for access control and app visibility.

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

This API exposes 6 JSON Schema definitions.

Tagged areas include User Groups. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 8 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.6.0-dev.20261019.172735Z.

Requests are made against a single base URL, https://api.{region}.vertesia.io/api/v1.

8 operations 5 paths 7 schemas 1 DELETE3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.6.0-dev.20261019.172735Z
Base URL
https://api.us1.vertesia.io/api/v1
Authentication
HTTP Bearer, OAuth 2.0
Contact
License
Apache-2.0
Resource Areas
1

Authentication & Security 2

Vertesia User Groups API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 33 scopes.

Paths & Operations 8

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

User Groups 8

User Group endpoints manage account-level groups and their membership for access control and app visibility.

GET
/iam/groups
List user groups
ListUserGroups 6 params → 2005004XX
POST
/iam/groups
Create a user group
CreateUserGroup 1 param body → 2005004XX
POST
/iam/groups/sync-members
Sync the members group
SyncMembersUserGroup 1 param → 2005004XX
PUT
/iam/groups/{groupId}
Update a user group
UpdateUserGroup 2 params body → 2005004XX
GET
/iam/groups/{groupId}
Retrieve a user group
GetUserGroup 2 params → 2005004XX
GET
/iam/groups/{groupId}/members
List user group members
ListUserGroupMembers 2 params → 2005004XX
POST
/iam/groups/{groupId}/members/{userId}
Add a user to a group
AddUserGroupMember 3 params → 2005004XX
DELETE
/iam/groups/{groupId}/members/{userId}
Remove a user from a group
RemoveUserGroupMember 3 params → 2005004XX

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are UserGroup (14 properties), UpdateUserGroupPayload (7 properties), ErrorResponse (5 properties), CreateUserGroupPayload (4 properties). Each schema is shown below with its type and property counts.

UserRefArray
array
UserGroup
object
14 properties 6 required
UpdateUserGroupPayload
object
7 properties 1 required
UserRef
object
4 properties 3 required
UserGroupArray
array
ErrorResponse
object
Standard JSON error response returned by the server error handler.
5 properties 2 required
CreateUserGroupPayload
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vertesiahq-user-groups-api-openapi.yml Raw ↑

Other APIs Vertesia publishes across the network.

Vertesia Access Control Entries API
Vertesia Account API
Vertesia Accounts API
Vertesia Agent Runs API
Vertesia API Keys API
Vertesia Apps API
Vertesia Audit Trail API
Vertesia Bulk Operations API
Vertesia Collections API
Vertesia Commands API
Vertesia Content Object Types API
Vertesia Content Query API
Where this information came from

This is an independent, third-party profile of Vertesia User Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.