Get task checklist responses

Returns the checklist answers staff gave on a completed task.

GET https://cotlet.dev/api/v1/breezeway/tasks/{task_id}/checklist

read

Returns each requirement with section, action text, the response, any note, whether a photo was required and how many photos are attached. Only tasks started from a template have a checklist; others return an empty list.

Parameters

Parameters: get_task_checklist
NameTypeDescription
task_id integer required integer Breezeway task ID.

Request

cURL
curl https://cotlet.dev/api/v1/breezeway/tasks/1/checklist \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("breezeway", "get_task_checklist", {"task_id":1})
Node.js
const result = await cotlet.call('breezeway', 'get_task_checklist', {"task_id":1});
CLI
cotlet call breezeway get_task_checklist --data '{"task_id":1}'

Example response

JSON

{
  "requirements": [
    {
      "section": "Bathroom",
      "action": "Fold clean linens",
      "response": "check",
      "note": null,
      "photo_required": true,
      "photos": 0
    },
    {
      "section": "Kitchen",
      "action": "Wipe the oven",
      "response": "check",
      "note": null,
      "photo_required": false,
      "photos": 0
    }
  ]
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.