Template fields (integrations)

A template's variables as form fields — key, label, type, required, default and choices — so an automation platform can build the render form. Bearer API key with the `template.read` scope. Types: string, text (long text), number, integer, boolean, image (an image URL), color, list and object (both sent as JSON text, or a list as comma-separated text). Also says whether the template animates, so the form can default to a video format, and lists its saved variations.

GET/api/v1/integrations/templates/:id/fields

Query / Path parameters

NameInRequiredDescription
idpathYesTemplate ID

Responses

200

JSON { id, name, width, height, animated, durationSeconds, fields: [{ key, label, type, required, default?, helpText?, choices? }], variations: [{ id, name }] }

401

Missing or invalid API key, or the key lacks the template.read scope (SCOPE_DENIED).

404

No template with that id in the key's space (TEMPLATE_NOT_FOUND).

Request
curl -X GET "https://bannx.com/api/v1/integrations/templates/:id/fields" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Response
// JSON { id, name, width, height, animated, durationSeconds, fields: [{ key, label, type, required, default?, helpText?, choices? }], variations: [{ id, name }] }
{
  "success": true,
  "data": { ... }
}