Tracker MCP tools¶
187 tools.
tracker_me_get¶
Get current Tracker user · read-only
The authenticated Yandex Tracker user (a safe auth probe).
tracker_issues_get¶
Get Tracker issue · read-only
A single Tracker issue by key.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
expand |
string or null | Extra blocks to include in the reply. | |
fields |
string or null | Comma-separated fields to include in the reply. |
tracker_issues_list¶
List Tracker issues · read-only
Issues matching the supplied filters (omitted filters dropped), auto-paginated.
Returns at most limit issues; exactly limit back means more may match — narrow the
filters or raise limit.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue |
string or null | Queue key, e.g. QUEUE. | |
status |
string or null | Status key, e.g. open. | |
assignee |
string or null | Assignee login or id. | |
epic |
string or null | Epic issue key. | |
issue_type |
string or null | Issue type key, e.g. bug or task. | |
limit |
integer or null | Max issues to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
tracker_issues_search¶
Search Tracker issues · read-only
Issues matching a query-language string or a filter, auto-paginated.
body.query is a TQL string, body.filter a field → value object. Returns at most
limit issues; truncated says more may match, and next goes on. A token of a
scroll (scroll_type) works once: used again, it gives the portion after. E.g.
{"body": {"query": "Queue: QUEUE Status: open"}} or
{"body": {"filter": {"queue": "QUEUE", "assignee": "ann"}}}.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /issues/_search and POST /issues/_count. Give query (the query language) or filter (field name → value); a body with neither matches every issue the caller can see. extra="allow" passes the API's other keys (keys, queue, order) through. |
limit |
integer or null | Max issues to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
|
expand |
string or null | Extra blocks to include in the reply. | |
scroll_type |
sorted · unsorted or string or null |
Scroll through the results (no 10 000 cap). | |
per_scroll |
integer or null | Issues per scroll page (1000 at most). | |
scroll_ttl_millis |
integer or null | How long the scroll stays open, in milliseconds. |
tracker_issues_count¶
Count Tracker issues · read-only
Count of issues matching a query-language string or a filter.
body.query is a TQL string, body.filter a field → value object; an empty body
counts every issue the caller can see. E.g.
{"body": {"filter": {"queue": "QUEUE", "status": "open"}}}.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /issues/_search and POST /issues/_count. Give query (the query language) or filter (field name → value); a body with neither matches every issue the caller can see. extra="allow" passes the API's other keys (keys, queue, order) through. |
tracker_issues_suggest¶
Suggest Tracker issues by title · read-only
Typeahead over visible issues — issues whose summary contains text.
A lightweight title match; for full TQL search use issues_search.
| Parameter | Type | Required | Description |
|---|---|---|---|
text |
string | yes | Text fragment to match in issue summaries. |
queue |
string or null | Key of the queue to search in. | |
full |
boolean or null | Return each issue in full; needed for fields, expand, embed. |
|
fields |
string or null | Comma-separated fields to include in the reply. | |
expand |
string or null | Extra blocks to include in the reply. | |
embed |
string or null | Blocks of expand to return in more detail. |
tracker_issues_create¶
Create Tracker issue · write
Create a Tracker issue; returns the new issue with its key.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /issues/ (create an issue). Covers the common fields; extra="allow" lets any custom (global or queue-local) field pass through unvalidated. type/priority accept either a bare key string or a {"key": ...} object (both are valid per the Tracker API); the CLI sends the object form. |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_issues_update¶
Update Tracker issue · idempotent write
Update fields of a Tracker issue; only the keys present in body are changed.
Status is NOT changed here — use transitions_execute. Returns the updated issue.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
body |
object | yes | Typed request body for PATCH /issues/{key} (update an issue; only sent fields change). extra="allow" lets any custom field pass through unvalidated. Status is NOT changed here — use transitions_execute. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_issues_move¶
Move Tracker issue · write
Move a Tracker issue to another queue (it gets a new key there; the old key redirects).
queue is the target queue key. Fields that do not exist in the target queue may be
dropped. Returns the moved issue with its new key.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
queue |
string | yes | Target queue key, e.g. NEW. |
expand |
string or null | Extra blocks to include in the reply. | |
initial_status |
boolean or null | Reset the status to the new queue's initial one. | |
move_all_fields |
boolean or null | Keep the versions, components and projects the new queue also has. | |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
notify_author |
boolean or null | Notify the author of the change; omitted, the API does not. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_issues_scroll_clear¶
Clear Tracker search scroll · idempotent write
Release the scroll of an issue search before it expires (harmless housekeeping).
Only a search by a scroll (scroll_type) has something to release; after this its
next goes on nowhere. Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
next |
string | yes | The next a search by a scroll returned: it names the scroll. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_issues_update_bulk¶
Bulk-update Tracker issues · write
Start an async bulk field update over many Tracker issues; returns the operation.
Poll the returned operation id with bulk_get and inspect failures with
bulk_issues_list.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /bulkchange/_update (mass-edit issues). |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_issues_move_bulk¶
Bulk-move Tracker issues · write
Start an async bulk move of many Tracker issues to another queue; returns the operation.
Poll with bulk_get.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /bulkchange/_move (mass-move issues to another queue). |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_issues_transition_bulk¶
Bulk-transition Tracker issues · write
Start an async bulk status transition over many Tracker issues; returns the operation.
Poll with bulk_get.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /bulkchange/_transition (mass status transition). |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_issues_import¶
Import Tracker issue · write
Import an issue preserving its original history (admin-only back-fill).
Returns the imported issue.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed body for POST /issues/_import — import one issue, preserving its history. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_comments_list¶
List Tracker issue comments · read-only
All comments on a Tracker issue, auto-paginated via the relative id-cursor.
Capped at the configured item cap unless limit is given, so very long threads
are truncated at the cap rather than fetched forever.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
limit |
integer or null | Max comments to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
|
expand |
string or null | Extra blocks to include in the reply. |
tracker_comments_get¶
Get Tracker issue comment · read-only
One comment of a Tracker issue: text, author, edit history and, on request, attachments.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
comment_id |
integer or string | yes | Comment id (numeric id or longId), from comments_list. |
expand |
string or null | Extra fields: attachments, html or all (comma-separated). |
tracker_comments_create¶
Add Tracker issue comment · write
Add a comment to a Tracker issue; returns the created comment.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
body |
object | yes | Typed request body for adding a comment to an issue or an entity. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_comments_update¶
Edit Tracker issue comment · idempotent write
Replace the text of an existing comment on a Tracker issue.
Get comment_id from comments_list. Returns the updated comment.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
comment_id |
integer or string | yes | Comment id (numeric id or longId), from comments_list. |
body |
object | yes | Typed request body for PATCH /issues/{key}/comments/{id} (edit a comment). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_comments_delete¶
Delete Tracker issue comment · destructive write
Permanently delete one comment from a Tracker issue (irreversible).
Get comment_id from comments_list. Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
comment_id |
integer or string | yes | Comment id (numeric id or longId), from comments_list. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_comments_reactions_create¶
React to Tracker issue comment · write
Add an emoji reaction to a comment on a Tracker issue.
name is the reaction name (e.g. like, dislike, fire). Returns the comment
with its updated reactions.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
comment_id |
integer or string | yes | Comment id (numeric id or longId), from comments_list. |
name |
string | yes | Reaction name, e.g. like, dislike or fire. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_comments_import¶
Import Tracker issue comment · write
Import a comment onto an issue preserving its original author and timestamp (admin-only).
Returns the imported comment.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
body |
object | yes | Typed body for POST /issues/{key}/comments/_import — import one comment with history. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_links_list¶
List Tracker issue links · read-only
All links on a Tracker issue (linked issues, type, direction).
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
tracker_links_list_filtered¶
Search Tracker issue links · read-only
Links of a Tracker issue filtered by type, paged and capped (a read done via POST).
Prefer this over links_list for issues with many links or when only some link types
or fields matter; it carries each link's author, dates, assignee and status.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
link_types |
array of string or null | Keep only links with these relationships, e.g. relates or is subtask for (the phrases of links_create, not linktypes ids). |
|
fields |
array of string or null | Fields to include in each link; all when omitted. | |
limit |
integer or null | Max links to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
tracker_links_create¶
Link Tracker issues · write
Link a Tracker issue to another issue; returns the created link.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
body |
object | yes | Typed request body for POST /issues/{key}/links (link to another issue). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_links_delete¶
Delete Tracker issue link · destructive write
Remove a link between two Tracker issues (irreversible).
Get link_id from links_list. Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
link_id |
string | yes | Link id, from links_list. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_links_import¶
Import Tracker issue link · write
Import an issue link preserving its original creation metadata (admin-only).
Returns the imported link.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
body |
object | yes | Typed body for POST /issues/{key}/links/_import — import one issue link with history. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_transitions_list¶
List Tracker issue transitions · read-only
Available workflow transitions for a Tracker issue.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
tracker_transitions_execute¶
Execute Tracker issue transition · write
Move a Tracker issue through a workflow transition (change its status).
Get transition_id from transitions_list. body may be empty or carry issue
fields to set on transition, e.g. a resolution when closing. Returns the transitions
available from the new status.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
transition_id |
string | yes | Transition id, from transitions_list. |
body |
object | yes | Typed request body for POST /issues/{key}/transitions/{id}/_execute. Open-ended: any issue field can be set on transition (e.g. a resolution when closing), so extra="allow" lets arbitrary fields pass through unvalidated while the common fields below still document themselves in the MCP schema. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_worklog_list¶
List Tracker worklog · read-only
All time-tracking entries logged against a single Tracker issue.
Auto-paginated via the relative id-cursor. Capped at the configured item cap unless limit
is given.
Scoped to one issue by issue_key. To search worklog across the whole org (by author and/or a
creation-time range) use worklog_search instead.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
limit |
integer or null | Max records to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
tracker_worklog_search¶
Search Tracker worklog · read-only
Org-wide worklog entries filtered by author and/or a creation-time range.
Unlike worklog_list (one issue), this searches every issue's worklog. body.createdBy
scopes to a user and body.createdAt to a time window; both are optional. E.g.
{"body": {"createdBy": "ann", "createdAt": {"from": "2026-01-01T00:00:00"}}}.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /worklog/_search: by author, by creation time, or both. |
tracker_worklog_list_global¶
List Tracker org-wide worklog · read-only
Org-wide worklog entries via GET /worklog query filters (author, creation time).
A lighter sibling of worklog_search; every filter is optional.
| Parameter | Type | Required | Description |
|---|---|---|---|
created_by |
string or null | Login or id of the record author to filter by. | |
created_from |
string or null | Start of the creation-time range (YYYY-MM-DDThh:mm:ss). |
|
created_to |
string or null | End of the creation-time range (YYYY-MM-DDThh:mm:ss). |
tracker_worklog_create¶
Add Tracker worklog record · write
Log spent time on a Tracker issue; returns the created worklog record.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
body |
object | yes | Typed request body for POST /issues/{key}/worklog (log time spent). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_worklog_update¶
Edit Tracker worklog record · idempotent write
Edit a worklog record on a Tracker issue (duration and/or comment).
Get record_id from worklog_list. Returns the updated record.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
record_id |
string | yes | Worklog record id, from worklog_list. |
body |
object | yes | Typed request body for PATCH /issues/{key}/worklog/{record_id} (edit an entry). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_worklog_delete¶
Delete Tracker worklog record · destructive write
Permanently delete a worklog record from a Tracker issue (irreversible).
Get record_id from worklog_list. Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
record_id |
string | yes | Worklog record id, from worklog_list. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_worklog_import¶
Import Tracker worklog record · write
Import a worklog record preserving its original author and timestamps (admin-only).
Returns the imported record(s) — the endpoint answers with a JSON array.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
body |
object | yes | Typed body for POST /issues/{key}/worklogs/_import — import one worklog with history. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_changelog_list¶
List Tracker issue changelog · read-only
Full changelog (edit history) for a Tracker issue.
Auto-paginated via the relative id-cursor. Capped at the configured item cap unless limit
is given.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
limit |
integer or null | Max changes to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
|
field |
string or null | Keep the changes of this field, e.g. status. |
|
change_type |
string or null | Keep the changes of this type, e.g. IssueWorkflow. |
|
sort |
asc · desc or string or null |
Order of the changes. |
tracker_checklists_list¶
Get Tracker issue checklist · read-only
The checklist items on a Tracker issue (text, done flag, assignee, per-item deadline).
Returns a flat array; an issue with no checklist yields an empty list. Item ids from here
feed checklists_update / checklists_delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
tracker_checklists_create¶
Add Tracker checklist item · write
Add an item to a Tracker issue's checklist (creates the checklist if absent).
Returns the issue with its full checklist.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
body |
object | yes | Typed request body for POST /issues/{key}/checklistItems (add an item). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_checklists_update¶
Edit Tracker checklist item · idempotent write
Edit one checklist item on a Tracker issue (text, checked state, assignee, deadline).
Get item_id from checklists_list. Returns the issue with its updated checklist.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
item_id |
string | yes | Checklist item id, from checklists_list. |
body |
object | yes | Typed request body for PATCH /issues/{key}/checklistItems/{item_id} (edit an item). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_checklists_delete¶
Delete Tracker checklist item · destructive write
Permanently remove one item from a Tracker issue's checklist (irreversible).
Get item_id from checklists_list. Returns the issue with its remaining checklist.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
item_id |
string | yes | Checklist item id, from checklists_list. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_checklists_clear¶
Clear Tracker issue checklist · destructive write
Permanently delete the ENTIRE checklist of a Tracker issue (all items, irreversible).
Returns the issue without its checklist.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_columns_list¶
List Tracker board columns · read-only
Every column defined on the given agile board.
Each column carries the issue statuses whose cards land in it. Use this to inspect a board's
column layout; use columns_get when you already know a column id, and boards_get for
the board itself.
| Parameter | Type | Required | Description |
|---|---|---|---|
board_id |
integer | yes | Numeric identifier of the board whose columns to list. |
tracker_columns_get¶
Get Tracker board column · read-only
Look up a single board column by its numeric id.
The column includes the issue statuses grouped into it. Use this when you already know the
board and column ids; use columns_list to enumerate every column on a board.
| Parameter | Type | Required | Description |
|---|---|---|---|
board_id |
integer | yes | Numeric identifier of the board. |
column_id |
integer | yes | Numeric identifier of the column. |
tracker_columns_create¶
Create Tracker board column · write
Add a column to an agile board; returns the new column.
name and statuses (the issue-status keys whose cards land in the column) are
required; limit optionally caps the number of issues allowed in the column.
| Parameter | Type | Required | Description |
|---|---|---|---|
board_id |
integer | yes | Numeric identifier of the agile board. |
body |
object | yes | Typed request body for columns.create (POST /boards/{board_id}/columns/). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_columns_update¶
Edit Tracker board column · idempotent write
Edit a board column; only the fields set in body are changed.
Get column_id from columns_list. Returns the updated column.
| Parameter | Type | Required | Description |
|---|---|---|---|
board_id |
integer | yes | Numeric identifier of the agile board. |
column_id |
integer | yes | Numeric identifier of the board column. |
body |
object | yes | Typed request body for columns.edit (PATCH /boards/{board_id}/columns/{column_id}). Every field is optional; only the fields you set are sent. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_columns_delete¶
Delete Tracker board column · destructive write
Permanently remove a column from an agile board (irreversible).
Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
board_id |
integer | yes | Numeric identifier of the agile board. |
column_id |
integer | yes | Numeric identifier of the board column. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_priorities_list¶
List Tracker priorities · read-only
All available issue priorities in the organisation.
| Parameter | Type | Required | Description |
|---|---|---|---|
localized |
boolean or null | false returns the names in every language. |
tracker_priorities_create¶
Create Tracker priority · write
Create an org-global issue priority.
CAUTION: priorities are organisation-wide and have no delete endpoint — creation leaves
permanent residue. key is the latin identifier; name holds the ru/en display names.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /priorities/ (create a priority). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_priorities_update¶
Edit Tracker priority · idempotent write
Edit an issue priority; only the fields set in body are changed.
priority_id is the numeric id (not the key). Pass version to guard against
concurrent edits (optimistic locking).
| Parameter | Type | Required | Description |
|---|---|---|---|
priority_id |
string | yes | Priority id or key, from priorities_list. |
body |
object | yes | Typed request body for PATCH /priorities/{id}?version= (edit a priority). Only the fields that are set are sent, so omitted fields stay unchanged. |
version |
integer or null | Current version of the object (optimistic lock), from its get/list tool. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_issuetypes_list¶
List Tracker issue types · read-only
All available issue types (e.g. task, bug, epic).
tracker_issuetypes_create¶
Create Tracker issue type · write
Create an org-global issue type (e.g. a new kind of task).
CAUTION: issue types are organisation-wide and have no delete endpoint — creation leaves
permanent residue. key is the latin identifier; name holds the ru/en display names.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /issuetypes/ (create an issue type). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_issuetypes_update¶
Edit Tracker issue type · idempotent write
Edit an org-global issue type; only the fields set in body are changed.
issue_type_id is the numeric id (not the key). Pass version to guard against
concurrent edits (optimistic locking).
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_type_id |
string | yes | Issue type id or key, from issuetypes_list. |
body |
object | yes | Typed request body for PATCH /issuetypes/{id}?version= (edit an issue type). Only the fields that are set are sent, so omitted fields stay unchanged. |
version |
integer or null | Current version of the object (optimistic lock), from its get/list tool. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_linktypes_list¶
List Tracker link types · read-only
All available link types (e.g. relates, depends on, blocks).
tracker_users_get¶
Get Tracker user · read-only
Look up a single organisation user account by login or uid.
The account includes name, email and licence/dismissal status. Use this when you already know
one user; use users_list to browse or enumerate the whole directory. Pass
expand="groups" to include the user's groups.
| Parameter | Type | Required | Description |
|---|---|---|---|
login_or_id |
string | yes | User login or numeric uid; for a digits-only login use login: |
expand |
string or null | Extra data to include in the response, e.g. groups. |
tracker_users_list¶
List Tracker users · read-only
All users registered in the organisation, sorted by ascending uid.
Auto-paginated via the relative id-cursor. Capped at the configured item cap unless limit
is given; use users_get instead when you already know the specific login or uid.
| Parameter | Type | Required | Description |
|---|---|---|---|
limit |
integer or null | Max users to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
|
expand |
string or null | Extra data to include per user, e.g. groups. |
tracker_statuses_list¶
List Tracker statuses · read-only
Every issue status configured in the organisation's workflows.
Each status has a key, a name and a type such as new/inProgress/done. Use this to resolve or
validate a status key before filtering or transitioning issues; see resolutions_list for
close-out results and priorities_list for priorities.
tracker_statuses_create¶
Create Tracker status · write
Create an org-global issue status for use in workflows.
CAUTION: statuses are organisation-wide and have no delete endpoint — creation leaves
permanent residue. key is the latin identifier, name holds the ru/en display names,
type is the stage kind (new/inProgress/paused/done/cancelled).
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /statuses/ (create an issue status). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_statuses_update¶
Edit Tracker status · idempotent write
Edit an issue status; only the fields set in body are changed.
status_id is the numeric id (not the key). Pass version to guard against concurrent
edits (optimistic locking).
| Parameter | Type | Required | Description |
|---|---|---|---|
status_id |
string | yes | Status id or key, from statuses_list. |
body |
object | yes | Typed request body for PATCH /statuses/{id}?version= (edit a status). Only the fields that are set are sent, so omitted fields stay unchanged. |
version |
integer or null | Current version of the object (optimistic lock), from its get/list tool. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_resolutions_list¶
List Tracker resolutions · read-only
Every issue resolution configured in the organisation.
A resolution is the close-out result such as fixed/duplicate/won't-fix. Use this to resolve
or validate a resolution key when reading a closed issue or filtering; see statuses_list
for workflow stages, not close-out reasons.
tracker_resolutions_create¶
Create Tracker resolution · write
Create an org-global issue resolution (a close-out reason such as fixed/duplicate).
CAUTION: resolutions are organisation-wide and have no delete endpoint — creation leaves
permanent residue. key is the latin identifier; name holds the ru/en display names.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /resolutions/ (create a resolution). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_resolutions_update¶
Edit Tracker resolution · idempotent write
Edit an issue resolution; only the fields set in body are changed.
resolution_id is the numeric id (not the key). Pass version to guard against
concurrent edits (optimistic locking).
| Parameter | Type | Required | Description |
|---|---|---|---|
resolution_id |
string | yes | Resolution id or key, from resolutions_list. |
body |
object | yes | Typed request body for PATCH /resolutions/{id}?version= (edit a resolution). Only the fields that are set are sent, so omitted fields stay unchanged. |
version |
integer or null | Current version of the object (optimistic lock), from its get/list tool. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_queues_list¶
List Tracker queues · read-only
Every queue the caller can see, auto-paginated over the API's page/perPage pages.
Capped at the configured item cap unless limit is given. Each item's key is the
queue key (e.g. TEST) you pass to queues_get and use as an issue prefix (TEST-123). Use
queues_get for a single queue's full configuration (types, workflows, resolutions).
| Parameter | Type | Required | Description |
|---|---|---|---|
limit |
integer or null | Max queues to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
|
expand |
string or null | Extra blocks to include in the reply. |
tracker_queues_get¶
Get Tracker queue · read-only
One queue's settings and configuration by key or id.
Returns the queue's owner, default type/priority, and — when expand is set — its issue
types, versions, team, workflows and per-type resolution config. Sibling queues_list
enumerates every queue; pass one of its key values here.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
expand |
string or null | Extra blocks to include, e.g. 'all' or a comma list of projects,components,versions,types,team,workflows,fields,issueTypesConfig. |
tracker_queues_tags_list¶
List Tracker queue tags · read-only
Every tag name that has been added to the queue, as a flat string array.
These are the tags selectable on the queue's issues (the tags field). Remove one
everywhere with queues_tags_delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
tracker_queues_versions_list¶
List Tracker queue versions · read-only
The queue's versions — release milestones issues can be assigned to.
Each item carries the version's name, date range and released/archived flags. Create one
with queues_versions_create.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
tracker_queues_fields_list¶
List Tracker queue required fields · read-only
The queue's required/local fields with their schema, options and display order.
Use this to learn which fields an issue in the queue expects (and whether each is required) before creating or updating issues there.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
tracker_queues_create¶
Create Tracker queue · write
Create a Tracker queue (the container issues live in; its key prefixes issue keys).
Required: key (latin, uppercase), name, lead (login), default_type (issue
type key, e.g. task) and default_priority (priority key, e.g. normal). Returns
the new queue.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for queues.create (POST /queues/). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_queues_delete¶
Delete Tracker queue · destructive write
Delete a Tracker queue WITH ALL ITS ISSUES (recoverable via queues_restore).
The queue moves to the recycle bin and can be restored for a limited time. Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_queues_restore¶
Restore Tracker queue · write
Restore a previously deleted Tracker queue (and its issues) from the recycle bin.
Returns the restored queue.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_queues_permissions_update¶
Set Tracker queue permissions · idempotent write
Replace access rules on a Tracker queue (grant/revoke read/write/create/grant rights).
Each right block takes users/groups/roles arrays; omitted blocks stay
unchanged. Returns the resulting permission set. A removal is not always the inverse of an
addition: taking a user out of read took it out of write too (seen once,
2026-10-06), so read the returned set after a removal. Adding a member that is there
already changes nothing.
Grants access: a client that honours the mark asks a person on every call.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
body |
object | yes | Typed request body for queues.permissions_update (PATCH /queues/{id}/permissions). Set at least one category. Each names the users/groups/roles the permission applies to. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_queues_tags_delete¶
Remove Tracker queue tag · destructive write
Remove a tag from EVERY issue of a queue (irreversible; the tag disappears queue-wide).
body is {"tag": "<name>"} — pick the name from queues_tags_list. Returns an
acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
body |
object | yes | Typed request body for queues.tags_delete (POST /queues/{id}/tags/_remove). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_queues_versions_create¶
Create Tracker queue version · write
Create a version (release milestone) on a queue.
Required: queue (the queue key) and name; optional description,
start_date / due_date (YYYY-MM-DD). Returns the new version.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for queues.versions_create (POST /versions/). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_queues_versions_get¶
Get Tracker queue version · read-only
One queue version: name, description, dates and its released/archived flags.
| Parameter | Type | Required | Description |
|---|---|---|---|
version_id |
integer | yes | Numeric id of the version, from queues_versions_list. |
fields |
string or null | Comma-separated fields to return, e.g. name,dueDate,released. |
tracker_queues_versions_update¶
Edit Tracker queue version · idempotent write
Edit a queue version; only the fields set in body change. Returns the version.
| Parameter | Type | Required | Description |
|---|---|---|---|
version_id |
integer | yes | Numeric id of the version, from queues_versions_list. |
body |
object | yes | Typed request body for queues.version_edit (PATCH /versions/{id}). Only the fields that are set are sent, so omitted fields stay unchanged. |
fields |
string or null | Comma-separated fields to return in the reply. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_queues_versions_delete¶
Delete Tracker queue version · destructive write
Permanently delete a queue version (irreversible). Returns an acknowledgement.
| Parameter | Type | Required | Description |
|---|---|---|---|
version_id |
integer | yes | Numeric id of the version, from queues_versions_list. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_queues_user_permissions_get¶
Get a user's rights in a Tracker queue · read-only
What one user may do in a queue (create, read, write, grant, deny) and why.
Each right lists who grants it: the user personally, a group or a role. To change rights
use queues_permissions_update.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
user_id |
string | yes | Login or numeric uid of the user. |
tracker_queues_group_permissions_get¶
Get a group's rights in a Tracker queue · read-only
What one group may do in a queue (create, read, write, grant, deny).
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
group_id |
integer | yes | Numeric id of the group. |
tracker_localfields_list¶
List Tracker local fields · read-only
Custom fields scoped to one queue (its local fields), as a flat list.
Each item's key is the field key you pass to localfields_get; field_schema
describes the value type. Local fields differ from global fields (fields_list) in that
they exist only inside the given queue. Pass a key from queues_list as queue_id.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. ORG) or numeric queue id. |
tracker_localfields_get¶
Get Tracker local field · read-only
One local field's full definition (type, options, category) by queue and field key.
Returns the value schema, allowed-values provider and category of the field. Use
localfields_list first to discover the field_key values available in a queue.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. ORG) or numeric queue id. |
field_key |
string | yes | Local field key, as returned by localfields_list. |
tracker_localfields_create¶
Create Tracker local field · write
Create a custom field scoped to one queue (a local field).
Required fields: id (latin key), name (ru/en display names), category (a category
id from fields_list) and type (value type, e.g. ru.yandex.startrek.core.fields.
StringFieldType). There is no delete endpoint — the field lives until its queue is deleted.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
body |
object | yes | Typed request body for creating an issue field, global or local to a queue. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_localfields_update¶
Edit Tracker local field · idempotent write
Edit a queue-local field; only the fields set in body are changed.
Get field_key from localfields_list. Returns the updated field definition.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
field_key |
string | yes | Key of the queue-local field, from localfields_list. |
body |
object | yes | Typed request body for PATCH /queues/{id}/localFields/{key} (edit a local field). This endpoint has no ?version= optimistic lock; only the fields that are set are sent. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_fields_list¶
List Tracker global fields · read-only
All global (organisation-wide) issue fields, both standard and custom.
Each field carries its value schema, category and provider metadata. Use this to discover
which field keys exist before filtering or reading issues; use fields_get when you
already know one field id.
tracker_fields_get¶
Get Tracker field · read-only
Parameters of a single issue field.
They include its value schema, read-only flag, allowed options and category. Use this when you
already know the field id; use fields_list to enumerate every field in the organisation.
| Parameter | Type | Required | Description |
|---|---|---|---|
field_id |
string | yes | Identifier of the issue field, e.g. summary or a custom-field key. |
tracker_fields_create¶
Create Tracker field · write
Create an org-global custom issue field.
CAUTION: global fields are organisation-wide and NOT deletable — creation leaves permanent
residue; prefer localfields_create for a single queue. Required: id (latin key),
name (ru/en display names), category (a category id) and type (value type).
A name is unique among the fields: one that is taken answers 422 (measured).
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for creating an issue field, global or local to a queue. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_fields_update¶
Edit Tracker field · idempotent write
Edit an org-global issue field; only the fields set in body are changed.
Pass version to guard against concurrent edits (optimistic locking). Returns the
updated field definition.
| Parameter | Type | Required | Description |
|---|---|---|---|
field_id |
string | yes | Identifier of the issue field, from fields_list. |
body |
object | yes | Typed request body for PATCH /fields/{id}?version= (rename and/or change options). Rename and change-options share one PATCH, so this one body covers both name and optionsProvider; only the fields that are set are sent. |
version |
integer or null | Current version of the object (optimistic lock), from its get/list tool. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_fields_categories_create¶
Create Tracker field category · write
Create a field category (a grouping bucket for issue fields in the UI).
Required: name (ru/en display names) and order (display weight). CAUTION:
org-global and not deletable via the API.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /fields/categories (create a field category). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_fields_categories_update¶
Edit Tracker field category · idempotent write
Edit a field category; only the fields set in body are changed.
Pass version to guard against concurrent edits (optimistic locking).
| Parameter | Type | Required | Description |
|---|---|---|---|
category_id |
string | yes | Identifier of the field category. |
body |
object | yes | Typed request body for PATCH /fields/categories/{id}?version= (edit a category). Only the fields that are set are sent, so omitted fields stay unchanged. |
version |
integer or null | Current version of the object (optimistic lock), from its get/list tool. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_components_list¶
List Tracker components · read-only
All components created by the organisation's users.
Each component carries its queue, owner and description. Components are sub-areas used to classify issues within a queue; use this to discover valid component names/ids before filtering or creating issues.
tracker_components_create¶
Create Tracker component · write
Create a component in a queue (a sub-area for classifying its issues).
name and queue (the queue key) are required; optional fields include
description, lead and assignAuto.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /components (create a component). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_components_update¶
Edit Tracker component · idempotent write
Edit a component; only the fields set in body are changed.
Get component_id from components_list. Pass version to guard against concurrent
edits (optimistic locking).
| Parameter | Type | Required | Description |
|---|---|---|---|
component_id |
integer | yes | Numeric id of the component, from components_list. |
body |
object | yes | Typed request body for PATCH /components/{id}?version= (edit a component). Only the fields that are set are sent, so omitted fields stay unchanged. |
version |
integer or null | Current version of the object (optimistic lock), from its get/list tool. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_components_list_for_queue¶
List components of a Tracker queue · read-only
The components of one queue, so you need not filter components_list by queue.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
fields |
string or null | Comma-separated extra fields: version,description,lead,assignAuto. |
tracker_components_get¶
Get Tracker component · read-only
One component with its queue, owner, description and auto-assign flag.
| Parameter | Type | Required | Description |
|---|---|---|---|
component_id |
integer | yes | Numeric id of the component, from components_list. |
fields |
string or null | Comma-separated fields to return, e.g. name,description,lead. |
tracker_components_delete¶
Delete Tracker component · destructive write
Permanently delete a component (irreversible). Returns an acknowledgement.
| Parameter | Type | Required | Description |
|---|---|---|---|
component_id |
integer | yes | Numeric id of the component, from components_list. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_components_user_permissions_get¶
Get a user's rights on a Tracker component · read-only
What one user may do on a component (create, read, write, deny) and who grants it.
| Parameter | Type | Required | Description |
|---|---|---|---|
component_id |
integer | yes | Numeric id of the component. |
user_id |
string | yes | Login or numeric uid of the user. |
tracker_components_group_permissions_get¶
Get a group's rights on a Tracker component · read-only
What one group may do on a component (create, read, write, deny).
| Parameter | Type | Required | Description |
|---|---|---|---|
component_id |
integer | yes | Numeric id of the component. |
group_id |
integer | yes | Numeric id of the group. |
tracker_filters_get¶
Get Tracker filter · read-only
Parameters of a single saved issue filter.
They include its stored conditions, query-language string, owner, favourite flag and access
permissions. Use this to inspect a filter a user references by id; the resulting conditions
can then feed an issues_search query.
| Parameter | Type | Required | Description |
|---|---|---|---|
filter_id |
string | yes | Numeric identifier of the saved filter, e.g. 12345. |
tracker_filters_create¶
Create Tracker filter · write
Create a saved issue filter owned by the calling user.
name is required; set query (a TQL string) or filter (a conditions object) for
the stored search. Remove it later with filters_delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /filters/ (create a saved filter). Pass either filter (a field→condition mapping) or query (a Tracker query string), not both. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_filters_update¶
Edit Tracker filter · idempotent write
Edit a saved issue filter; only the fields set in body are changed.
Get filter_id from filters_get / the Tracker UI. Returns the updated filter.
| Parameter | Type | Required | Description |
|---|---|---|---|
filter_id |
string | yes | Identifier of the saved filter, from filters_get. |
body |
object | yes | Typed request body for PATCH /filters/{id} (edit a saved filter). Only the fields that are set are sent; note the API replaces filter wholesale rather than merging it, so pass every condition you want to keep. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_filters_delete¶
Delete Tracker filter · destructive write
Permanently delete a saved issue filter (irreversible).
Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
filter_id |
string | yes | Numeric identifier of the saved filter, e.g. 12345. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_applications_list¶
List Tracker external applications · read-only
External applications that Tracker issues can be linked to via external links.
Use this to discover which application ids/types are available before creating an external link; each application's id and type values are identical.
tracker_boards_list¶
List Tracker boards · read-only
All agile boards in the organisation, sorted by ascending board id.
Auto-paginated via the relative id-cursor. Capped at the configured item cap unless limit
is given. Use boards_get when you know one board id, and sprints_list to list a
board's sprints.
| Parameter | Type | Required | Description |
|---|---|---|---|
limit |
integer or null | Max boards to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
tracker_boards_get¶
Get Tracker board · read-only
Look up a single agile board by its numeric id.
The board includes its columns, estimation field and burndown calendar. Use this when you
already know the board id; use boards_list to browse every board, and sprints_list to
enumerate the sprints defined on this board.
| Parameter | Type | Required | Description |
|---|---|---|---|
board_id |
integer | yes | Numeric identifier of the agile board. |
tracker_boards_create¶
Create Tracker board · write
Create an agile board; returns the new board with its id.
name is required; optional fields include owner, the private/public
permissions template, the backlog_available/sprints_available flags and status-backed
columns.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for boards.create (POST /liveBoards/). name is the only required field; every other field is omitted from the JSON body when left as None (see model_dump(exclude_none=True)). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_boards_update¶
Edit Tracker board · idempotent write
Edit an agile board; only the fields set in body are changed.
Supports renaming, toggling backlog_available/sprints_available and replacing the
columns layout. Returns the updated board.
| Parameter | Type | Required | Description |
|---|---|---|---|
board_id |
integer | yes | Numeric identifier of the agile board. |
body |
object | yes | Typed request body for boards.edit (PATCH /boards/{board_id}). Every field is optional; only the fields you set are sent, so an omitted field is left unchanged on the board. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_boards_delete¶
Delete Tracker board · destructive write
Permanently delete an agile board (irreversible; its issues are not affected).
Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
board_id |
integer | yes | Numeric identifier of the agile board. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_sprints_list¶
List Tracker board sprints · read-only
Every sprint defined on the given agile board, in the order Tracker returns them.
Each sprint carries its status, planned dates and parent board. Use this to enumerate a
board's sprints; use sprints_get when you already know a sprint id, and boards_get for
the board itself.
| Parameter | Type | Required | Description |
|---|---|---|---|
board_id |
integer | yes | Numeric identifier of the board whose sprints to list. |
tracker_sprints_get¶
Get Tracker sprint · read-only
Look up a single sprint by its numeric id.
The sprint includes its status, planned start/end dates, actual start/end datetimes and parent
board. Use this when you already know the sprint id; use sprints_list to enumerate all
sprints on a board.
| Parameter | Type | Required | Description |
|---|---|---|---|
sprint_id |
integer | yes | Numeric identifier of the sprint. |
tracker_sprints_create¶
Create Tracker sprint · write
Create a sprint on an agile board; returns the new sprint.
Required fields: name, board ({"id": "<board id>"}), start_date and
end_date (YYYY-MM-DD). The board must have sprints enabled.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for sprints.create (POST /sprints). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_sprints_update¶
Edit Tracker sprint · idempotent write
Edit a sprint; only the fields set in body (name, dates) are changed.
Get sprint_id from sprints_list. Pass version (the sprint's current version,
from sprints_get) — the API requires it for optimistic locking and answers 428 without
one. Returns the updated sprint.
| Parameter | Type | Required | Description |
|---|---|---|---|
sprint_id |
integer | yes | Numeric identifier of the sprint. |
body |
object | yes | Typed request body for sprints.edit (PATCH /sprints/{sprint_id}). Every field is optional; only the fields you set are sent. |
version |
integer or null | Current version of the object (optimistic lock), from its get/list tool. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_sprints_delete¶
Delete Tracker sprint · destructive write
Permanently delete a sprint (irreversible; its issues are not affected).
Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
sprint_id |
integer | yes | Numeric identifier of the sprint. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_sprints_start¶
Start Tracker sprint · write
Start a sprint (sets its status to inProgress and stamps the actual start time).
Pass version (the sprint's current version, from sprints_get) — the API requires
it for optimistic locking and answers 428 without one. Returns the updated sprint.
| Parameter | Type | Required | Description |
|---|---|---|---|
sprint_id |
integer | yes | Numeric identifier of the sprint. |
version |
integer or null | Current version of the object (optimistic lock), from its get/list tool. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_sprints_archive¶
Archive Tracker sprint · write
Archive a finished sprint (hides it from the board's active sprint list).
Pass version (the sprint's current version, from sprints_get) — the API requires
it for optimistic locking and answers 428 without one. Returns the updated sprint.
| Parameter | Type | Required | Description |
|---|---|---|---|
sprint_id |
integer | yes | Numeric identifier of the sprint. |
version |
integer or null | Current version of the object (optimistic lock), from its get/list tool. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_attachments_list¶
List Tracker issue attachments · read-only
Files attached to a Tracker issue — name, size, MIME type, uploader, download URLs.
Returns metadata only (an ItemList[Attachment]); use it to discover a file's id and name.
Downloading the file's or thumbnail's raw bytes is CLI/SDK-only — run
ycli tracker attachments download <ISSUE> <FILE_ID> <FILENAME> — because binary blobs
are not an MCP payload.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key or id, e.g. JUNE-2. |
tracker_attachments_get¶
Get Tracker attachment metadata · read-only
One attachment's metadata (name, size, MIME type, uploader, download URL).
Downloading the bytes is CLI/SDK-only: ycli tracker attachments download.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key or id, e.g. JUNE-2. |
file_id |
string | yes | Attachment file id, from attachments_list. |
tracker_attachments_delete¶
Delete Tracker issue attachment · destructive write
Permanently delete one attachment from a Tracker issue (irreversible).
Get file_id from attachments_list. Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key or id, e.g. JUNE-2. |
file_id |
string | yes | Attachment file id, from attachments_list. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_attachments_upload¶
Attach file to Tracker issue · write
Attach a small file to a Tracker issue; returns the created attachment.
The file travels as base64 in the request, so keep it small; for a large file run
ycli tracker attachments upload instead.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key or id, e.g. JUNE-2. |
filename |
string | yes | Name of the file being uploaded. |
data |
string | yes | The file's bytes, base64-encoded. |
rename_to |
string or null | Store the file under this name instead of filename. |
|
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_attachments_upload_temp¶
Upload temporary Tracker file · write
Upload a small temporary file to attach when creating an issue or a comment.
The returned id goes into attachmentIds of the issue or comment body, and works
once. The file travels as base64 in the request, so keep it small.
| Parameter | Type | Required | Description |
|---|---|---|---|
filename |
string | yes | Name of the file being uploaded. |
data |
string | yes | The file's bytes, base64-encoded. |
rename_to |
string or null | Store the file under this name instead of filename. |
|
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_attachments_import¶
Import Tracker issue attachment · write
Import a file onto an issue with its original author and creation time (admin-only).
The file travels as base64 in the request, so keep it small; for a large file run
ycli tracker attachments import instead. created_at uses
YYYY-MM-DDThh:mm:ss.sss±hhmm. Returns the imported attachment.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
filename |
string | yes | Name the imported file gets on the issue. |
created_at |
string | yes | Original creation time, YYYY-MM-DDThh:mm:ss.sss±hhmm. |
created_by |
string | yes | Login or id of the user to record as the file's author. |
data |
string | yes | The file's bytes, base64-encoded. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_macros_list¶
List Tracker queue macros · read-only
Every macro configured on a queue — each a canned comment plus field updates.
Each item's id is what you pass to macros_get for the full body and issueUpdate
rows.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
tracker_macros_get¶
Get Tracker queue macro · read-only
One queue macro by id — its comment body and the field updates it applies.
Sibling macros_list enumerates every macro in the queue; pass one of its id values
here.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
macro_id |
integer | yes | Numeric identifier of the macro. |
tracker_macros_create¶
Create Tracker queue macro · write
Create a macro on a queue (a canned comment plus field updates applied on demand).
name is required; optional fields are body (the comment template) and
fieldChanges rows. Returns the new macro.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
body |
object | yes | Typed request body for macros.create (POST /queues/{id}/macros). issue_update here is a field→value object (not the list the read side returns), e.g. {"tags": {"add": "Новый тег"}, "resolution": None}. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_macros_update¶
Edit Tracker queue macro · idempotent write
Edit a queue macro; only the fields set in body are changed.
Get macro_id from macros_list. Returns the updated macro.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
macro_id |
integer | yes | Numeric identifier of the macro, from macros_list. |
body |
object | yes | Typed request body for macros.edit (PATCH /queues/{id}/macros/{macro_id}). Every field is optional; only the fields you set are sent. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_macros_delete¶
Delete Tracker queue macro · destructive write
Permanently delete a macro from a queue (irreversible).
Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
macro_id |
integer | yes | Numeric identifier of the macro, from macros_list. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_triggers_list¶
List Tracker queue triggers · read-only
Every trigger of a queue, ascending by id: name, actions, conditions and active flag.
Auto-paginated and capped at the configured item cap unless limit is given. Use
triggers_get for one trigger by id.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. DESIGN) or numeric queue id. |
limit |
integer or null | Max triggers to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
tracker_triggers_get¶
Get Tracker queue trigger · read-only
One queue trigger by id — its actions, firing conditions, order and active flag.
Triggers run actions on an issue when their conditions match. The webhook-action run log is
triggers_webhook_log_list.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. DESIGN) or numeric queue id. |
trigger_id |
integer | yes | Numeric identifier of the trigger. |
tracker_triggers_webhook_log_list¶
List Tracker trigger webhook logs · read-only
The execution log of a trigger's HTTP-request (Webhook) action, newest first.
Each record holds the outbound request and received response for one run. Only Webhook actions produce these; a trigger with no HTTP action returns an empty list.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. DEV) or numeric queue id. |
trigger_id |
integer | yes | Numeric identifier of the trigger. |
issue_id |
string or null | Optional issue key/id to scope the logs to one issue. | |
limit |
integer or null | Max records (the API's default is 10, its maximum 100). | |
date_from |
string or null | Range start, YYYY-MM-DDThh |
|
date_to |
string or null | Range end, YYYY-MM-DDThh |
tracker_triggers_create¶
Create Tracker queue trigger · write
Create a trigger on a queue — actions that fire when an issue event matches conditions.
Required: name and actions (e.g. [{"type": "Transition", …}]); optional
conditions scope when it fires. Returns the new trigger.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
body |
TriggerCreate | yes | Trigger name, actions and optional conditions. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_triggers_update¶
Edit Tracker queue trigger · idempotent write
Edit a queue trigger; only the fields set in body are changed.
Get trigger_id from triggers_get / the queue settings. Pass version to guard
against concurrent edits (optimistic locking).
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
trigger_id |
integer | yes | Numeric trigger id, from triggers_list. |
body |
TriggerUpdate | yes | Fields to change; unset ones stay. |
version |
integer or null | Current version of the object (optimistic lock), from its get/list tool. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_autoactions_get¶
Get Tracker queue autoaction · read-only
One queue autoaction by id — its filter/query, actions, schedule and run stats.
An autoaction periodically applies its actions to every issue matching its filter/query.
For run history use autoactions_logs_list (summaries) then autoactions_logs_get
(per-issue outcomes of one run).
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. DESIGN) or numeric queue id. |
action_id |
integer | yes | Numeric identifier of the autoaction. |
tracker_autoactions_logs_list¶
List Tracker autoaction runs · read-only
Run summaries for an autoaction — one record per launch with hit/success/failure counts.
Each record's id is the run id you pass to autoactions_logs_get for that run's
per-issue outcomes.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. DESIGN) or numeric queue id. |
action_id |
integer | yes | Numeric identifier of the autoaction. |
tracker_autoactions_logs_get¶
Get Tracker autoaction run · read-only
The per-issue outcomes of one autoaction run — each issue touched and its result status.
Get the run_id from autoactions_logs_list. Only autoactions that auto-update issues
produce these detail logs.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. DESIGN) or numeric queue id. |
action_id |
integer | yes | Numeric identifier of the autoaction. |
run_id |
string | yes | Identifier of the autoaction run (from logs_list). |
tracker_autoactions_create¶
Create Tracker queue autoaction · write
Create an autoaction on a queue — actions applied on a schedule to matching issues.
Required: name and actions (e.g. [{"type": "Update", …}]); scope the issues
with filter or query and set the cadence via intervalMillis / calendar.
CAUTION: autoactions have no delete endpoint — the action persists until its queue is
deleted (it can be disabled in the UI).
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
body |
object | yes | Typed request body for autoactions.create (POST /queues/{id}/autoactions). Supply at least one of filter or query to select the issues to act on. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_bulk_get¶
Get Tracker bulk-change status · read-only
Current status of an async bulk-change operation (issues_update_bulk and its kin).
status runs CREATED → COMPLETE / FAILED; totalIssues /
totalCompletedIssues show progress. Poll this after a bulk trigger returns an id;
once it reports FAILED, call bulk_issues_list for the per-issue errors.
| Parameter | Type | Required | Description |
|---|---|---|---|
bulk_id |
string | yes | Bulk-change operation id, e.g. 1ab23cd4e5678901. |
tracker_bulk_issues_list¶
List the issues of a Tracker bulk change · read-only
Every issue of a bulk change with how it went: its status and, when it failed, why.
One record per issue, the ones that went well too (COMPLETED, measured). Use after
bulk_get reports a failure to see which issues were rejected and why (e.g. an invalid
resolution for the target queue/type): those carry error.
| Parameter | Type | Required | Description |
|---|---|---|---|
bulk_id |
string | yes | Bulk-change operation id to inspect. |
tracker_remotelinks_list¶
List Tracker issue remote links · read-only
Links from a Tracker issue to objects in external applications (Bitbucket, etc.).
Each entry carries the link type, direction, and the external object's key plus its owning
application. This is the external link list — for issue-to-issue links use
links_list.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key or id, e.g. JUNE-2. |
tracker_remotelinks_create¶
Create Tracker issue remote link · write
Link a Tracker issue to an object in an external application; returns the created link.
Get the application id (origin) from applications_list. Pass backlink=true
to also create the mirror link in the external app.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
body |
object | yes | Typed request body for POST /issues/{key}/remotelinks (add an external link). |
backlink |
boolean or null | Also create the mirror link in the external application. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_remotelinks_delete¶
Delete Tracker issue remote link · destructive write
Remove a remote (external-application) link from a Tracker issue (irreversible).
Get link_id from remotelinks_list. Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
issue_key |
string | yes | Issue key, e.g. QUEUE-123. |
link_id |
string | yes | Remote link id, from remotelinks_list. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_dashboards_create¶
Create Tracker dashboard · write
Create a personal Tracker dashboard; returns it with the id used to add widgets.
NOTE: dashboard deletion is not wrapped by ycli, so the dashboard stays on the account until removed in the UI.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /dashboards/ (create a dashboard). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_dashboards_widgets_create_cycle_time¶
Add Tracker cycle-time widget · write
Add a cycle-time widget to a Tracker dashboard; returns the created widget.
Get dashboard_id from dashboards_create.
| Parameter | Type | Required | Description |
|---|---|---|---|
dashboard_id |
string | yes | Id of the dashboard to add the widget to. |
body |
object | yes | Typed request body for POST /dashboards/{id}/widgets/cycleTime (add a cycle-time chart). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_get¶
Get Tracker entity · read-only
A single Tracker entity (project, portfolio or goal) by id, with its fields block.
Pass fields to pull extra parameters into the response — keyResultItems for a goal's
key results, checklistItems for a project/portfolio checklist, metricItems for its
metric widgets, or summary,description,entityStatus for the basics. Use
entities_search to discover ids first.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
fields |
string or null | Comma-separated extra fields, e.g. keyResultItems,checklistItems. |
|
expand |
string or null | Extra info, e.g. attachments. |
tracker_entities_search¶
Search Tracker entities · read-only
Entities of a given type that match a name substring and a filter, sorted server-side.
Returns the entities, and whether there are more. body.input matches part of the name,
body.filter is a field → value object (author, status, followers, …), body.orderBy with
body.orderAsc sorts, and body.rootOnly keeps the entities with no parent.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio, goal or report (issue reports). |
body |
object or null | What to find: name substring, filter, sort order; omit for all. | |
fields |
string or null | Comma-separated extra fields to include. | |
limit |
integer or null | Max entities to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
tracker_entities_events_list¶
List Tracker entity history · read-only
An entity's event history (created/updated/commented/…), auto-paginated.
Each event carries an author, a timestamp, a display title and the individual field changes.
Capped at the configured item cap unless limit is given.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
limit |
integer or null | Max events (omitted: the configured cap). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
|
selected |
string or null | Event id to build the list around, instead of from the start. | |
new_events_on_top |
boolean or null | Newest events first. | |
direction |
string or null | forward (the default) or backward. |
tracker_entities_permissions_get¶
Get Tracker entity permissions · read-only
An entity's access settings — the READ/WRITE/GRANT ACL plus inheritance sources.
acl lists the users, groups and roles granted each level; permissionSources names the
parent entities this one inherits permissions from. Change them with
entities_permissions_update.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
tracker_entities_permissions_get_direct¶
Get Tracker entity direct permissions · read-only
An entity's direct READ / WRITE / GRANT rights — the users, groups and roles holding each.
Unlike entities_permissions_get this leaves out inheritance (permissionSources).
Change the rights with entities_permissions_update_direct.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
tracker_entities_comments_list¶
List Tracker entity comments · read-only
All comments on an entity — author, text, timestamps and summoned users.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
expand |
string or null | Extra blocks to include in the reply. |
tracker_entities_comments_get¶
Get Tracker entity comment · read-only
A single comment on an entity by id.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
comment_id |
string | yes | Comment id (numeric id or longId). |
expand |
string or null | Extra blocks to include in the reply. |
tracker_entities_links_list¶
List Tracker entity links · read-only
An entity's links to other entities — the link type and the linked entity's summary + id.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
fields |
string or null | Comma-separated fields to include in the reply. |
tracker_entities_attachments_list¶
List Tracker entity attachments · read-only
Files attached to an entity — name, size, MIME type, uploader and download URL.
Returns metadata only. Downloading the raw bytes is CLI/SDK-only — run
ycli tracker entities attachments download <FILE_ID> <FILENAME> — because binary blobs
are not an MCP payload.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
tracker_entities_attachments_get¶
Get Tracker entity attachment · read-only
One attachment's metadata (name, size, MIME type, download URL).
Downloading the raw bytes is CLI/SDK-only (tracker entities attachments download).
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
file_id |
string | yes | Attachment file id. |
tracker_entities_bulk_get¶
Get Tracker entity bulk-change status · read-only
Current status of an async entity bulk-change operation started by entities_update_bulk.
status runs CREATED → COMPLETE / FAILED; poll until it settles.
| Parameter | Type | Required | Description |
|---|---|---|---|
bulk_id |
string | yes | Operation id returned by entities_update_bulk. |
tracker_entities_comments_list_relative¶
List Tracker entity comments (relative) · read-only
An entity's comments via the cursor-paginated …/comments/_relative endpoint.
Prefer this over entities_comments_list when the comment thread is long — it drains
pages up to limit (the configured item cap by default).
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
limit |
integer or null | Max comments (omitted: the configured cap). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
tracker_entities_create¶
Create Tracker entity · write
Create a Tracker entity (project, portfolio or goal); returns it with its id.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
body |
object | yes | Typed request body for POST /entities/{type} — a {fields: {...}} envelope. |
fields |
string or null | Comma-separated fields to include in the reply. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_update¶
Edit Tracker entity · idempotent write
Edit a Tracker entity; only the fields keys present in body are changed.
Returns the updated entity.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
body |
object | yes | Typed request body for PATCH /entities/{type}/{id} (edit fields, comment, links). |
expand |
string or null | Extra blocks to include in the reply. | |
fields |
string or null | Comma-separated fields to include in the reply. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_delete¶
Delete Tracker entity · destructive write
Permanently delete a Tracker entity (project/portfolio/goal) — irreversible.
Pass with_board=true to also delete a project's linked agile board. Returns an
acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
with_board |
boolean or null | Also delete the project's linked board. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_permissions_update¶
Set Tracker entity permissions · idempotent write
Change an entity's access rules; returns the resulting permission set.
The acl object of body accepts only grant / revoke
actions, each mapping an access level (READ/WRITE/GRANT) to users/groups/roles,
e.g. {"acl": {"grant": {"READ": {"users": ["8000000000000002"]}}}}. Read the current
ACL first with entities_permissions_get.
Grants access: a client that honours the mark asks a person on every call.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
body |
object | yes | Typed request body for PATCH …/extendedPermissions: rights to grant and to revoke. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_permissions_update_direct¶
Set Tracker entity direct permissions · idempotent write
Grant and revoke an entity's direct rights; the rest stay as they are.
grant and revoke each map READ / WRITE / GRANT to users (logins or ids),
groups (ids) and roles (AUTHOR, OWNER, CLIENT, FOLLOWER, MEMBER). Returns the
resulting rights. Read them first with entities_permissions_get_direct.
Grants access: a client that honours the mark asks a person on every call.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
body |
object | yes | Typed request body for PATCH …/permissions (grant and revoke direct rights). Each side maps an access level (READ / WRITE / GRANT) to users, groups and roles; the API adds or removes exactly those and keeps the rest. permissionSources is refused (400). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_update_bulk¶
Bulk-update Tracker entities · write
Start an async bulk field update over many entities; returns the operation.
Poll the returned operation id with entities_bulk_get.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
body |
object | yes | Typed request body for POST …/bulkchange/_update (mass-edit entities). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_reports_create¶
Create Tracker entity report · write
Request a report over Tracker entities (POST /entities/report/).
Returns the report entity.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for POST /entities/report/ — a {fields: {...}} envelope. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_comments_create¶
Add Tracker entity comment · write
Add a comment to a Tracker entity; returns the created comment.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
body |
object | yes | Typed request body for adding a comment to an issue or an entity. |
expand |
string or null | Extra blocks to include in the reply. | |
is_add_to_followers |
boolean or null | Add the comment's author to the followers; omitted, the API adds. | |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
notify_author |
boolean or null | Notify the author of the change; omitted, the API does not. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_comments_update¶
Edit Tracker entity comment · idempotent write
Edit a comment on a Tracker entity; returns the updated comment.
comment_id addresses the comment (get it from entities_comments_list).
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
comment_id |
string | yes | Comment id (from entities_comments_list). |
body |
object | yes | Typed request body for PATCH …/comments/{comment_id} (the id travels in the path). |
expand |
string or null | Extra blocks to include in the reply. | |
is_add_to_followers |
boolean or null | Add the comment's author to the followers; omitted, the API adds. | |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
notify_author |
boolean or null | Notify the author of the change; omitted, the API does not. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_comments_delete¶
Delete Tracker entity comment · destructive write
Permanently delete one comment from a Tracker entity (irreversible).
Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
comment_id |
string | yes | Comment id (from entities_comments_list). |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
notify_author |
boolean or null | Notify the author of the change; omitted, the API does not. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_checklists_create¶
Add Tracker entity checklist items · write
Add checklist item(s) to a Tracker entity; returns the entity with its checklist.
body is a bare array of items, e.g. [{"text": "…"}].
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
body |
array of object | yes | A bare array of checklist items. |
expand |
string or null | Extra blocks to include in the reply. | |
fields |
string or null | Comma-separated fields to include in the reply. | |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
notify_author |
boolean or null | Notify the author of the change; omitted, the API does not. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_checklists_update¶
Edit Tracker entity checklist · idempotent write
Replace/update a Tracker entity's checklist items in one call.
body is a bare array of items, each with id/text/checked. To edit a single
item by id use entities_checklists_items_update. Returns the entity with its checklist.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
body |
array of object | yes | A bare array of checklist items. |
expand |
string or null | Extra blocks to include in the reply. | |
fields |
string or null | Comma-separated fields to include in the reply. | |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
notify_author |
boolean or null | Notify the author of the change; omitted, the API does not. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_checklists_items_update¶
Edit Tracker entity checklist item · idempotent write
Edit one checklist item on a Tracker entity (text, checked state, assignee, deadline).
Returns the entity with its updated checklist.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
item_id |
string | yes | Checklist item id. |
body |
object | yes | A checklist item in a create ([{text}]) or edit-all ([{id, text}]) body. |
expand |
string or null | Extra blocks to include in the reply. | |
fields |
string or null | Comma-separated fields to include in the reply. | |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
notify_author |
boolean or null | Notify the author of the change; omitted, the API does not. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_checklists_delete¶
Delete Tracker entity checklist · destructive write
Permanently delete the ENTIRE checklist of a Tracker entity (all items, irreversible).
To remove a single item use entities_checklists_items_delete. Returns the entity.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
expand |
string or null | Extra blocks to include in the reply. | |
fields |
string or null | Comma-separated fields to include in the reply. | |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
notify_author |
boolean or null | Notify the author of the change; omitted, the API does not. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_checklists_items_delete¶
Delete Tracker entity checklist item · destructive write
Permanently remove one item from a Tracker entity's checklist (irreversible).
Returns the entity with its remaining checklist.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
item_id |
string | yes | Checklist item id. |
expand |
string or null | Extra blocks to include in the reply. | |
fields |
string or null | Comma-separated fields to include in the reply. | |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
notify_author |
boolean or null | Notify the author of the change; omitted, the API does not. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_checklists_move¶
Move Tracker entity checklist item · write
Reorder a checklist item within a Tracker entity's checklist.
Returns the entity with its reordered checklist.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
item_id |
string | yes | Checklist item id to move. |
body |
object | yes | Typed request body for POST …/checklistItems/{id}/_move (reorder an item). |
expand |
string or null | Extra blocks to include in the reply. | |
fields |
string or null | Comma-separated fields to include in the reply. | |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
notify_author |
boolean or null | Notify the author of the change; omitted, the API does not. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_links_create¶
Link Tracker entities · write
Link a Tracker entity to another entity (e.g. relates, depends on).
Returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
body |
object | yes | A link spec used by create-link and the bulk values.links array. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_links_delete¶
Delete Tracker entity link · destructive write
Remove the link between a Tracker entity and another entity (irreversible).
right is the id of the entity on the other end (see entities_links_list). Returns
an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
right |
string | yes | Id of the linked entity to unlink. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_attachments_attach¶
Attach Tracker entity file · write
Attach a previously uploaded temporary file to a Tracker entity.
Requires a temp_file_id from the Tracker temporary-upload endpoint (not wrapped by
ycli — files are usually seeded via the UI). Returns the entity.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
temp_file_id |
string | yes | Temporary file id from a prior POST /attachments upload. |
expand |
string or null | Extra blocks to include in the reply. | |
fields |
string or null | Comma-separated fields to include in the reply. | |
notify |
boolean or null | Notify the users in the fields of the object; omitted, the API notifies. | |
notify_author |
boolean or null | Notify the author of the change; omitted, the API does not. | |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_entities_attachments_delete¶
Delete Tracker entity attachment · destructive write
Permanently delete an attachment from a Tracker entity (irreversible).
The API answers with an empty body; returns an acknowledgement on success.
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type |
string | yes | Entity type: project, portfolio or goal. |
entity_id |
string | yes | Entity id (or shortId). |
file_id |
string | yes | Attachment file id (from entities_attachments_list). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_workflows_list¶
List Tracker workflows · read-only
Every workflow of the organization (deleted ones excluded) with its steps and actions.
A workflow is the status graph an issue type follows. Use workflows_get for one by id
and workflows_list_for_queue to see which workflow each issue type of a queue uses.
tracker_workflows_get¶
Get Tracker workflow · read-only
One workflow with its steps, initial action, queue binding and version.
A step is a status with the transitions leaving it; version is needed to edit the workflow.
| Parameter | Type | Required | Description |
|---|---|---|---|
workflow_id |
string | yes | Workflow id, from workflows_list. |
tracker_workflows_list_for_queue¶
List workflows of a Tracker queue · read-only
The workflows a queue uses: a map from workflow id to the issue types that follow it.
| Parameter | Type | Required | Description |
|---|---|---|---|
queue_id |
string | yes | Queue key (case-sensitive, e.g. TEST) or numeric queue id. |
tracker_workflows_create¶
Create Tracker workflow · write
Create a workflow; returns it with its generated id and version.
Required: name, initialAction (name and target status) and steps (each a status
with its actions). Statuses are given as keys such as open and must exist; names are
{"ru": …, "en": …} objects.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for workflows.create (POST /workflows). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_workflows_update¶
Edit Tracker workflow · idempotent write
Edit a workflow.
Only the fields set in body change, and a given steps list replaces the whole step
list. Returns the workflow with its incremented version.
| Parameter | Type | Required | Description |
|---|---|---|---|
workflow_id |
string | yes | Workflow id, from workflows_list. |
body |
object | yes | Typed request body for workflows.edit (PATCH /workflows/{id}). Only the fields that are set change; a given steps list replaces the whole step list. |
version |
integer | yes | Current version of the workflow (optimistic lock), from workflows_get. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_workflows_actions_update¶
Edit Tracker workflow action · idempotent write
Edit one action (transition) of a workflow step; only the fields set in body change.
Returns the whole workflow with its incremented version.
| Parameter | Type | Required | Description |
|---|---|---|---|
workflow_id |
string | yes | Workflow id, from workflows_list. |
status |
string | yes | Key of the step (status) the action leaves. |
action_id |
string | yes | Id of the action within that step. |
body |
object | yes | Typed request body for workflows.edit_action. The docs mark every field optional, but Tracker refuses an edit without name and target (422), so both are required; the other fields change only when set. |
version |
integer | yes | Current version of the workflow (optimistic lock), from workflows_get. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_workflows_delete¶
Delete Tracker workflow · destructive write
Delete a workflow (irreversible). Returns an acknowledgement.
| Parameter | Type | Required | Description |
|---|---|---|---|
workflow_id |
string | yes | Workflow id, from workflows_list. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_projects_list¶
List Tracker projects · read-only
Every project of the organization (the legacy Projects API).
entities_search is the newer way to find projects and portfolios.
| Parameter | Type | Required | Description |
|---|---|---|---|
expand |
string or null | Extra blocks to include, e.g. queues. |
tracker_projects_get¶
Get Tracker project · read-only
One project: name, lead, stage, dates and version (needed to edit it).
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id |
integer | yes | Numeric id of the project, from projects_list. |
expand |
string or null | Extra blocks to include, e.g. queues. |
tracker_projects_queues_list¶
List queues of a Tracker project · read-only
The queues whose issues belong to a project.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id |
integer | yes | Numeric id of the project, from projects_list. |
expand |
string or null | Extra queue blocks, e.g. all or components,versions. |
tracker_projects_create¶
Create Tracker project · write
Create a project (legacy Projects API).
name is required, status is DRAFT, IN_PROGRESS, LAUNCHED or POSTPONED. The
service accepts queues (a queue key) and binds no queue. Returns the project.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for projects.create (POST /projects). |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_projects_update¶
Edit Tracker project · idempotent write
Edit a project; queues is required on every edit, other fields change when set.
Returns the project with its incremented version.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id |
integer | yes | Numeric id of the project, from projects_list. |
body |
object | yes | Typed request body for projects.edit (PUT /projects/{id}?version=). queues is required by the API on every edit; the rest change when set. |
version |
integer | yes | Current version of the project, from projects_get. |
expand |
string or null | Extra blocks to include, e.g. queues. |
|
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_projects_delete¶
Delete Tracker project · destructive write
Delete a project (irreversible). Returns an acknowledgement.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id |
integer | yes | Numeric id of the project, from projects_list. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_gaps_search¶
Search Tracker employee absences · read-only
The absences (vacation, illness, trips, duty, …) of the given users that overlap a window.
A read done via POST; needs Tracker administrator rights. Every requested user appears,
with an empty gaps list when they are not absent.
| Parameter | Type | Required | Description |
|---|---|---|---|
users |
array of string | yes | Logins or ids of the users to look up (up to 100). |
date_from |
string or null | Window start (ISO 8601); defaults to now. | |
date_to |
string or null | Window end (ISO 8601); must be after date_from. |
|
limit |
integer or null | Max users to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS). | |
all |
boolean | Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next. |
|
next |
string or null | Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit. |
tracker_gaps_create¶
Create Tracker employee absences · write
Create up to 100 employee absences; needs Tracker administrator rights.
Each gap needs user, workflow (vacation, paid_day_off, illness, absence, trip,
conference_trip, conference, learning, maternity or duty), from and to (ISO 8601,
from earlier). Returns the absences actually saved.
| Parameter | Type | Required | Description |
|---|---|---|---|
body |
object | yes | Typed request body for gaps.create (POST /gaps): up to 100 absences. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |
tracker_gaps_delete¶
Delete Tracker employee absences · destructive write
Delete employee absences by id (irreversible); ids the API does not know are ignored.
Needs Tracker administrator rights. Returns an acknowledgement.
| Parameter | Type | Required | Description |
|---|---|---|---|
gap_ids |
array of string | yes | Ids of the absences to delete (up to 100), from a search. |
dry_run |
boolean | Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none). |