SmartMatchApp

List Task Checklists

Retrieve all checklist groups associated with a specific task, including their completion progress.

Example Request:
curl "https://<your-agency>.smartmatchapp.com/api3/tasks/<task_id>/checklists/" \
    -u <token>: \
    -X GET
Example Success Response:
{
    "objects": [
        {
            "id": 1,
            "title": "Pre-call checklist",
            "total": 3,
            "done": 1
        },
        {
            "id": 2,
            "title": "Post-call actions",
            "total": 2,
            "done": 0
        }
    ]
}

total is the total number of items in the checklist. done is the number of checked items.

Base Request:

Method: GET

Authentication: Basic Authentication. Requires a valid <token> passed.

Rate Limits:

30 requests within 5 seconds

Error Responses:
401 Unauthorized

This error occurs when the <token> is missing, invalid, or the API access is disabled.

Possible errors: "not authenticated" or "token is disabled" or "Agency API is disabled"
404 Not Found

This error occurs if the task with the specified ID does not exist.
Possible errors: "object does not exist"
405 Method Not Allowed

This error occurs if an HTTP method other than GET is used.
Possible errors: "wrong method"
429 Too Many Requests

This error occurs when the client has sent too many requests in a given amount of time, leading to rate limiting by the server.

Possible errors: "too many requests"
500 Server Error

Possible errors: "Internal server error"