Get an embed group

curl --request GET \
  --url https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/groups/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/groups/{id}"

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

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

print(response.text)

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

fetch('https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/groups/{id}', 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://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/groups/{id}",
  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://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/groups/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/groups/{id}")

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>",
  "description": "<string>",
  "userCount": 123
}

GET

api

embed-tenants

{embedTenantName}

groups

{id}

Get an embed group

curl --request GET \
  --url https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/groups/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/groups/{id}"

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

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

print(response.text)

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

fetch('https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/groups/{id}', 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://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/groups/{id}",
  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://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/groups/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://{tenant}.cubecloud.dev/api/v1/embed-tenants/{embedTenantName}/groups/{id}")

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>",
  "description": "<string>",
  "userCount": 123
}

🔒 Admin only. Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role. Returns one of the embed tenant’s groups with its member count, or 404 if no such group exists in this tenant.

Authorizations

Authorization

string

header

required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

embedTenantName

string

required

Name of the embed tenant (the embedTenantName used to generate embed sessions).

integer

required

Numeric id of the group, as returned by the groups endpoints.

Response

200 - application/json

integer

required

name

string

required

description

string | null

userCount

integer | null

Create an embed group Update an embed group

⌘I

Getting Started

Core Data Endpoints

AI Endpoints

Platform Endpoints

Get an embed group

Authorizations

Path Parameters

Response