Skip to main content
GET
Get user groups
You are reading the docs of Galtea 5.16. Read this page in the latest version.

Authorizations

Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Query Parameters

ids
string[]

Filter by user group IDs

organizationIds
string[]

Filter by organization IDs

types
string[]

Filter by user group types

userIds
string[]

Filter by user IDs (groups containing these users)

metricIds
string[]

Filter by metric IDs (groups linked to these metrics)

names
string[]

Filter by user group names

fromCreatedAt
string<date-time>

Filter groups created at or after this timestamp (ISO 8601)

toCreatedAt
string<date-time>

Filter groups created at or before this timestamp (ISO 8601)

sort
string[]

Sort instructions (field and direction pairs)

limit
integer

Maximum number of results

offset
integer

Number of results to skip

Response

User groups retrieved successfully

id
string
Example:

"ug_123"

organizationId
string
Example:

"org_123"

name
string
Example:

"QA Team"

type
enum<string>
Available options:
EVALUATOR
Example:

"EVALUATOR"

description
string | null
Example:

"Quality assurance team"

createdAt
string<date-time>
userIds
string[]
Example:
metricIds
string[]

Metrics linked to this group. A READER or HUMAN_EVALUATOR caller sees only the linked metrics it can read.

Example:
productIds
string[]

Products linked to this group. A MEMBER, READER or HUMAN_EVALUATOR caller sees only the linked products it can read.

Example:
allProducts
boolean

Grants this group every product of its organization, current and future. Wins over explicit product links while set.

Example:

false

permissionPreset
enum<string> | null

The preset the group follows; when the preset changes, the group's permissions change with it. Null means the group holds its own list in permissions.

Available options:
EDITOR,
HUMAN_EVALUATOR,
READER,
null
Example:

"READER"

permissions
string[] | null

The permissions the group grants, each written entity.action, sorted. A product entry applies to the products the group reaches; a metric, model or comment entry applies across the organization. For a group that follows a preset, this is the preset's current list. Null means the group follows the EDITOR preset: it grants every permission its members role allows. An empty list grants nothing. A user in several groups may do a product action when any group that reaches the product lists it, and an organization action when any group lists it. The role of the user still limits what a list can grant.

Example:
deletedAt
string<date-time> | null