List the users in a permission group
curl --request GET \
--url https://api.nekt.ai/api/v1/organization/permission-groups/{permission_group_pk}/users/ \
--header 'x-api-key: <api-key>'import requests
url = "https://api.nekt.ai/api/v1/organization/permission-groups/{permission_group_pk}/users/"
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/{permission_group_pk}/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://api.nekt.ai/api/v1/organization/permission-groups/{permission_group_pk}/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 => [
"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/{permission_group_pk}/users/"
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/{permission_group_pk}/users/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/organization/permission-groups/{permission_group_pk}/users/")
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[
{
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"picture": "<string>",
"role": "<string>",
"functional_area": "data_analytics",
"other_functional_area": "<string>",
"date_joined": "2023-11-07T05:31:56Z",
"last_login": "2023-11-07T05:31:56Z",
"is_active": false,
"is_pending": false
}
]Permission groups
List Group Members
Who is in a group, including people who have not accepted yet.
GET
/
api
/
v1
/
organization
/
permission-groups
/
{permission_group_pk}
/
users
/
List the users in a permission group
curl --request GET \
--url https://api.nekt.ai/api/v1/organization/permission-groups/{permission_group_pk}/users/ \
--header 'x-api-key: <api-key>'import requests
url = "https://api.nekt.ai/api/v1/organization/permission-groups/{permission_group_pk}/users/"
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/{permission_group_pk}/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://api.nekt.ai/api/v1/organization/permission-groups/{permission_group_pk}/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 => [
"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/{permission_group_pk}/users/"
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/{permission_group_pk}/users/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/organization/permission-groups/{permission_group_pk}/users/")
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[
{
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"picture": "<string>",
"role": "<string>",
"functional_area": "data_analytics",
"other_functional_area": "<string>",
"date_joined": "2023-11-07T05:31:56Z",
"last_login": "2023-11-07T05:31:56Z",
"is_active": false,
"is_pending": false
}
]Returns the members of one group. Everybody listed here holds every grant the group holds.
Deactivated members are not listed. They were switched off deliberately, and their access is gone regardless of what group they were in.
Response
An array of user objects. This endpoint is not paginated.[
{
"id": 12,
"first_name": "Dana",
"last_name": "Reed",
"email": "dana@example.com",
"role": "member",
"is_active": true,
"is_pending": false
},
{
"id": 42,
"first_name": "",
"last_name": "",
"email": "analyst@example.com",
"role": "member",
"is_active": false,
"is_pending": true
}
]
Invited people appear here.
is_pending: true with is_active: false is somebody who has been invited and has not accepted — they hold the group’s grants already, and accepting is what lets them sign in and use them. See Onboarding flow.Related
- Add Members — putting somebody in.
- Remove Members — taking them out.
- Retrieve a Group — membership plus the grants the group holds.
Authorizations
API Key authentication. Format: 'x-api-key: api_key'
Path Parameters
The permission group's id.
Response
200 - application/json
data_analytics- Data & Analyticssales- Salescustomer_support- Customer Supportoperations- Operationsmarketing- Marketingfinance- Financeproduct_development- Product Developmentgrowth- Growthexecutive_leadership- Executive Leadershipother- Other
Available options:
data_analytics, sales, customer_support, operations, marketing, finance, product_development, growth, executive_leadership, other Was this page helpful?