Tasks
Get a task
Returns the detail of a task by its identifier.
tasks:readtasks:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Arguments
Task identifier.
Limits: min length 1
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.
The same operation by REST
This tool runs GET /api/v1/tasks/{taskId}.
Related pages
Link to this section: Related pagesTasks
Get a task
Returns the detail of a task by its identifier.
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?