Connect · Teams
List team access options
Lists the roles, departments and segments available for team access settings in an organization. Provide the organization ID in the path. The response contains roles, departments and segments arrays.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have access to the organization.
- The caller needs the
team.readpermission.
Request
Path parameters
-
organizationIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/team-access-options' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/team-access-options", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/team-access-options', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
rolesobject[]2 properties
-
_idid -
namestring1–32 characters
-
-
departmentsobject[]3 properties
-
_idid -
namestring1–80 characters
-
typesstring[]at least 1 items
memberaddresscustomersponsorcontributoremployeesupplier
-
-
segmentsobject[]3 properties
-
keystring1–30 characters
-
namestring1–40 characters
-
typestringmemberaddresscustomersponsorcontributoremployeesupplier
-
Response200
{
"roles": [
{
"_id": "000000000000000000000001",
"name": "string"
}
],
"departments": [
{
"_id": "000000000000000000000001",
"name": "string",
"types": [
"member"
]
}
],
"segments": [
{
"key": "string",
"name": "string",
"type": "member"
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.