Skip to main content
GET
/
v1
/
user-groups
/
{userGroupId}
/
model-roles
Retrieve user group model roles
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/user-groups/{userGroupId}/model-roles \
  --header 'Authorization: Bearer <token>'
{
  "userGroupId": "mEhXj6ZI",
  "results": [
    {
      "baseRole": "QUERIER",
      "roleName": "QUERIER",
      "connectionId": "bc1f9c9f-208d-48a2-9ae3-ff80f2c79fed",
      "modelId": "7d3e4f5a-6b7c-8d9e-0f1a-2b3c4d5e6f7a"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
userGroupId
string
required

The ID of the user group to retrieve model roles for.

Query Parameters

​
modelId
string<uuid>

Filter results to a specific model ID. If not provided, returns roles for all models the user group has access to.

​
connectionId
string<uuid>

Filter results to models from a specific connection. If not provided, returns roles for all connections.

Response

User group model roles retrieved successfully.

​
userGroupId
string

The ID of the user group.

​
results
object[]

Array of role assignments for the user group.