Skip to main content

​
What is a Checklist ID?

A checklist ID is a unique identifier assigned to each individual checklist within a project task. Each checklist contains one or more items and is associated with a specific task. It’s required for making API requests that interact with specific checklists, such as marking checklist items as completed in time entries.

​
Step-by-Step Instructions

1

Make the API request

Send a GET request to the Get project details API endpoint, including your API key in the request header.
2

Parse the response

The response will contain a checklists array with individual checklist objects, each containing an id field. Each checklist is associated with a specific task and contains one or more checklist items.Example:
{
  "project": { ... },
  "tasks": [ ... ],
  "checklists": [
    {
      "id": "6725d555-752a-4e40-bfef-9d87682b15ec",
      "task_name": "UI Design",
      "items": ["Create wireframes"],
      "required": [true]
    },
    {
      "id": "7fbf0f63-bf11-4126-bd97-c3f557583974",
      "task_name": "Frontend Development",
      "items": ["Write unit tests"],
      "required": [true]
    }
  ]
}
3

Extract the checklist ID

Here the checklist ID for the UI Design task is: 6725d555-752a-4e40-bfef-9d87682b15ec.You can access the checklist ID in your code from the response using:
// Get the first checklist's ID
const checklistId = response.checklists[0].id;

// Or iterate through all checklists to find a specific one
const uiDesignChecklist = response.checklists.find(checklist => checklist.task_name === "UI Design");
const uiDesignChecklistId = uiDesignChecklist.id;