List tasks
list_tasksRetrieve and filter Plannr CRM tasks by client, assignee, plan or case, priority, due date, status, and open-only to find items needing action.
Instructions
Tasks on the firm, filtered as GET /api/v1/task documents: by client, assignee, related plan or case, priority, due date range, open only, name or status. Each task has its status, priority, due date, what it relates to, who it is assigned to, its author and who completed it (include=author,completed_by). What a user sees depends on their Plannr role.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Task name (filter[name]) | |
| sort | No | Sort field; prefix with - for descending. The API's default is created_at. | |
| due_after | No | Only tasks due after this date (filter[due_after]) | |
| open_only | No | true: leave out tasks in the Completed and Archived columns (filter[open_tasks]) | |
| due_before | No | Only tasks due before this date (filter[due_before]) | |
| priorities | No | filter[priority] | |
| client_uuid | No | Only tasks for this client (filter[client_uuid]) | |
| max_results | No | Most records to return; lists are fetched 100 per request, up to 10 requests | |
| status_uuid | No | Only tasks in this status (filter[status_uuid]); see list_task_statuses | |
| related_type | No | Only tasks on a plan or on a case (filter[taskable_type]) | |
| related_uuid | No | Only tasks on this plan or case (filter[taskable_uuid]) | |
| assigned_to_uuids | No | Only tasks assigned to these accounts (filter[assigned_to_uuids]) | |
| include_contact_details | No | Include assignees' and authors' email addresses, and stop redacting emails, phone numbers and postcodes typed into task and client names. Off by default. |