List permission groups
curl --request GET \
--url https://api.nekt.ai/api/v1/organization/permission-groups/ \
--header 'x-api-key: <api-key>'import requests
url = "https://api.nekt.ai/api/v1/organization/permission-groups/"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.nekt.ai/api/v1/organization/permission-groups/', 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.nekt.ai/api/v1/organization/permission-groups/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.nekt.ai/api/v1/organization/permission-groups/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.nekt.ai/api/v1/organization/permission-groups/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/organization/permission-groups/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 123,
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"all_group": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"users": [
123
],
"description": "<string>"
}
],
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2"
}Permission groups
List Permission Groups
Every group in your workspace, including the All group.
GET
/
api
/
v1
/
organization
/
permission-groups
/
List permission groups
curl --request GET \
--url https://api.nekt.ai/api/v1/organization/permission-groups/ \
--header 'x-api-key: <api-key>'import requests
url = "https://api.nekt.ai/api/v1/organization/permission-groups/"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.nekt.ai/api/v1/organization/permission-groups/', 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.nekt.ai/api/v1/organization/permission-groups/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.nekt.ai/api/v1/organization/permission-groups/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.nekt.ai/api/v1/organization/permission-groups/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/organization/permission-groups/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 123,
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"all_group": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"users": [
123
],
"description": "<string>"
}
],
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2"
}Returns the groups in your workspace, paginated. This is where a group’s
id comes from when you want to grant to it or change who is in it.
Query parameters
| Parameter | Type | Description |
|---|---|---|
search | string | Match on group name or description. |
users | integer | Only groups this user belongs to. Takes a user id, not a UUID. |
page | integer | Page number. |
page_size | integer | Results per page. |
expand[] | string | users, user_count, lakehouse_permissions, object_permissions, semantic_layer_permissions. See Expanding Responses. |
users answers “which groups is this person in”, which is the fastest way to audit somebody’s inherited access before you change it.Response
A paginated list of permission group objects.{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": "b8c5e1e3-6d02-4f45-ad20-8f4b6e2d0e13",
"name": "All",
"description": "Everyone in the workspace",
"all_group": true,
"created_at": "2026-01-14T09:02:11Z",
"updated_at": "2026-01-14T09:02:11Z",
"users": [7, 12, 42]
},
{
"id": "c1f0a9d4-5b62-4e18-9a73-2d8e4f6b0c51",
"name": "Analysts",
"description": "Read access to the Gold layer",
"all_group": false,
"created_at": "2026-03-02T14:20:55Z",
"updated_at": "2026-09-18T11:47:03Z",
"users": [12, 42]
}
]
}
Exactly one group has
all_group: true, and it contains every member automatically. See the All group for what you can and cannot do to it.Find a group by name
import os
import requests
BASE_URL = "https://api.nekt.ai"
headers = {"x-api-key": os.environ["NEKT_API_KEY"]}
response = requests.get(
f"{BASE_URL}/api/v1/organization/permission-groups/",
headers=headers,
params={"search": "Analysts"},
)
response.raise_for_status()
for group in response.json()["results"]:
print(f"{group['name']}: {group['id']}")
Related
- Create a Group — when the one you want does not exist.
- List Members — who is in one.
- List Recipients — the picker view, filtered by what can still be granted.
Authorizations
API Key authentication. Format: 'x-api-key: api_key'
Query Parameters
A page number within the paginated result set.
Number of results to return per page.
A search term.
Was this page helpful?