v1

latestOpenAPI 3.1.02026-08-06244570.4 KB

Templates

Get template fields

Get the dynamic fields for a template.

Authentication: API Key required (x-api-key header) or JWT token

Usage: This endpoint is designed for no-code tool integrations (Zapier, Make.com). It returns an array of field definitions used to dynamically generate input forms.

Response format: Array of field objects with: key, label, type, required, optional helpText, and optional spec (for array fields).

Field types:

string: Text input
integer: Integer number
number: Decimal number
boolean: True/False checkbox
array: Array of items with nested spec defining item structure

Array fields: When a field is an array of objects, the response includes a spec array defining the structure of each item (name, label, type for each nested field).

No credits consumed: This is a read-only endpoint.

Rate Limits: 60 requests/min (free), 120 requests/min (paid). Headers included in response.

get/v1/templates/{template_id}/fields

Path parameters

template_idstring required

Template short ID (12 characters)

Response

List of template fields

keystring required

Field key/identifier

labelstring required

Human-readable label

typestring

Field type: string, integer, number, boolean, array

requiredboolean

Whether the field is required

helpTextstring nullable

Help text with example value

Example response

[
  {
    "key": "customer_name",
    "label": "Customer Name",
    "type": "string",
    "required": true,
    "helpText": "e.g., John Doe",
    "spec": [
      {
        "label": "Quantity",
        "name": "qty",
        "type": "number"
      },
      {
        "label": "Description",
        "name": "description",
        "type": "text"
      }
    ]
  }
]