Templates
Endpoints for retrieving templates, their tasks, and the controls within those tasks. These endpoints are typically used to look up keys needed by other API calls.
List Templates
Returns the key and name of every active template in your team.
GET /api/template/templates
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Example Request
GET https://app.checkflow.io/api/template/templates
X-API-KEY: your-api-key-here
Example Response
[
{ "id": "0e7ad584-7788-4ab1-95a6-ca0a5b444cbb", "name": "Invoice Review" },
{ "id": "1a2bc345-6789-4def-a012-b345cde67890", "name": "Onboarding Checklist" }
]
Response Codes
| Code | Description |
|---|---|
200 | Returns the list of active templates. |
401 | API key is missing or invalid. |
404 | No active templates found. |
List Template Tasks
Returns the key and name of every task in a template.
GET /api/template/tasks
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
templateKey | string (GUID) | Yes | The key of the template. Use List Templates to find the key. |
Example Request
GET https://app.checkflow.io/api/template/tasks?templateKey=0e7ad584-7788-4ab1-95a6-ca0a5b444cbb
X-API-KEY: your-api-key-here
Example Response
[
{ "id": "07072bc4-f1eb-4536-819a-1ddb7dc109a1", "name": "Step 1: Review Invoice" },
{ "id": "50d58518-e049-4474-84c7-036236e52923", "name": "Step 2: Approve Payment" }
]
Response Codes
| Code | Description |
|---|---|
200 | Returns the list of tasks for the template. |
401 | API key is missing or invalid. |
404 | No tasks found for the template. |
List Task Controls
Returns the controls within a task, filtered by control type. Use this to find the keys of specific controls that you want to read from or write to via the API.
GET /api/template/task-content
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | Your API key |
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskKey | string (GUID) | Yes | — | The key of the task. Use List Template Tasks to find the key. |
contentType | string | No | ALL | Filters results by control type. See supported values below. |
Supported contentType Values
| Value | Description |
|---|---|
ALL | Returns all controls |
ALLINPUT | Returns all input controls only |
ShortText | Short Text controls |
LongText | Long Text controls |
EmailInput | Email controls |
Website | Website controls |
Date | Date & Time controls |
DropDown | Dropdown controls |
MultiChoice | Multi-Choice controls |
SubTasks | Sub-Tasks controls |
Members | Members controls |
Table | Table controls |
File | File (content) controls |
FileUpload | File Upload controls |
Image | Image controls |
Video | Video controls |
Text | Text (rich text) controls |
Example Request
GET https://app.checkflow.io/api/template/task-content?taskKey=07072bc4-f1eb-4536-819a-1ddb7dc109a1&contentType=ALLINPUT
X-API-KEY: your-api-key-here
Example Response
[
{ "id": "4cb6f84c-950f-4424-aa7b-d12608419d9b", "name": "Customer Name", "type": "ShortText" },
{ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Invoice Date", "type": "Date" }
]
Response Codes
| Code | Description |
|---|---|
200 | Returns the matching controls. |
401 | API key is missing or invalid. |
404 | No controls found. |