Skip to content

Get template

Endpoint

GET /organizations/{org_id}/checklists/{checklist_id}

This endpoint retrieves the full details for a single process template (blueprint) identified by its unique ID.

Request

Replace {org_id} with your Organization ID and {checklist_id} with the specific ID of the template you want to retrieve.

Headers

  • Authorization: Bearer {your_access_token}
  • Accept: application/json
  • X-Tallyfy-Client: APIClient

Query parameters (optional)

  • with (string): A comma-separated list of related data to include (e.g., steps, runs, folder, threads, tags, assets, starredByUsers). Example: with=steps,tags
  • version (integer): Retrieve a specific version of the template.
  • type (string): Filter by type (e.g., procedure, form).
  • entire_folder_tree (string, "0" or "1"): Include the template’s full folder hierarchy.

Code samples

const accessToken = 'YOUR_PERSONAL_ACCESS_TOKEN';
const orgId = 'YOUR_ORGANIZATION_ID';
const checklistId = 'YOUR_TEMPLATE_ID'; // The ID of the template you want
const queryParams = '?with=steps,tags'; // Example: Include steps and tags
const apiUrl = `https://go.tallyfy.com/api/organizations/${orgId}/checklists/${checklistId}${queryParams}`;
const headers = new Headers();
headers.append('Authorization', `Bearer ${accessToken}`);
headers.append('Accept', 'application/json');
headers.append('X-Tallyfy-Client', 'APIClient');
fetch(apiUrl, {
method: 'GET',
headers: headers
})
.then(response => {
return response.json().then(data => { // Attempt to parse JSON regardless of status
if (!response.ok) {
console.error(`Failed to get template ${checklistId}:`, data);
throw new Error(`HTTP error! status: ${response.status}`);
}
return data; // Pass successful data along
});
})
.then(data => {
console.log(`Successfully retrieved template ${checklistId}:`);
console.log(JSON.stringify(data, null, 2));
})
.catch(error => {
console.error(`Error getting template ${checklistId}:`, error.message);
});

Response

A successful request returns a 200 OK status code and a JSON object containing a data field. The value of data is an object representing the requested template with its full details.

{
"data": {
"id": "YOUR_TEMPLATE_ID",
"title": "Customer Onboarding Process",
"summary": "Standard process for onboarding new customers.",
"starred": false,
"webhook": null,
"explanation_video": null,
"guidance": "Detailed guidance notes here.",
"icon": "fa-users",
"alias": "customer-onboarding-v2",
"prerun": [ // Kick-off form fields
{
"id": "prerun_field_1",
"checklist_id": "YOUR_TEMPLATE_ID",
"alias": "customer_name",
"field_type": "text",
// ... other prerun field properties ...
}
],
"automated_actions": [], // Rules
"created_by": 1001,
"owner_id": 1001,
"created_at": "2023-01-10T10:00:00.000Z",
"last_updated": "2023-05-15T14:30:00.00Z",
"archived_at": null,
"is_public": false,
// ... many other template properties ...
// Included if requested via 'with' parameter:
"steps": [
{
"id": "step_1_id",
"checklist_id": "YOUR_TEMPLATE_ID",
"alias": "welcome_call",
"title": "Schedule Welcome Call",
// ... other step properties ...
}
// ... more steps ...
],
"tags": [
{
"id": "tag_abc",
"title": "Onboarding",
"color": "#3498db"
}
]
}
}

If the template ID is not found or you don’t have permission, you will likely receive a 404 Not Found or 403 Forbidden error.


Templates > List templates

An API endpoint documentation for retrieving process templates from organizations with code examples in JavaScript Python Java and Go along with details about request headers query parameters and response format.

Processes > Get process

An API endpoint that retrieves detailed information about a specific process run through a GET request with optional parameters to include related data like checklists tasks and tags in the response.

Tasks > Get task

A GET endpoint retrieves comprehensive task details including status owners deadlines and form fields through unique organization and task IDs with optional related data parameters.