Templates · Folders
List template folders
Lists template folders for an organization, ordered by name and ID. It takes an organization ID and optional pagination parameters: offset defaults to 0, and limit defaults to 30 and may be null or an integer from 1 to 30. It returns folders and count, with some actor details masked according to 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 with
template.read. user.readcontrols whether non-contact actors other than the current actor are masked. It also controls whether another user's details nested in a contact actor are masked.- An API actor is masked without
apiKey.read, including when it is the current actor. An API actor that is not the current actor is also masked withoutuser.read. - The legacy
contact.readpermission also allows contact actors to be visible.
Request
Path parameters
-
organizationIdidrequired
Query parameters
-
offsetintegerat least 0 · default
0 -
limitintegernullable1–30
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/folders' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/folders", {
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/YOUR_ORGANIZATION_ID/templates/folders', 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
-
foldersobject[]10 properties
-
_idid -
createdAtstring · date-timenullable -
updatedAtstring · date-timenullable -
removedAtstring · date-timenullable -
createdByobjectnullable -
updatedByobjectnullable -
removedByobjectnullable -
__ignoreTriggersstringnullable -
organizationid -
namestring1–64 characters
-
-
countnumber
Response200
{
"folders": [
{
"_id": "000000000000000000000001",
"organization": "000000000000000000000001",
"name": "string"
}
],
"count": 1
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.