List Tasks
Retrieve a paginated list of tasks, with optional filtering by board, status, assigned user, archive state, template flag, and tag.
Example Requests:
List all tasks:
curl "https://<your-agency>.smartmatchapp.com/api3/tasks/" \
-u <token>: \
-X GET
Filter by board and status:
curl "https://<your-agency>.smartmatchapp.com/api3/tasks/?board_id=1&status_id=2" \
-u <token>: \
-X GET
List active tasks with pagination:
curl "https://<your-agency>.smartmatchapp.com/api3/tasks/?is_archived=false&count=50&offset=0" \
-u <token>: \
-X GET
Filter by tag:
curl "https://<your-agency>.smartmatchapp.com/api3/tasks/?tag_id=5" \
-u <token>: \
-X GET
Request Parameters:
board_id: (Optional) Filter tasks by board ID.
status_id: (Optional) Filter tasks by status ID.
assigned_user_id: (Optional) Filter tasks by the assigned agency user ID.
is_archived: (Optional) Filter by archive state. Accepts true or false.
is_template: (Optional) Filter by template flag. Accepts true or false.
tag_id: (Optional) Filter tasks by tag ID. Returns only tasks with the specified tag attached.
count: (Optional) Number of results to return. Default is 20.
offset: (Optional) Number of results to skip. Default is 0.
Example Success Response:
{
"count": 20,
"offset": 0,
"total_count": 2,
"objects": [
{
"id": 42,
"title": "Follow up with client",
"is_archived": false,
"is_template": false,
"priority": 2,
"due_date": "2026-03-15",
"user_assigned_id": 5,
"board_id": 1,
"status_new_id": 2,
"folder_id": null
},
{
"id": 41,
"title": "Send contract",
"is_archived": false,
"is_template": false,
"priority": 3,
"due_date": null,
"user_assigned_id": null,
"board_id": 1,
"status_new_id": 1,
"folder_id": 3
}
]
}
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" |
| 405 | Method Not Allowed |
This error occurs if an HTTP method other than GET is used. |
| 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" |