Templates · Versions
List versions
Lists the published versions of a template for an organization, newest first. The response contains up to 100 versions without their designs.
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 and
template.read. - For a receipt template, the caller also needs
receipt.read. - For a donation confirmation template, the caller also needs
donationsSettings.read.
Request
Path parameters
-
organizationIdidrequired -
templateIdidrequired
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/YOUR_TEMPLATE_ID/versions' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/YOUR_TEMPLATE_ID/versions", {
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/YOUR_TEMPLATE_ID/versions', 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
-
versionsobject[]5 properties
-
_idid -
numberinteger -
namestringat most 64 characters
-
createdAtstring · date-timenullable -
createdByobjectnullableWithout
user.read, a non-contact creator other than the current actor is masked.Without
apiKey.read, an API creator is masked, even if it is the current actor.The legacy
contact.readpermission also allows contact creator details to be shown.Any one of
contact:member.read,contact:address.read,contact:customer.read,contact:sponsor.read,contact:contributor.read,contact:employee.read, orcontact:supplier.readallows contact creator details to be shown, regardless of the contact type.
-
{
"versions": [
{
"_id": "000000000000000000000001",
"number": 1,
"name": "string"
}
]
}
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | No fixed message | If the template is not found in the organization, the request returns HTTP 404. |
Errors nearly every request can meet are listed under Errors.