Donation
List confirmation templates
Lists published, unarchived donation confirmation templates for an organization, ordered by name and ID. It accepts optional search, templateId, offset, and limit parameters and returns templates with _id and name, plus count. Search is limited to 240 characters; offset defaults to 0 and limit defaults to 30, with a maximum of 60.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Callers need organization access and the
donationsSettings.readpermission.
Request
Path parameters
-
organizationIdidrequired
Query parameters
-
searchstringat most 240 characters · default
"" -
templateIdid -
offsetintegerat least 0 · default
0 -
limitinteger1–60 · default
30
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/donation/settings/confirmation/templates' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/donation/settings/confirmation/templates", {
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/donation/settings/confirmation/templates', 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
-
templatesobject[]2 properties
-
_idid -
namestring
-
-
countnumber
Response200
{
"templates": [
{
"_id": "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.