Skip to content
campaiDeveloper
campai.com

Donation

GET/{organizationId}/donation/settings/confirmation/templatesReads only

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.read permission.

Request

Path parameters

  • organizationIdidrequired

Query parameters

  • searchstring

    at most 240 characters · default ""

  • templateIdid
  • offsetinteger

    at least 0 · default 0

  • limitinteger

    1–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'

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.