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

JavaScript (fetch)

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,fields'; // Example
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 => {
    if (!response.ok) {
        return response.json().then(errData => {
            throw new Error(`HTTP error! status: ${response.status}, message: ${JSON.stringify(errData)}`);
        }).catch(() => {
             throw new Error(`HTTP error! status: ${response.status}`);
        });
    }
    return response.json();
})
.then(data => {
    console.log(`Successfully retrieved template ${checklistId}:`);
    console.log(JSON.stringify(data, null, 2));
})
.catch(error => {
    console.error('Error getting template:', error);
});

Python (requests)

import requests
import json
import os

access_token = os.environ.get('TALLYFY_ACCESS_TOKEN', 'YOUR_PERSONAL_ACCESS_TOKEN')
org_id = os.environ.get('TALLYFY_ORG_ID', 'YOUR_ORGANIZATION_ID')
checklist_id = 'YOUR_TEMPLATE_ID' # The ID of the template you want
api_url = f'https://go.tallyfy.com/api/organizations/{org_id}/checklists/{checklist_id}'

headers = {
    'Authorization': f'Bearer {access_token}',
    'Accept': 'application/json',
    'X-Tallyfy-Client': 'APIClient'
}

# Optional: Add query parameters
params = {
     'with': 'steps,fields' # Example: include steps and fields
    # 'version': 2
}

try:
    response = requests.get(api_url, headers=headers, params=params)
    response.raise_for_status() # Check for HTTP errors

    template_data = response.json()
    print(f'Successfully retrieved template {checklist_id}:')
    print(json.dumps(template_data, indent=4))

except requests.exceptions.RequestException as e:
    print(f"Request failed: {e}")
    if response is not None:
        print(f"Response Status: {response.status_code}")
        try:
            print(f"Response Body: {response.json()}")
        except json.JSONDecodeError:
            print(f"Response Body: {response.text}")
except json.JSONDecodeError:
    print("Failed to decode JSON response")

Java (HttpClient)

import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.Map;
import java.util.stream.Collectors;

public class GetTemplate {

    public static void main(String[] args) {
        String accessToken = System.getenv().getOrDefault("TALLYFY_ACCESS_TOKEN", "YOUR_PERSONAL_ACCESS_TOKEN");
        String orgId = System.getenv().getOrDefault("TALLYFY_ORG_ID", "YOUR_ORGANIZATION_ID");
        String checklistId = "YOUR_TEMPLATE_ID"; // The ID of the template you want
        String baseUrl = "https://go.tallyfy.com/api/organizations/" + orgId + "/checklists/" + checklistId;

        // Optional: Build query parameters
        Map<String, String> queryParamsMap = Map.of(
            // "with", "steps,tags",
            // "version", "2"
        );
        String queryParams = queryParamsMap.entrySet().stream()
            .map(entry -> URLEncoder.encode(entry.getKey(), StandardCharsets.UTF_8) + "=" + URLEncoder.encode(entry.getValue(), StandardCharsets.UTF_8))
            .collect(Collectors.joining("&", "?", ""));

        String apiUrl = baseUrl + (queryParamsMap.isEmpty() ? "" : queryParams);

        HttpClient client = HttpClient.newBuilder()
                .connectTimeout(Duration.ofSeconds(10))
                .build();

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(apiUrl))
                .header("Authorization", "Bearer " + accessToken)
                .header("Accept", "application/json")
                .header("X-Tallyfy-Client", "APIClient")
                .GET()
                .build();

        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

            if (response.statusCode() == 200) {
                System.out.println("Successfully retrieved template " + checklistId + ":");
                System.out.println(response.body());
                // TODO: Parse the JSON response using Jackson or Gson
            } else {
                System.err.println("Failed to get template. Status: " + response.statusCode());
                System.err.println("Response: " + response.body());
            }
        } catch (IOException | InterruptedException e) {
            System.err.println("Request failed: " + e.getMessage());
            Thread.currentThread().interrupt();
        }
    }
}

Go (net/http)

package main

import (
  "fmt"
  "io/ioutil"
  "net/http"
  "net/url"
  "os"
  "time"
)

func main() {
  accessToken := os.Getenv("TALLYFY_ACCESS_TOKEN")
  if accessToken == "" {
    accessToken = "YOUR_PERSONAL_ACCESS_TOKEN"
  }
  orgId := os.Getenv("TALLYFY_ORG_ID")
  if orgId == "" {
    orgId = "YOUR_ORGANIZATION_ID"
  }
  checklistId := "YOUR_TEMPLATE_ID" // The ID of the template you want

  baseURL := fmt.Sprintf("https://go.tallyfy.com/api/organizations/%s/checklists/%s", orgId, checklistId)

  // Optional: Add query parameters
  queryParams := url.Values{}
  queryParams.Set("with", "steps,fields") // Example

  apiUrl := baseURL
  if len(queryParams) > 0 {
    apiUrl = baseURL + "?" + queryParams.Encode()
  }

  client := &http.Client{Timeout: 15 * time.Second}
  req, err := http.NewRequest("GET", apiUrl, nil)
  if err != nil {
    fmt.Printf("Error creating request: %v\n", err)
    return
  }

  req.Header.Set("Authorization", "Bearer "+accessToken)
  req.Header.Set("Accept", "application/json")
  req.Header.Set("X-Tallyfy-Client", "APIClient")

  resp, err := client.Do(req)
  if err != nil {
    fmt.Printf("Error making GET request: %v\n", err)
    return
  }
  defer resp.Body.Close()

  body, err := ioutil.ReadAll(resp.Body)
  if err != nil {
    fmt.Printf("Error reading response body: %v\n", err)
    return
  }

  if resp.StatusCode != http.StatusOK {
    fmt.Printf("Request failed getting template %s. Status code %d\nBody: %s\n", checklistId, resp.StatusCode, string(body))
    return
  }

  fmt.Printf("Successfully retrieved template %s:\n", checklistId)
  fmt.Println(string(body))
  // TODO: Unmarshal JSON using encoding/json
}

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.

---

Related articles

Templates > List templates

Retrieve a list of all templates.

Templates > Create template

Create a new process template.

Templates > Update template

Modify this template’s details.