List User Groups
curl --request GET \
--url https://cloud.onyx.app/api/manage/admin/user-group \
--header 'Authorization: Bearer <token>'import requests
url = "https://cloud.onyx.app/api/manage/admin/user-group"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cloud.onyx.app/api/manage/admin/user-group', 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://cloud.onyx.app/api/manage/admin/user-group",
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://cloud.onyx.app/api/manage/admin/user-group"
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://cloud.onyx.app/api/manage/admin/user-group")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/manage/admin/user-group")
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[
{
"id": 123,
"name": "<string>",
"users": [
{
"id": "<string>",
"email": "<string>",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"preferences": {
"chosen_assistants": [
123
],
"hidden_assistants": [],
"visible_assistants": [],
"default_model": "<string>",
"pinned_assistants": [],
"shortcut_enabled": true,
"auto_scroll": true,
"temperature_override_enabled": true,
"temperature_default": 123,
"reasoning_effort_default": "auto",
"theme_preference": "light",
"language": "<string>",
"chat_background": "<string>",
"default_app_mode": "CHAT",
"paste_as_tile": true,
"voice_auto_send": true,
"voice_auto_playback": true,
"voice_playback_speed": 123,
"assistant_specific_configs": {}
},
"account_type": "STANDARD",
"personalization": {
"name": "",
"role": "",
"use_memories": true,
"enable_memory_tool": true,
"memories": [
{
"content": "<string>",
"id": 123
}
],
"user_preferences": ""
},
"token_expires_at": "2023-11-07T05:31:56Z",
"is_cloud_superuser": false,
"team_name": "<string>",
"is_anonymous_user": true,
"password_configured": true,
"tenant_info": {
"invitation": {
"number_of_users": 123
},
"new_tenant": {
"number_of_users": 123
}
},
"effective_permissions": [
"<string>"
],
"is_group_manager": false,
"admin_capabilities": [
"<string>"
]
}
],
"manager_ids": [
"<string>"
],
"cc_pairs": [
{
"id": 123,
"name": "<string>",
"connector": {
"name": "<string>",
"source": "ingestion_api",
"input_type": "load_state",
"connector_specific_config": {},
"id": 123,
"credential_ids": [
123
],
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z",
"refresh_freq": 123,
"prune_freq": 123,
"check_freq": 123,
"indexing_start": "2023-11-07T05:31:56Z"
},
"credential": {
"credential_json": {},
"admin_public": true,
"source": "ingestion_api",
"id": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"curator_public": false,
"groups": [
123
],
"user_email": "<string>",
"user_personal_name": "<string>",
"is_owner": true
},
"access_type": "public"
}
],
"managed_cc_pairs": [
{
"cc_pair_id": 123,
"role": "editor"
}
],
"document_sets": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"cc_pair_descriptors": [
{
"id": 123,
"name": "<string>",
"connector": {
"name": "<string>",
"source": "ingestion_api",
"input_type": "load_state",
"connector_specific_config": {},
"id": 123,
"credential_ids": [
123
],
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z",
"refresh_freq": 123,
"prune_freq": 123,
"check_freq": 123,
"indexing_start": "2023-11-07T05:31:56Z"
},
"credential": {
"credential_json": {},
"admin_public": true,
"source": "ingestion_api",
"id": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"curator_public": false,
"groups": [
123
],
"user_email": "<string>",
"user_personal_name": "<string>",
"is_owner": true
},
"access_type": "public"
}
],
"is_up_to_date": true,
"is_public": true,
"users": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"groups": [
123
],
"federated_connectors": [
{
"id": 123,
"name": "<string>",
"source": "<string>",
"entities": {}
}
]
}
],
"personas": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"is_public": true,
"is_listed": true,
"uploaded_image_id": "<string>",
"icon_name": "<string>",
"user_file_ids": [
"<string>"
],
"display_priority": 123,
"is_featured": true,
"builtin_persona": true,
"starter_messages": [
{
"name": "<string>",
"message": "<string>"
}
],
"tools": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"definition": {},
"display_name": "<string>",
"in_code_tool_id": "<string>",
"custom_headers": [
"<unknown>"
],
"passthrough_auth": true,
"mcp_server_id": 123,
"user_id": "<string>",
"oauth_config_id": 123,
"oauth_config_name": "<string>",
"enabled": true,
"user_enabled_in_chat": true,
"default_chat_enabled": true,
"permissions": {},
"chat_selectable": true,
"agent_creation_selectable": true,
"default_enabled": false
}
],
"labels": [
{
"id": 123,
"name": "<string>"
}
],
"owner": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>"
},
"owner_group": {
"id": 123,
"name": "<string>"
},
"users": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>"
}
],
"groups": [
123
],
"user_shares": [
{
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>"
},
"permission": "EDITOR"
}
],
"group_shares": [
{
"group_id": 123,
"group_name": "<string>",
"permission": "EDITOR"
}
],
"public_permission": "EDITOR",
"sharing_status": "PRIVATE",
"document_sets": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"cc_pair_summaries": [
{
"id": 123,
"name": "<string>",
"source": "ingestion_api",
"access_type": "public"
}
],
"is_up_to_date": true,
"is_public": true,
"users": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"groups": [
123
],
"permissions": {},
"federated_connector_summaries": [
{
"id": 123,
"name": "<string>",
"source": "federated_slack",
"entities": {}
}
]
}
],
"default_model_configuration_id": 123,
"hierarchy_nodes": [
{
"id": 123,
"raw_node_id": "<string>",
"display_name": "<string>",
"link": "<string>",
"source": "ingestion_api",
"node_type": "folder"
}
],
"attached_documents": [
{
"id": "<string>",
"title": "<string>",
"link": "<string>",
"parent_id": 123,
"last_modified": "2023-11-07T05:31:56Z",
"last_synced": "2023-11-07T05:31:56Z",
"source": "ingestion_api"
}
],
"permissions": {},
"system_prompt": "<string>",
"replace_base_system_prompt": false,
"task_prompt": "<string>",
"datetime_aware": true
}
],
"is_up_to_date": true,
"is_up_for_deletion": true,
"is_default": true,
"incognito_enabled": true,
"permissions": {}
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}User Groups
List User Groups
GET
/
manage
/
admin
/
user-group
List User Groups
curl --request GET \
--url https://cloud.onyx.app/api/manage/admin/user-group \
--header 'Authorization: Bearer <token>'import requests
url = "https://cloud.onyx.app/api/manage/admin/user-group"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cloud.onyx.app/api/manage/admin/user-group', 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://cloud.onyx.app/api/manage/admin/user-group",
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://cloud.onyx.app/api/manage/admin/user-group"
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://cloud.onyx.app/api/manage/admin/user-group")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/manage/admin/user-group")
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[
{
"id": 123,
"name": "<string>",
"users": [
{
"id": "<string>",
"email": "<string>",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"preferences": {
"chosen_assistants": [
123
],
"hidden_assistants": [],
"visible_assistants": [],
"default_model": "<string>",
"pinned_assistants": [],
"shortcut_enabled": true,
"auto_scroll": true,
"temperature_override_enabled": true,
"temperature_default": 123,
"reasoning_effort_default": "auto",
"theme_preference": "light",
"language": "<string>",
"chat_background": "<string>",
"default_app_mode": "CHAT",
"paste_as_tile": true,
"voice_auto_send": true,
"voice_auto_playback": true,
"voice_playback_speed": 123,
"assistant_specific_configs": {}
},
"account_type": "STANDARD",
"personalization": {
"name": "",
"role": "",
"use_memories": true,
"enable_memory_tool": true,
"memories": [
{
"content": "<string>",
"id": 123
}
],
"user_preferences": ""
},
"token_expires_at": "2023-11-07T05:31:56Z",
"is_cloud_superuser": false,
"team_name": "<string>",
"is_anonymous_user": true,
"password_configured": true,
"tenant_info": {
"invitation": {
"number_of_users": 123
},
"new_tenant": {
"number_of_users": 123
}
},
"effective_permissions": [
"<string>"
],
"is_group_manager": false,
"admin_capabilities": [
"<string>"
]
}
],
"manager_ids": [
"<string>"
],
"cc_pairs": [
{
"id": 123,
"name": "<string>",
"connector": {
"name": "<string>",
"source": "ingestion_api",
"input_type": "load_state",
"connector_specific_config": {},
"id": 123,
"credential_ids": [
123
],
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z",
"refresh_freq": 123,
"prune_freq": 123,
"check_freq": 123,
"indexing_start": "2023-11-07T05:31:56Z"
},
"credential": {
"credential_json": {},
"admin_public": true,
"source": "ingestion_api",
"id": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"curator_public": false,
"groups": [
123
],
"user_email": "<string>",
"user_personal_name": "<string>",
"is_owner": true
},
"access_type": "public"
}
],
"managed_cc_pairs": [
{
"cc_pair_id": 123,
"role": "editor"
}
],
"document_sets": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"cc_pair_descriptors": [
{
"id": 123,
"name": "<string>",
"connector": {
"name": "<string>",
"source": "ingestion_api",
"input_type": "load_state",
"connector_specific_config": {},
"id": 123,
"credential_ids": [
123
],
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z",
"refresh_freq": 123,
"prune_freq": 123,
"check_freq": 123,
"indexing_start": "2023-11-07T05:31:56Z"
},
"credential": {
"credential_json": {},
"admin_public": true,
"source": "ingestion_api",
"id": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"curator_public": false,
"groups": [
123
],
"user_email": "<string>",
"user_personal_name": "<string>",
"is_owner": true
},
"access_type": "public"
}
],
"is_up_to_date": true,
"is_public": true,
"users": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"groups": [
123
],
"federated_connectors": [
{
"id": 123,
"name": "<string>",
"source": "<string>",
"entities": {}
}
]
}
],
"personas": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"is_public": true,
"is_listed": true,
"uploaded_image_id": "<string>",
"icon_name": "<string>",
"user_file_ids": [
"<string>"
],
"display_priority": 123,
"is_featured": true,
"builtin_persona": true,
"starter_messages": [
{
"name": "<string>",
"message": "<string>"
}
],
"tools": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"definition": {},
"display_name": "<string>",
"in_code_tool_id": "<string>",
"custom_headers": [
"<unknown>"
],
"passthrough_auth": true,
"mcp_server_id": 123,
"user_id": "<string>",
"oauth_config_id": 123,
"oauth_config_name": "<string>",
"enabled": true,
"user_enabled_in_chat": true,
"default_chat_enabled": true,
"permissions": {},
"chat_selectable": true,
"agent_creation_selectable": true,
"default_enabled": false
}
],
"labels": [
{
"id": 123,
"name": "<string>"
}
],
"owner": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>"
},
"owner_group": {
"id": 123,
"name": "<string>"
},
"users": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>"
}
],
"groups": [
123
],
"user_shares": [
{
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>"
},
"permission": "EDITOR"
}
],
"group_shares": [
{
"group_id": 123,
"group_name": "<string>",
"permission": "EDITOR"
}
],
"public_permission": "EDITOR",
"sharing_status": "PRIVATE",
"document_sets": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"cc_pair_summaries": [
{
"id": 123,
"name": "<string>",
"source": "ingestion_api",
"access_type": "public"
}
],
"is_up_to_date": true,
"is_public": true,
"users": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"groups": [
123
],
"permissions": {},
"federated_connector_summaries": [
{
"id": 123,
"name": "<string>",
"source": "federated_slack",
"entities": {}
}
]
}
],
"default_model_configuration_id": 123,
"hierarchy_nodes": [
{
"id": 123,
"raw_node_id": "<string>",
"display_name": "<string>",
"link": "<string>",
"source": "ingestion_api",
"node_type": "folder"
}
],
"attached_documents": [
{
"id": "<string>",
"title": "<string>",
"link": "<string>",
"parent_id": 123,
"last_modified": "2023-11-07T05:31:56Z",
"last_synced": "2023-11-07T05:31:56Z",
"source": "ingestion_api"
}
],
"permissions": {},
"system_prompt": "<string>",
"replace_base_system_prompt": false,
"task_prompt": "<string>",
"datetime_aware": true
}
],
"is_up_to_date": true,
"is_up_for_deletion": true,
"is_default": true,
"incognito_enabled": true,
"permissions": {}
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Business Edition FeatureThis feature requires a Business or Enterprise plan. View plans
or contact sales to learn more.
Required permission:
read:user_groups, which Manage Groups includes. Admin (admin) also has it.
A Group Manager can also call this, limited to the groups they manage.Authorizations
Authorization header with Bearer token
Query Parameters
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?