Templates
Count templates
Counts an organization's non-archived templates by type and subtype. It returns an array of type, subtype and count values, excluding templates with an email or letter that has no design.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Requires organization access and the
template.readpermission. - Without
receipt.read, receipt templates are excluded from the counts. - Without
donationsSettings.read, donation confirmation templates are excluded from the counts.
Request
Path parameters
-
organizationIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/counts' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/counts", {
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/counts', 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
A list of object.
-
typestringtransactionalcontactbookingreceiptdonationConfirmation -
subtypestringnullable[].subtypeis null for contact templates that apply to all contact types. -
countnumber
Response200
[
{
"type": "transactional",
"subtype": "string",
"count": 1
}
]
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.