CAcarbone
Template

List all categories used in templates

Changed on

Retrieve a list of all categories used in deployed templates, sorted by name. Categories function similarly to folders, allowing you to group and organize your templates effectively (e.g. "customer-x", "project-2026", "finances").

Practical Usage:

  • Uploading a Template: When uploading a template, you can specify a category.
  • Updating a Template: You can add or modify the category when updating template metadata.
  • Listing Templates: You can filter templates by category to quickly find that are relevant to a specific function or type.
get/templates/categories

Request

Headers

carbone-version'5' | '4' | '3' | 'staging' required

Carbone API major version to use. Only a major version can be specified: it automatically includes all future minor versions and patches.

  • 5: latest version, recommended.
  • 4: default when the header is not provided.
  • 3: legacy.
  • staging: not intended for production environments.

It is strongly recommended to always set this header explicitly to avoid unexpected behavior. See API versioning documentation

Response

List of categories used in templates.

successboolean

Example response

{
  "success": true
}

Changes

  • c06cc573e3b0Revision changes
    • breaking

      the carbone-version request header's property undefined was restricted to a list of enum values

    • breaking

      the header request parameter carbone-version was restricted to a list of enum values

    • info

      added the new enum value 3 to the header request parameter carbone-version

    • info

      added the new enum value 4 to the header request parameter carbone-version

    • info

      added the new enum value 5 to the header request parameter carbone-version

    • info

      added the new enum value staging to the header request parameter carbone-version

    • info

      for the header request parameter carbone-version, the type was generalized from integer to string, and format from int32 to no format

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status