Tasks
List tasks
Returns the tasks and schedule events, cursor-paginated.
tasks:readtasks:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Strict per-subscription tenancy.
Arguments
Page size (1-500). Defaults to 50.
Limits: min 1, max 500
Opaque cursor of the page to return. Pass the value of pagination. from the previous response; treat it as opaque.
Limits: max length 200
Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, startDate, endDate, title, isCompleted, type. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.
Limits: max length 200
Start of the overlap window (ISO 8601 with offset): returns tasks that overlap [from, to] (a task that starts before and ends within counts).
End of the overlap window (ISO 8601 with offset): returns tasks that overlap [from, to].
Filter by assigned staff member (the same identifier that assignedStaffIds exposes in the DTO).
Limits: min length 1, max length 100
Filter by assignedStaffId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Limits: min 1 items, max 50 items, each min length 1, each max length 100
Filter by completion: "true" only completed tasks, "false" only pending tasks. Omit it to apply no filter.
Filter by task type: its identifier (system types: default, delivery, return, temporaryStock; custom types: their id) or its name, matched ignoring case and accents. A name that matches no type yields an empty list; one that matches several is rejected with 400.
Limits: min length 1, max length 100
Filter by type, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Limits: min 1 items, max 50 items, each min length 1, each max length 100
Set it to true to include pagination., the number of results that match the filters across all pages. Off by default.
Date filters by field. A bare day (YYYY-MM-DD) is read in the business timezone; an ISO 8601 instant with offset is applied as is by gte, lte, gt and lt, while on widens it to the whole business day that contains it. Fields: created, due, updated.
Show child attributesHide child attributes
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique task identifier.
Task title.
Task description or notes; null if it has none.
Start date and time in ISO 8601 with offset.
End date and time in ISO 8601 with offset; null if it has no defined end.
Whether the task is all-day.
Whether the task is completed.
Whether the task is part of a recurring series.
Identifier of the recurrence group it belongs to; null if it is not recurring.
Recurrence pattern of the task; null if it is not recurring.
Show child attributesHide child attributes
Recurrence frequency: daily, weekly, monthly or yearly.
Available options: daily, weekly, monthly, yearly
Interval between repetitions according to the frequency (e.g. 2 with weekly = every two weeks).
Number of repetitions after which the recurrence ends; null if it does not end by number of occurrences.
Date on which the recurrence ends, in ISO 8601 with offset; null if it does not end by date.
Task type (identifier of the type).
Identifiers of the staff assigned to the task.
Identifier of the linked project; null if the task is not linked.
Appearance of the task in the schedule (color and variant).
Show child attributesHide child attributes
Task color in the schedule (hexadecimal code).
Visual variant of the task: primary, secondary, destructive or default.
Available options: primary, secondary, destructive, default
Creation date in ISO 8601 with offset.
Last update date in ISO 8601 with offset.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
Sample prompts
Show the open tasks due this week, grouped by who they are assigned to.
The same operation by REST
This tool runs GET /api/v1/tasks.
Related pages
Link to this section: Related pagesTasks
List tasks
Returns the tasks and schedule events, cursor-paginated.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?