Form templates

Get a form template

Fetch a single form template, including its field definitions.

GET
/form-templates/{id}

Fetch a single form template, including its field definitions.

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

Path Parameters

id*string

Resource id.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/form-templates/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "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"}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid API key."  }}
{  "error": {    "code": "not_found",    "message": "Not found."  }}