Get user groups

Get list of user groups with pagination and filtering. See User Groups.

GET /userGroups

Get user groups

cURL

curl --request GET \
  --url https://api.galtea.ai/userGroups \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.galtea.ai/userGroups"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.galtea.ai/userGroups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.galtea.ai/userGroups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.galtea.ai/userGroups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.galtea.ai/userGroups")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galtea.ai/userGroups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "id": "ug_123",
    "organizationId": "org_123",
    "name": "QA Team",
    "type": "EVALUATOR",
    "description": "Quality assurance team",
    "createdAt": "2023-11-07T05:31:56Z",
    "userIds": [
      "user_123"
    ],
    "metricIds": [
      "metric_123"
    ]
  }
]

{
  "error": "Error type",
  "message": "Error message description"
}

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

200

application/json

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:

["user_123"]

metricIds · string[]

Example:

["metric_123"]