Form templates

List form templates

Lists the tenant's templates, paginated, optionally by status.

GET
/form-templates

Lists the tenant's templates, paginated, optionally by status.

Authorization

x-api-key<token>

The per-tenant API key, copied from Settings → API & integrations. Sent as the x-api-key request header. The key is tenant-scoped and acts with Admin-equivalent, tenant-wide access.

In: header

Query Parameters

limit?integer

Page size, 1–200. Defaults to 50.

cursor?string

Opaque cursor from a previous page's nextCursor. Omit for the first page.

status?string

Filter by lifecycle status.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/form-templates"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "projectRequired": true,      "fillableBy": "all_crew",      "status": "active",      "blocks": [        {          "id": "string",          "kind": "heading",          "label": "string",          "required": true,          "options": [            "string"          ],          "items": [            "string"          ],          "lockToToday": true        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": "string"}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid API key."  }}
{  "error": {    "code": "validation",    "message": "One or more inputs are invalid.",    "fields": {      "fieldName": "A message explaining what's wrong with this field."    }  }}

Get a form template GET

Fetch a single form template, including its field definitions.

Update or archive/unarchive a form template PATCH

Edits name, project-required, the `fillableBy` audience, and/or blocks, and/or flips status (`{ "status": "archived" }` / `{ "status": "active" }`). Field edits apply first, then the status change.