List embed users

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

import requests

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

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}/users', 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}/users",
  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}/users"

	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}/users")

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

{
  "items": [
    {
      "id": 123,
      "username": "<string>",
      "createdAt": "2023-12-25",
      "email": "<string>",
      "externalId": "<string>",
      "firstName": "<string>",
      "lastLogin": "2023-12-25"
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  }
}

GET

api

embed-tenants

{embedTenantName}

users

List embed users

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

import requests

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

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}/users', 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}/users",
  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}/users"

	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}/users")

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

{
  "items": [
    {
      "id": 123,
      "username": "<string>",
      "createdAt": "2023-12-25",
      "email": "<string>",
      "externalId": "<string>",
      "firstName": "<string>",
      "lastLogin": "2023-12-25"
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  }
}

🔒 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. Lists the embed users belonging to one embed tenant, cursor-paginated and ordered by email. Alongside the numeric id this API uses, a user carries the externalId your integration knows it by (the id passed to generate-session) whenever it was recorded on the account — users provisioned before it was recorded come back without an externalId, though they stay addressable by it everywhere it is accepted as input. Use search to match a substring of the email or external id, or a complete external id, which resolves a user even when the response cannot echo it back.

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

Query Parameters

string | null

Case-insensitive substring match against the embed user’s email or external id.

after

string

first

integer

Required range: x >= 1

Response

200 - application/json

items

object[]

required

Show child attributes

pageInfo

object

required

Show child attributes

Remove embed group members List a dashboard's embed access

⌘I

Getting Started

Core Data Endpoints

AI Endpoints

Platform Endpoints

List embed users

Authorizations

Path Parameters

Query Parameters

Response