Connect · Team roles
List team roles
Lists all team roles for the specified organization. Returns a roles array sorted by name and then ID. Actor details may be masked depending on the caller’s permissions.
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 organization access.
- The caller needs
team.read. - Without
user.read, non-contact actors other than the current actor are masked. - Without
apiKey.read, API actors are masked. A non-current API actor also needsuser.readto remain unmasked. - The legacy
contact.readpermission also allows contact actors to be read.
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-roles' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/team-roles", {
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-roles', 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[]13 properties
-
_idid -
createdAtstring · date-timenullable -
updatedAtstring · date-timenullable -
removedAtstring · date-timenullable -
createdByobjectnullable -
updatedByobjectnullable -
removedByobjectnullable -
__ignoreTriggersstringnullable -
organizationid -
namestring1–32 characters
-
descriptionstringat most 256 characters
-
permissionsobject5 properties
-
contactobject10 properties
-
readobject of booleanKeys: one of 7 values
memberaddresscustomersponsorcontributoremployeesupplier -
communicationboolean -
personalboolean -
departmentsboolean -
groupsboolean -
billingboolean -
contractsboolean -
notesboolean -
proofsCertificatesboolean -
tagsboolean
-
-
userobject of booleanKeys: one of 3 values
listreadchat -
chatobject22 properties
-
createActivityboolean -
createPollboolean -
createAvailabilityboolean -
createSignupboolean -
createChecklistboolean -
createFormboolean -
createChallengeboolean -
participatePollboolean -
participateAvailabilityboolean -
participateSignupboolean -
participateChecklistboolean -
participateFormboolean -
participateChallengeboolean -
manageActivitiesboolean -
replyboolean -
reactboolean -
mentionboolean -
mentionEveryoneboolean -
manageboolean -
changeAppearanceboolean -
pinboolean -
viewContactNameboolean
-
-
todoobject of booleanKeys: one of 2 values
readmanage -
fileobject of booleanKeys: one of 4 values
viewmanageFoldersmanageOwnFilesmanageAllFiles
-
-
referenceRevisionintegerat least 0
-
Response200
{
"roles": [
{
"_id": "000000000000000000000001",
"organization": "000000000000000000000001",
"name": "string",
"description": "string",
"permissions": {
"contact": {
"read": {
"key": true
},
"communication": true,
"personal": true
},
"user": {
"key": true
},
"chat": {
"createActivity": true,
"createPoll": true,
"createAvailability": true
}
}
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.