Skip to content
campaiDeveloper
campai.com

Templates · Folders

GET/{organizationId}/templates/foldersReads only

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.read controls 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 without user.read.
  • The legacy contact.read permission also allows contact actors to be visible.

Request

Path parameters

  • organizationIdidrequired

Query parameters

  • offsetinteger

    at least 0 · default 0

  • limitintegernullable

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

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
    • namestring

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