342 tools in 49 groups. You do not call these yourself, the assistant does, but knowing what exists tells you what you can reasonably ask for.
Projects5#
Read, create, update and search the projects in a workspace.
list_projectsList the projects the caller can see (owners and admins see every project; other members see projects they created or belong to; private projects are hidden unless shared with them), with optional filtering and pagination
| Name | Type | Required | Description |
|---|
page | integer | No | Page number for pagination |
limit | integer | No | Number of items per page |
status | string | No | Filter projects by status (active, inactive, completed) |
get_projectGet detailed information about a specific project.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project numeric id or uniq_id (a task's project_uniq_id resolves here) |
create_projectCreate a new project with specified details including name, description, and dates.
| Name | Type | Required | Description |
|---|
name | string | Yes | The name of the project |
description | string | No | The description of the project |
start_date | string | No | Project start date in YYYY-MM-DD format |
end_date | string | No | Project end date in YYYY-MM-DD format |
status | string | No | Project status (Started, Hold, Stack, Completed) |
update_projectUpdate an existing project.
| Name | Type | Required | Description |
|---|
project_id | integer | Yes | The ID of the project to update |
name | string | No | New project name |
description | string | No | New project description |
start_date | string | No | Start date in YYYY-MM-DD format |
end_date | string | No | End date in YYYY-MM-DD format |
status | string | No | Project status (Started, Hold, Stack, Completed) |
search_projectsSearch the projects the caller can see by free-text query and optional filters.
| Name | Type | Required | Description |
|---|
q | string | No | Free-text query matching project name, short_name, or description |
status | string | No | Filter by project status (active, inactive, completed) |
status_group_id | integer | No | Filter by status group ID |
owner_id | integer | No | Filter by project owner user ID |
start_date | string | No | Filter projects starting on or after this date (YYYY-MM-DD) |
end_date | string | No | Filter projects ending on or before this date (YYYY-MM-DD) |
page | integer | No | Page number for pagination (default 1) |
limit | integer | No | Number of items per page (default 15, max 100) |
Tasks8#
List, read, create and update tasks, and look up the statuses and types a project accepts.
list_tasksList tasks with optional filtering by project ID, user ID, status, and pagination.
| Name | Type | Required | Description |
|---|
project_id | integer | No | Filter tasks by project ID |
user_id | integer | No | Filter tasks by user ID |
status | string | No | Filter tasks by status: pending, in_progress, completed, cancelled |
page | integer | No | Page number for pagination. Omit to return all matching tasks (up to 200). |
limit | integer | No | Items per page (1-100). Omit to return all matching tasks (up to 200) instead of a single page. |
get_taskGet detailed information about a specific task: its fields, its dependencies (predecessors), its dependents (successors), its linked tasks, and counts plus a preview of its comments and attachments.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Task numeric id or uniq_id (both are returned by list_tasks/search_tasks/get_task) |
create_taskCreate a new task in a project with specified details including title, description, priority, and assignment.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project numeric id or uniq_id |
title | string | Yes | The title of the task |
description | string | No | The description of the task (supports HTML) |
assigned_to | integer | No | User ID to assign the task to |
priority | string | No | Priority: low, medium or high |
estimated_hours | number | No | Estimated effort in hours (decimal, e.g. 2 or 1.5) |
type_id | integer | No | Task type id (e.g. Bug, Task, Story). Defaults to the project's Bug type when omitted. |
epic_id | integer | No | Epic id to link this task under (optional) |
feature_id | integer | No | Feature id to link this task under (optional, v4 projects) |
story_points | integer | No | Story points — agile estimate (optional) |
start_date | string | No | Task start date in YYYY-MM-DD format (optional) |
due_date | string | No | Task due (end) date in YYYY-MM-DD format (optional) |
update_taskUpdate an existing task.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Task numeric id or uniq_id (both are returned by list_tasks/search_tasks/get_task) |
title | string | No | New task title |
description | string | No | New task description (supports HTML) |
status | string | No | Workflow status name, exactly as configured for the project, e.g. "Dev Completed" or "Closed". Call list_task_statuses for the project's valid values. On projects with no status workflow the generic statuses new, in_progress, resolved, closed are accepted instead (aliases such as pending/started/resolve/completed also work). |
custom_status_id | integer | No | Workflow status by numeric id, as returned by list_task_statuses. Alternative to status. |
priority | string | No | Priority: low, medium or high |
assigned_to | integer | No | User ID to assign the task to |
estimated_hours | number | No | Estimated effort in hours (decimal, e.g. 2 or 1.5) |
type_id | integer | No | Task type id (e.g. Bug, Task, Story) |
epic_id | integer | No | Epic id to link this task under (0 to unlink) |
feature_id | integer | No | Feature id to link this task under (0 to unlink, v4 projects) |
story_points | integer | No | Story points — agile estimate |
start_date | string | No | Task start date in YYYY-MM-DD format (optional) |
due_date | string | No | Due (end) date in YYYY-MM-DD format (optional) |
search_tasksSearch tasks by free-text query and optional filters (project, status, priority, assignee).
| Name | Type | Required | Description |
|---|
q | string | No | Free-text search query matching task title/description |
project_id | integer | No | Filter tasks by project ID |
status | string | No | Filter tasks by status: pending, in_progress, completed, cancelled |
priority | string | No | Filter tasks by priority: low, medium or high |
assigned_to | integer | No | Filter tasks assigned to a specific user ID |
page | integer | No | Page number for pagination. Omit to return all matching tasks (up to 200). |
limit | integer | No | Items per page (1-100). Omit to return all matching tasks (up to 200) instead of a single page. |
list_task_statusesList the workflow statuses configured for a project, in workflow order.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project numeric id or uniq_id |
list_task_typesList the task types available in the workspace (e.g. Bug, Task, Story, Epic, Feature) with their numeric ids.
| Name | Type | Required | Description |
|---|
project_id | string | No | Optional project numeric id or uniq_id — includes types defined for that project in addition to the workspace-wide ones |
list_tasks_v2List tasks with strict project filtering, sprint/mine/status filters, deterministic pagination, and normalized identifiers.
| Name | Type | Required | Description |
|---|
project_id | integer | No | Strict numeric project filter |
sprint_id | string | No | Sprint numeric id or uniq_id: only tasks in this sprint |
mine | boolean | No | When true, tasks assigned to the authenticated user only |
status | string | No | Status filter as CSV or array values: open,in_progress,pending,closed,completed,cancelled |
page | integer | No | Page number (default 1) |
limit | integer | No | Items per page (default 20, max 100) |
Read and post comments on a task. Posting does not send the notifications the web app would.
list_task_commentsList the comments on a task, newest first, paginated.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Task numeric id or uniq_id (both are returned by list_tasks/search_tasks/get_task) |
page | integer | No | Page number for pagination (default 1) |
limit | integer | No | Number of comments per page (default |
get_task_commentGet a single comment on a task, with its body unclipped.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Task numeric id or uniq_id |
comment_id | integer | Yes | Comment id, as returned by get_task / list_task_comments |
add_task_commentPost a comment on a task as the authenticated user.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Task numeric id or uniq_id |
body | string | Yes | The comment text |
update_task_commentEdit a comment on a task, replacing its body.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Task numeric id or uniq_id |
comment_id | integer | Yes | Comment id, as returned by get_task / list_task_comments |
body | string | Yes | The replacement comment text |
Dependencies, links and labels9#
Scheduling dependencies between tasks, plain links, and labels.
list_task_dependenciesList a task's dependencies (the tasks it waits on) and its dependents (the tasks waiting on it), each with the dependency type: finish-to-start, start-to-start, finish-to-finish or start-to-finish.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Task numeric id or uniq_id |
add_task_dependencyMake a task depend on another task (blocked-by): the task named in task_id waits on the task named in depends_on_task_id.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | The dependent task (the one that waits) — numeric id or uniq_id |
depends_on_task_id | string | Yes | The prerequisite task (the one waited on) — numeric id or uniq_id |
type | string | No | finish-to-start (default), start-to-start, finish-to-finish or start-to-finish; FS/SS/FF/SF also accepted |
update_task_dependencyChange the type of an existing dependency between two tasks: finish-to-start, start-to-start, finish-to-finish or start-to-finish (FS/SS/FF/SF also accepted).
| Name | Type | Required | Description |
|---|
task_id | string | Yes | The dependent task (the one that waits) — numeric id or uniq_id |
depends_on_task_id | string | Yes | The prerequisite task (the one waited on) — numeric id or uniq_id |
type | string | Yes | finish-to-start, start-to-start, finish-to-finish or start-to-finish |
list_task_linksList the tasks linked to a task (relations such as related-to or duplicated-by), each with the link id needed to change it, plus the relation types this workspace has available.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Task numeric id or uniq_id |
add_task_linkLink one task to another (a "related to" / "duplicated by" style relation, with no scheduling meaning — use add_task_dependency for that).
| Name | Type | Required | Description |
|---|
task_id | string | Yes | The task the link is made from — numeric id or uniq_id |
target_task_id | string | Yes | The task being linked to — numeric id or uniq_id |
relation | string | No | Relation slug, e.g. related-to or duplicated-by (see list_task_links) |
list_task_labelsList the labels on a task and the active labels available to its project (project labels plus company-wide ones).
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Task numeric id or uniq_id |
add_task_labelsAdd labels to a task.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Task numeric id or uniq_id |
labels | array | Yes | Label names or label ids |
remove_task_labelRemove one label from a task, by label id or name.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Task numeric id or uniq_id |
label | string | Yes | Label id or name |
update_task_linkChange the relation of an existing link between two tasks — e.g. from related-to to duplicated-by.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | The task the link was made from — numeric id or uniq_id |
link_id | integer | Yes | The link row id, as reported by get_task / list_task_links |
relation | string | Yes | New relation slug, e.g. related-to or duplicated-by |
Cross-project linking5#
Relations that span projects: the cross-project board, program flow, a task's relations across projects, and pickers for link targets.
get_cross_project_boardGet the cross-project board: a read-only kanban of work items across every project you can access (or only the projects you name), grouped into New, In Progress, Resolved and Closed columns, newest first.
| Name | Type | Required | Description |
|---|
project_ids | array | No | Optional project numeric ids or uniq_ids to narrow the board to; projects you cannot access are ignored |
limit_per_column | integer | No | Cards per column, 1-100 (default 25) |
get_program_flowGet the program flow of a program (a project grouping other projects): its child projects you can access as swimlanes, and the dependency edges (prerequisite -> dependent, with FS/SS/FF/SF type) and link edges (with the relation, e.g. "Related to") between their work items, within and across projects, plus those work items.
| Name | Type | Required | Description |
|---|
program_id | string | Yes | Program numeric id or uniq_id (a project whose purpose is program) |
list_cross_project_relationsList every link and dependency of one work item in any project, in both directions: links it made and links made to it (worded from its side, e.g. "Duplicates" for the far end of "Duplicated by"), what it depends on and what depends on it.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Work item numeric id or uniq_id |
list_linkable_projectsList the projects you may link a work item into or pick a dependency from: active projects you can access, programs excluded, ordered by name.
| Name | Type | Required | Description |
|---|
current_project_id | string | No | Optional project numeric id or uniq_id to flag as the current one |
search_link_targetsFind work items to link to (kind=link) or to depend on (kind=dependency), in one project or across every project you can access (project_id="all", the default).
| Name | Type | Required | Description |
|---|
kind | string | No | link (default) or dependency |
project_id | string | No | Project numeric id or uniq_id to search, or "all" (default) for every project you can access |
task_id | string | No | Optional source work item (numeric id or uniq_id) the target is for |
search | string | No | "#123" for a work item number, or part of a title |
limit | integer | No | Results, 1-25 (default 10) |
Attachments1#
Files attached anywhere in a task's comment thread.
list_task_attachmentsList the files attached to a task, newest first, paginated.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Task numeric id or uniq_id (both are returned by list_tasks/search_tasks/get_task) |
page | integer | No | Page number for pagination (default 1) |
limit | integer | No | Number of files per page (default |
Backlog hierarchy5#
Epics, features, stories and subtasks. Orangescrum v4 projects only.
get_epicGet an Epic and the full hierarchy beneath it: its Features, the Stories under each Feature, and the tasks (and their subtasks) under each Story.
| Name | Type | Required | Description |
|---|
epic_id | string | Yes | Epic numeric id or uniq_id |
include_tree | boolean | No | Set false for the Epic and its counts only, without the descendants (default true) |
create_epicCreate an Epic, the top-level Scrum backlog item, in a project.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project numeric id or uniq_id |
title | string | Yes | Epic title |
description | string | No | Epic description |
assigned_to | integer | No | User ID to assign the epic to |
priority | string | No | Priority: low, medium or high |
due_date | string | No | Due date in YYYY-MM-DD format |
story_point | integer | No | Story points |
create_featureCreate a Feature under an existing Epic.
| Name | Type | Required | Description |
|---|
epic_id | integer | Yes | The ID of the parent Epic |
title | string | Yes | Feature title |
description | string | No | Feature description |
assigned_to | integer | No | User ID to assign the feature to |
priority | string | No | Priority: low, medium or high |
due_date | string | No | Due date in YYYY-MM-DD format |
story_point | integer | No | Story points |
create_storyCreate a Story in a project.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project numeric id or uniq_id |
title | string | Yes | Story title |
feature_id | integer | No | Optional parent Feature ID; inherits that Feature's Epic |
epic_id | integer | No | Optional parent Epic ID (ignored if feature_id is given) |
description | string | No | Story description |
assigned_to | integer | No | User ID to assign the story to |
priority | string | No | Priority: low, medium or high |
due_date | string | No | Due date in YYYY-MM-DD format |
story_point | integer | No | Story points |
create_subtaskCreate a child work-item under a Story or a Task.
| Name | Type | Required | Description |
|---|
parent_task_id | string | Yes | Parent Story or Task numeric id or uniq_id (both are returned by list_tasks/get_task) |
title | string | Yes | Title of the child item |
type_id | integer | No | Optional type ID; defaults to the parent's type |
description | string | No | Description (supports HTML) |
assigned_to | integer | No | User ID to assign to |
priority | string | No | Priority: low, medium or high |
estimated_hours | number | No | Estimated effort in hours (decimal, e.g. 2 or 1.5) |
start_date | string | No | Start date in YYYY-MM-DD format (optional) |
due_date | string | No | Due date in YYYY-MM-DD format |
story_point | integer | No | Story points |
Sprints7#
Create, start and complete sprints, and move work in and out of them.
list_sprintsList sprints for a project.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project numeric id or uniq_id |
status | string | No | Which sprints to return: active (default), completed, or all |
get_sprintGet a single sprint by its numeric id or uniq_id.
| Name | Type | Required | Description |
|---|
sprint_id | string | Yes | Sprint numeric id or uniq_id |
create_sprintCreate a new sprint (also called a milestone, iteration or release) with a name in a project.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project numeric id or uniq_id |
title | string | Yes | Sprint title (must be unique within the project) |
description | string | No | Sprint goal / description |
start_date | string | No | Planned start date in YYYY-MM-DD format |
end_date | string | No | Planned end date in YYYY-MM-DD format |
update_sprintUpdate a sprint's title, description, or planned dates.
| Name | Type | Required | Description |
|---|
sprint_id | string | Yes | Sprint numeric id or uniq_id |
title | string | No | New sprint title (must be unique within the project) |
description | string | No | New sprint goal / description |
start_date | string | No | Planned start date in YYYY-MM-DD format (empty string clears it) |
end_date | string | No | Planned end date in YYYY-MM-DD format (empty string clears it) |
start_sprintStart a sprint.
| Name | Type | Required | Description |
|---|
sprint_id | string | Yes | Sprint numeric id or uniq_id |
start_date | string | No | Sprint start date in YYYY-MM-DD format (must accompany end_date) |
end_date | string | No | Sprint end date in YYYY-MM-DD format (must accompany start_date) |
title | string | No | Optionally rename the sprint on start |
description | string | No | Optionally set the sprint goal on start |
complete_sprintComplete (close) a sprint.
| Name | Type | Required | Description |
|---|
sprint_id | string | Yes | Sprint numeric id or uniq_id |
incomplete_destination | string | No | Where to send incomplete tasks: "backlog" (default) or "next_sprint:<id>" to move them to another active sprint in the same project |
assign_task_to_sprintMove a task into a sprint, or back to the backlog.
| Name | Type | Required | Description |
|---|
task_id | string | Yes | Task numeric id or uniq_id (must be a top-level task, not a subtask) |
sprint_id | string | No | Target sprint numeric id or uniq_id; omit or leave empty to move the task to the backlog |
position | integer | No | Optional 0-based order of the task within the sprint |
Timelogs3#
Log time against tasks and read it back.
list_timelogsList timelogs for the authenticated partner user, with optional filters by project, task, and date range.
| Name | Type | Required | Description |
|---|
project_id | integer | No | Filter timelogs by project ID |
task_id | integer | No | Filter timelogs by task ID |
from | string | No | Start date (YYYY-MM-DD) — inclusive |
to | string | No | End date (YYYY-MM-DD) — inclusive |
page | integer | No | Page number for pagination (default 1) |
limit | integer | No | Number of items per page (default 20, max 100) |
create_timelogLog time against a task.
| Name | Type | Required | Description |
|---|
project_id | integer | Yes | Project ID the time is logged against |
task_id | integer | No | Task ID the time is logged against (optional) |
task_date | string | Yes | Date of the work in YYYY-MM-DD format |
description | string | Yes | Description of the work done |
total_hours | number | No | Total hours spent (decimal; e.g., 2.5 for two and a half hours) |
start_time | string | No | Start time in HH:MM:SS format (optional, overrides total_hours synthesis) |
end_time | string | No | End time in HH:MM:SS format (optional, overrides total_hours synthesis) |
is_billable | boolean | No | Whether the time is billable (default false) |
update_timelogUpdate a timelog entry.
| Name | Type | Required | Description |
|---|
timelog_id | string | Yes | Timelog id — the uniq_id returned by create_timelog/list_timelogs (a numeric log id is also accepted) |
task_date | string | No | Date of the work in YYYY-MM-DD format |
description | string | No | Description of the work done |
total_hours | number | No | Total hours spent (decimal) |
start_time | string | No | Start time in HH:MM:SS format |
end_time | string | No | End time in HH:MM:SS format |
is_billable | boolean | No | Whether the time is billable |
Users3#
The connected user and the workspace directory.
get_current_userReturn authenticated user profile including timezone, roles, and default workspace/company
This tool takes no arguments.
list_usersList users in the company with optional free-text search on name/email and pagination.
| Name | Type | Required | Description |
|---|
search | string | No | Free-text match on user name or email (case-insensitive) |
page | integer | No | Page number for pagination (default 1) |
limit | integer | No | Number of items per page (default 20, max 100) |
get_userGet detailed information about a specific user.
| Name | Type | Required | Description |
|---|
user_id | string | Yes | User numeric id or uniq_id (both are returned by list_users/get_user) |
Project context ("memory")2#
Standing instructions the assistant reads at the start of a conversation.
get_project_contextRetrieve the standing context ("memory") saved for this workspace — background, conventions, and instructions to keep in mind.
| Name | Type | Required | Description |
|---|
project_id | string | No | Optional project numeric id or uniq_id |
add_project_contextSave a standing context ("memory") entry so it is recalled in future conversations.
| Name | Type | Required | Description |
|---|
title | string | Yes | Short label for the entry |
body | string | Yes | The fact, convention, or instruction to remember |
project_id | string | No | Optional project numeric id or uniq_id; omit for company-wide |
Document search1#
Semantic search over documents uploaded to the workspace.
search_documentsSearch documents uploaded to this Orangescrum workspace (PDFs, Word, Excel, images) by meaning and return the most relevant excerpts with their source document.
| Name | Type | Required | Description |
|---|
query | string | Yes | What to look for, in natural language |
project_id | integer | No | Optional project id to scope the search to one project |
limit | integer | No | Maximum excerpts to return (1-20, default 5) |
Knowledge Base: Library, books and search8#
Find books and pages, read page trees, bodies, backlinks and attachments, and run ranked search.
list_wiki_libraryList the Knowledge Base (wiki) library: the shelves and the books you can see, each book with its page count, last activity, shelf and linked project.
| Name | Type | Required | Description |
|---|
shelf_id | integer | No | Only books on this shelf |
search | string | No | Text to find in book names |
get_wiki_bookGet one Knowledge Base book: its details, shelf, linked project, owner, your capabilities in it (view, create, edit, comment, delete) and its top-level pages and folders with their child counts.
| Name | Type | Required | Description |
|---|
book_id | integer | Yes | Book (wiki space) id from list_wiki_library |
get_wiki_book_treeGet the full page tree of a Knowledge Base book: every live page and folder you can see, with parent_id and position so the hierarchy can be rebuilt, plus an indented outline.
| Name | Type | Required | Description |
|---|
book_id | integer | Yes | Book (wiki space) id from list_wiki_library |
get_wiki_pageRead a Knowledge Base page: its body (HTML, or plain text with format=text), title, book, breadcrumb, labels, properties (frontmatter), publication state (draft, published, obsolete), review state, author and last editor, links to work items, projects and programs, your capabilities on it and whether you watch it.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
format | string | No | html (default): the stored body; text: plain text, shorter |
search_wiki_pagesSearch the Knowledge Base pages you can see.
| Name | Type | Required | Description |
|---|
query | string | No | Words to search for |
book_id | integer | No | Only pages in this book |
label | string | No | Only pages carrying this label |
contributor_id | integer | No | Only pages created or last edited by this member |
days | integer | No | Only pages updated in the last N days |
limit | integer | No | Maximum results (default 20, max 60) |
list_wiki_backlinksList the Knowledge Base pages whose body links to this page (backlinks), in any book you can see.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
list_wiki_page_attachmentsList the files attached to a Knowledge Base page, newest first: name, size, type, source (uploaded or linked from the document repository), lock state, uploader, and the web address that serves the file to signed-in members.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
list_wiki_pages_for_targetList the Knowledge Base pages linked to a work item, a project or a program (the "Knowledge base" panel on those screens): find the specs, runbooks or meeting notes behind a piece of work.
| Name | Type | Required | Description |
|---|
target_type | string | Yes | work_item, project or program |
target_id | string | Yes | Numeric id of the work item, project or program; a work item's uniq_id also works |
Knowledge Base: Writing pages7#
Create, edit, move, copy, archive and restore pages and folders.
create_wiki_pageCreate a Knowledge Base page (or a folder to group pages) in a book, at the top level or under a parent page.
| Name | Type | Required | Description |
|---|
book_id | integer | Yes | Book (wiki space) id from list_wiki_library |
title | string | No | Page title (required for a folder; "Untitled" when left out) |
content | string | No | Page body |
content_format | string | No | markdown (default) or html. Either way the body is sanitized to the Knowledge Base allow-list. |
parent_id | integer | No | Create under this page or folder of the same book; omit for the top level |
node_type | string | No | page (default) or folder |
pub_state | string | No | draft (default), published or obsolete |
icon | string | No | One emoji |
description | string | No | Short summary (max 500 characters) |
labels | array | No | Labels (tags); replaces the existing set |
update_wiki_pageChange a Knowledge Base page: title, body, labels, properties (frontmatter), icon, description or publication state.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
title | string | No | New title |
content | string | No | New body, replacing the current one |
content_format | string | No | markdown (default) or html. Either way the body is sanitized to the Knowledge Base allow-list. |
revision_note | string | No | Note stored with the replaced version |
pub_state | string | No | draft, published or obsolete |
icon | string | No | One emoji; empty to clear |
description | string | No | Short summary; empty to clear |
labels | array | No | Labels (tags); replaces the existing set |
frontmatter | object | No | Page properties as key/value text pairs (max 30); replaces the existing set |
move_wiki_pageMove a Knowledge Base page or folder, with everything under it: under another page (parent_id), to the top level of a book (book_id, which may be another book), or to another position among its siblings (position only).
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
parent_id | integer | No | New parent page or folder |
book_id | integer | No | Destination book; alone, moves the page to that book's top level |
position | integer | No | Position among the new siblings, 0 first; default last |
copy_wiki_pageDuplicate a Knowledge Base page next to itself as a draft titled "… (copy)", with its body, labels and properties but a fresh history.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
archive_wiki_pageArchive (delete) a Knowledge Base page or an empty folder.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
list_archived_wiki_pagesList archived (deleted) Knowledge Base pages, most recently archived first, so one can be brought back with restore_wiki_page.
| Name | Type | Required | Description |
|---|
book_id | integer | No | Only pages from this book |
page | integer | No | Page number (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
restore_wiki_pageBring back an archived Knowledge Base page (see list_archived_wiki_pages).
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
Knowledge Base: History4#
Page revisions: list, read, save a named version and restore one.
list_wiki_page_revisionsList the version history of a Knowledge Base page, newest first: revision number, title, note, author, when it was saved and whether it was a published version.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
limit | integer | No | How many revisions (default and max 50) |
get_wiki_page_revisionRead one saved version of a Knowledge Base page, with its body (HTML, or plain text with format=text), title, note and author.
| Name | Type | Required | Description |
|---|
revision_id | integer | Yes | Revision id from list_wiki_page_revisions |
format | string | No | html (default): the stored body; text: plain text, shorter |
save_wiki_page_versionSave the current title and body of a Knowledge Base page as a named version in its history, without changing the page.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
note | string | No | What this version is, e.g. "Before Q4 rewrite" |
restore_wiki_page_revisionPut an older version's body back on its Knowledge Base page.
| Name | Type | Required | Description |
|---|
revision_id | integer | Yes | Revision id from list_wiki_page_revisions |
Knowledge Base: Comments, action items, review and links13#
Comment and resolve, manage action items, request and decide reviews, watch pages, and link pages to work items, projects and programs.
list_wiki_page_commentsList the comments on a Knowledge Base page, oldest first, with author, body (HTML plus a plain-text copy), whether each is resolved, and emoji reactions.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
unresolved_only | boolean | No | Leave out resolved comments |
page | integer | No | Page number (default 1) |
limit | integer | No | Comments per page (default 50, max 100) |
add_wiki_commentPost a comment on a Knowledge Base page.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
body | string | Yes | Comment text |
body_format | string | No | markdown (default) or html |
mention_user_ids | array | No | Members to @mention |
resolve_wiki_commentMark a Knowledge Base page comment resolved, or open again with resolved=false.
| Name | Type | Required | Description |
|---|
comment_id | integer | Yes | Comment id from list_wiki_page_comments |
resolved | boolean | No | true (default) to resolve, false to reopen |
list_wiki_action_itemsList Knowledge Base action items (to-dos captured on pages): on one page (scope=page with page_id), across a book (scope=book with book_id), assigned to you (scope=mine, the default) or every open one in the workspace (scope=open).
| Name | Type | Required | Description |
|---|
scope | string | No | page, book, mine (default) or open |
page_id | integer | No | Page id, for scope=page |
book_id | integer | No | Book id, for scope=book |
open_only | boolean | No | Leave out finished items |
save_wiki_action_itemAdd an action item (a to-do) to a Knowledge Base page, or change one by passing action_item_id: text, assignee, due date or position; passing page_id with action_item_id moves it to that page.
| Name | Type | Required | Description |
|---|
action_item_id | integer | No | Existing action item to change; omit to create |
page_id | integer | No | Page the item belongs to (required to create) |
text | string | No | What needs doing (max 500 characters) |
assignee_id | integer | No | Member responsible; 0 to unassign |
due_date | string | No | Due date, YYYY-MM-DD; empty to clear |
position | integer | No | Order on the page |
set_wiki_action_item_doneMark a Knowledge Base action item done, or open again with done=false.
| Name | Type | Required | Description |
|---|
action_item_id | integer | Yes | Action item id |
done | boolean | No | true (default) for done, false to reopen |
delete_wiki_action_itemDelete an action item from a Knowledge Base page for good.
| Name | Type | Required | Description |
|---|
action_item_id | integer | Yes | Action item id |
get_wiki_reviewGet a Knowledge Base page's review: its state (none, in_review, approved, changes_requested), reviewer, who asked, the latest note, whether you are the reviewer, and the last 30 review events.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
request_wiki_reviewSend a Knowledge Base page to a reviewer: the page shows "in review" and the reviewer is notified.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
reviewer_id | integer | Yes | Member who reviews the page |
note | string | No | Note for the reviewer |
decide_wiki_reviewDecide a Knowledge Base page review: approve (which publishes the page) or request_changes, with an optional note for the author, who is notified.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
decision | string | Yes | approve or request_changes |
note | string | No | Note for the author |
watch_wiki_pageWatch a Knowledge Base page to be notified when it changes, or stop with watch=false. scope=subtree also covers every page under it, scope=space the whole book. frequency sets how notifications are emailed: immediate, daily or weekly digest, or off (in-app only).
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
scope | string | No | page (default), subtree or space |
watch | boolean | No | true (default) to watch, false to stop |
frequency | string | No | immediate (default), daily, weekly or off |
link_wiki_pageLink a Knowledge Base page to a work item, a project or a program, so it shows in that item's Knowledge base panel and in the page's links.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
target_type | string | Yes | work_item, project or program |
target_id | string | Yes | Numeric id of the work item, project or program; a work item's uniq_id also works |
unlink_wiki_pageRemove the link between a Knowledge Base page and a work item, project or program.
| Name | Type | Required | Description |
|---|
page_id | integer | Yes | Knowledge Base page id (page_id from list or search results) |
target_type | string | Yes | work_item, project or program |
target_id | string | Yes | Numeric id of the work item, project or program; a work item's uniq_id also works |
Knowledge Base: Books and shelves4#
Create, edit and archive books and shelves.
save_wiki_bookCreate a Knowledge Base book (a wiki space), or change one by passing book_id: name, description, icon, cover colour, the project it belongs to, or its shelf (0 to unshelve).
| Name | Type | Required | Description |
|---|
book_id | integer | No | Existing book to change; omit to create |
name | string | No | Book name (required to create) |
description | string | No | What the book holds |
icon | string | No | One emoji |
cover_color | string | No | Cover colour as #RRGGBB |
project_id | integer | No | Project the book belongs to; 0 for none |
shelf_id | integer | No | Shelf to put the book on; 0 for none |
archive_wiki_bookArchive a Knowledge Base book.
| Name | Type | Required | Description |
|---|
book_id | integer | Yes | Book (wiki space) id from list_wiki_library |
save_wiki_shelfCreate a Knowledge Base shelf to group books, or change one by passing shelf_id: name, description or icon.
| Name | Type | Required | Description |
|---|
shelf_id | integer | No | Existing shelf to change; omit to create |
name | string | No | Shelf name (required to create) |
description | string | No | What the shelf groups |
icon | string | No | One emoji |
archive_wiki_shelfArchive a Knowledge Base shelf.
| Name | Type | Required | Description |
|---|
shelf_id | integer | Yes | Shelf id from list_wiki_library |
Test Lab: Repository20#
Test cases, suites, datasets, shared steps and custom fields.
list_test_lookupsList the allowed values for Test Lab fields in this workspace: test case priority, type, state, template and automation status, and defect severity, priority, status, resolution and root cause.
This tool takes no arguments.
create_test_caseCreate a test case in the Test Lab repository (/test-lab#/repository) of a project.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project id or uniq_id |
title | string | Yes | Case title (max 500 chars) |
list_test_casesList Test Lab test cases (the /test-lab#/repository list), ordered by project and TC number.
| Name | Type | Required | Description |
|---|
project_id | string | No | Project id or uniq_id; omit for all your projects |
suite_id | integer | No | Suite id (includes its sub-suites); 0 for unassigned cases |
priority | string | No | Comma-separated priorities, e.g. high,critical |
type | string | No | Comma-separated types |
state | string | No | Comma-separated states: draft, in_review, active, deprecated |
automation_status | string | No | Comma-separated: manual, to_automate, automated |
scenario_id | integer | No | Only cases in this scenario |
owner_id | integer | No | Only cases owned by this user id |
search | string | No | Matches title, steps or tags; a number also matches the TC number |
tag | string | No | Exact tag |
page | integer | No | Page (default 1) |
limit | integer | No | Per page (default 50, max 200) |
get_test_caseGet a Test Lab test case with all its fields and steps, plus its links (tasks, cases, defects, runs), comments, attachments and latest run results.
| Name | Type | Required | Description |
|---|
test_case_id | integer | Yes | Test case id |
update_test_caseUpdate a Test Lab test case.
| Name | Type | Required | Description |
|---|
test_case_id | integer | Yes | Test case id (the number behind TC-n is case_no; use the id from list/get) |
title | string | No | Case title (max 500 chars) |
delete_test_caseDelete a Test Lab test case.
| Name | Type | Required | Description |
|---|
test_case_id | integer | Yes | Test case id |
list_test_case_versionsVersion history of a Test Lab test case, newest first (up to 30).
| Name | Type | Required | Description |
|---|
test_case_id | integer | Yes | Test case id |
list_test_suitesList the Test Lab suites (the folder tree of the repository) of a project, with parent ids and case counts.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project id or uniq_id |
create_test_suiteCreate a test suite (a folder in the Test Lab repository, /test-lab#/repository) in a project, optionally inside a parent suite.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project id or uniq_id |
name | string | Yes | Suite name |
description | string | No | Description |
parent_id | integer | No | Parent suite id; 0 for top level |
update_test_suiteRename a Test Lab suite, change its description, or move it under another suite of the same project.
| Name | Type | Required | Description |
|---|
suite_id | integer | Yes | Suite id (from list_test_suites) |
name | string | No | New name |
description | string | No | Description |
parent_id | integer | No | Parent suite id; 0 for top level |
list_test_datasetsList the parameter datasets a project can use (its own plus workspace-wide).
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project id or uniq_id |
add_test_case_tagsAdd tags to one or more Test Lab test cases (like the Add tag bulk action).
| Name | Type | Required | Description |
|---|
test_case_ids | array | Yes | Test case ids |
tags | array | Yes | Tags to add |
export_test_casesExport Test Lab test cases as CSV, the same format as the Test Lab Export button (TC id, title, priority, steps as "step => expected | ...", suite, owner, ...).
| Name | Type | Required | Description |
|---|
project_id | string | No | Project id or uniq_id; omit for all your projects |
test_case_ids | array | No | Export exactly these cases |
suite_id | integer | No | Suite (with sub-suites); 0 for unassigned |
priority | string | No | Comma-separated |
type | string | No | Comma-separated |
state | string | No | Comma-separated |
automation_status | string | No | Comma-separated |
scenario_id | integer | No | Scenario id |
columns | array | No | Columns to include (default all): case_no, title, description, priority, type, state, automation_status, automation_ref, tags, last_status, preconditions, steps, expected_result, suite, scenario, owner, estimate_min, version, created, modified |
create_test_datasetCreate a Test Lab parameter dataset: named columns and rows of values.
| Name | Type | Required | Description |
|---|
name | string | Yes | Dataset name |
project_id | string | No | Project id or uniq_id; omit for a workspace-wide dataset |
description | string | No | Description |
columns | array | Yes | Column names, used as {name} placeholders in cases (letters, digits, _ . -) |
rows | array | No | Rows as objects keyed by column, e.g. [{"username": "alice"}]. Replaces all rows |
update_test_datasetUpdate a Test Lab dataset: rename, change description or project, or replace its columns and rows.
| Name | Type | Required | Description |
|---|
dataset_id | integer | Yes | Dataset id (from list_test_datasets) |
name | string | No | Dataset name |
description | string | No | Description |
project_id | string | No | Project id or uniq_id; empty for workspace-wide |
columns | array | No | Column names, used as {name} placeholders in cases (letters, digits, _ . -) |
rows | array | No | Rows as objects keyed by column, e.g. [{"username": "alice"}]. Replaces all rows |
list_test_shared_stepsList Test Lab shared steps: reusable step blocks a project's cases can copy in.
| Name | Type | Required | Description |
|---|
project_id | string | No | Project id or uniq_id; omit for all your projects |
update_test_shared_stepEdit a Test Lab shared step block: rename it or replace its steps.
| Name | Type | Required | Description |
|---|
shared_step_id | integer | Yes | Shared step id (from list_test_shared_steps) |
title | string | No | Title |
steps | array | No | Ordered steps: strings or {"step": "...", "expected": "..."}. Replaces the whole list |
list_test_custom_fieldsList the Test Lab custom field definitions (workspace-wide) for test cases and / or defects, with their keys, types and options.
| Name | Type | Required | Description |
|---|
entity | string | No | case or defect; omit for both |
create_test_custom_fieldCreate a Test Lab custom field for test cases or defects (workspace-wide).
| Name | Type | Required | Description |
|---|
entity | string | Yes | case or defect |
label | string | Yes | Label shown in Test Lab; the field key is derived from it on create |
type | string | No | text, textarea, select, multiselect, number, date, checkbox, url or user |
options | array | No | Choices for select / multiselect |
is_required | boolean | No | Required in the Test Lab form |
is_visible | boolean | No | Shown in the form (default true) |
sort_order | integer | No | Display order |
update_test_custom_fieldEdit a Test Lab custom field: label, type, options, required, visible or order.
| Name | Type | Required | Description |
|---|
field_id | integer | Yes | Field id (from list_test_custom_fields) |
label | string | No | Label shown in Test Lab; the field key is derived from it on create |
type | string | No | text, textarea, select, multiselect, number, date, checkbox, url or user |
options | array | No | Choices for select / multiselect |
is_required | boolean | No | Required in the Test Lab form |
is_visible | boolean | No | Shown in the form (default true) |
sort_order | integer | No | Display order |
Comments, links and attachments on cases, defects and runs.
list_test_commentsList comments on a Test Lab test case, defect or run (oldest first).
| Name | Type | Required | Description |
|---|
entity_type | string | Yes | case, defect or run |
entity_id | integer | Yes | Id of that record |
add_test_commentAdd a comment to a Test Lab test case, defect or run (max 8000 chars).
| Name | Type | Required | Description |
|---|
entity_type | string | Yes | case, defect or run |
entity_id | integer | Yes | Id of that record |
body | string | Yes | Comment text |
add_test_linkLink a Test Lab test case or defect to an Orangescrum task, another test case, a defect or a run.
| Name | Type | Required | Description |
|---|
entity_type | string | Yes | case or defect |
entity_id | integer | Yes | Id of the case or defect |
target_type | string | Yes | workitem (an Orangescrum task), case, defect or run |
target_id | string | Yes | Target id; for a workitem the task id or uniq_id |
remove_test_linkRemove a Test Lab link by its link id (shown in get_test_case / get_defect links).
| Name | Type | Required | Description |
|---|
link_id | integer | Yes | Link id |
list_test_attachmentsList the files attached to a Test Lab test case, defect, scenario or run result, newest first, each with a link that opens it in Orangescrum (images inline, other files download; the viewer must be signed in).
| Name | Type | Required | Description |
|---|
entity_type | string | Yes | case, defect, scenario or result |
entity_id | integer | Yes | Id of that record (for result: the run result id) |
Test Lab: Scenarios and strategies12#
Scenarios that group cases, and strategies that group scenarios.
list_test_scenariosList Test Lab scenario records (the /test-lab#/scenarios screen) with their child counts.
| Name | Type | Required | Description |
|---|
project_id | string | No | Project id or uniq_id; omit for all your projects |
state | string | No | Comma-separated states |
search | string | No | Matches title, description or number |
priority | string | No | Comma-separated priorities |
strategy_id | integer | No | Only scenarios in this strategy |
page | integer | No | Page (default 1) |
limit | integer | No | Per page (default 50) |
get_test_scenarioGet a Test Lab test scenario with its cases.
| Name | Type | Required | Description |
|---|
scenario_id | integer | Yes | Scenario id |
create_test_scenarioCreate a Test Lab test scenario in a project; it gets the next number in the project.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project id or uniq_id |
title | string | Yes | Title |
description | string | No | Description |
state | string | No | State, e.g. draft, in_review, active, deprecated |
owner_id | string | No | Owner user id or uniq_id (active workspace member) |
tags | array | No | Tags; replaces the list |
suite_id | integer | No | Suite id in the same project; 0 to clear |
strategy_id | integer | No | Strategy id in the same project; 0 to clear |
gherkin | string | No | Gherkin text |
priority | string | No | Priority, e.g. critical, high, medium, low |
update_test_scenarioUpdate a Test Lab test scenario; only the fields you pass change.
| Name | Type | Required | Description |
|---|
scenario_id | integer | Yes | Scenario id |
title | string | No | Title |
description | string | No | Description |
state | string | No | State, e.g. draft, in_review, active, deprecated |
owner_id | string | No | Owner user id or uniq_id (active workspace member) |
tags | array | No | Tags; replaces the list |
suite_id | integer | No | Suite id in the same project; 0 to clear |
strategy_id | integer | No | Strategy id in the same project; 0 to clear |
gherkin | string | No | Gherkin text |
priority | string | No | Priority, e.g. critical, high, medium, low |
delete_test_scenarioDelete a Test Lab test scenario (soft delete).
| Name | Type | Required | Description |
|---|
scenario_id | integer | Yes | Scenario id |
set_scenario_casesAttach test cases to a Test Lab test scenario (attach=true, default) or detach them (attach=false).
| Name | Type | Required | Description |
|---|
scenario_id | integer | Yes | Scenario id |
case_ids | array | Yes | Test case ids |
attach | boolean | No | true to attach (default), false to detach |
list_test_strategiesList Test Lab strategy records (the /test-lab#/strategies screen) with their child counts.
| Name | Type | Required | Description |
|---|
project_id | string | No | Project id or uniq_id; omit for all your projects |
state | string | No | Comma-separated states |
search | string | No | Matches title, description or number |
plan_id | integer | No | Only strategies in this plan |
page | integer | No | Page (default 1) |
limit | integer | No | Per page (default 50) |
get_test_strategyGet a Test Lab test strategy with its scenarios.
| Name | Type | Required | Description |
|---|
strategy_id | integer | Yes | Strategy id |
create_test_strategyCreate a Test Lab test strategy in a project; it gets the next number in the project.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project id or uniq_id |
title | string | Yes | Title |
description | string | No | Description |
state | string | No | State, e.g. draft, in_review, active, deprecated |
owner_id | string | No | Owner user id or uniq_id (active workspace member) |
tags | array | No | Tags; replaces the list |
plan_id | integer | No | Test plan id in the same project; 0 to clear |
update_test_strategyUpdate a Test Lab test strategy; only the fields you pass change.
| Name | Type | Required | Description |
|---|
strategy_id | integer | Yes | Strategy id |
title | string | No | Title |
description | string | No | Description |
state | string | No | State, e.g. draft, in_review, active, deprecated |
owner_id | string | No | Owner user id or uniq_id (active workspace member) |
tags | array | No | Tags; replaces the list |
plan_id | integer | No | Test plan id in the same project; 0 to clear |
delete_test_strategyDelete a Test Lab test strategy (soft delete).
| Name | Type | Required | Description |
|---|
strategy_id | integer | Yes | Strategy id |
set_strategy_scenariosAttach test scenarios to a Test Lab test strategy (attach=true, default) or detach them (attach=false).
| Name | Type | Required | Description |
|---|
strategy_id | integer | Yes | Strategy id |
scenario_ids | array | Yes | Test scenario ids |
attach | boolean | No | true to attach (default), false to detach |
Test Lab: Plans and runs16#
Test plans, runs and recorded results.
get_test_run_setupList what a project's Test Lab runs and plans can use: configurations, environments and open sprints / milestones.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project id or uniq_id |
list_test_plansList Test Lab test plans (the /test-lab#/plans screen) with their case selection, configurations and run count.
| Name | Type | Required | Description |
|---|
project_id | string | No | Project id or uniq_id; omit for all your projects |
get_test_planGet a Test Lab test plan with the runs it has launched and their progress.
| Name | Type | Required | Description |
|---|
plan_id | integer | Yes | Plan id |
create_test_planCreate a Test Lab test plan: which cases to run (selection), against which configurations, for which sprint.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project id or uniq_id |
name | string | Yes | Plan name |
description | string | No | Description |
milestone_id | string | No | Sprint / milestone id or uniq_id; empty to clear |
config_ids | array | No | Configuration ids (get_test_run_setup); one run per configuration on launch |
selection | object | No | Which cases a launch runs: {"mode": "all"|"cases"|"suites"|"filter", "case_ids": [..], "suite_ids": [..], "filter_priority": [..], "filter_automation": "manual"|"to_automate"|"automated"} |
status | string | No | draft or active |
update_test_planUpdate a Test Lab test plan; only the fields you pass change.
| Name | Type | Required | Description |
|---|
plan_id | integer | Yes | Plan id |
name | string | No | Plan name |
description | string | No | Description |
milestone_id | string | No | Sprint / milestone id or uniq_id; empty to clear |
config_ids | array | No | Configuration ids (get_test_run_setup); one run per configuration on launch |
selection | object | No | Which cases a launch runs: {"mode": "all"|"cases"|"suites"|"filter", "case_ids": [..], "suite_ids": [..], "filter_priority": [..], "filter_automation": "manual"|"to_automate"|"automated"} |
status | string | No | draft or active |
launch_test_planLaunch a Test Lab test plan: creates one active run per configuration (or one run without), each with an item per selected case (per dataset row for parameterised cases).
| Name | Type | Required | Description |
|---|
plan_id | integer | Yes | Plan id |
delete_test_planDelete a Test Lab test plan (soft delete).
| Name | Type | Required | Description |
|---|
plan_id | integer | Yes | Plan id |
list_test_runsList Test Lab runs (the /test-lab#/runs screen) with progress stats. source=exploratory lists exploratory sessions.
| Name | Type | Required | Description |
|---|
project_id | string | No | Project id or uniq_id; omit for all your projects |
status | string | No | active, completed or archived |
source | string | No | manual, automation or exploratory |
plan_id | integer | No | Only runs launched from this plan |
search | string | No | Matches the run name |
page | integer | No | Page (default 1) |
limit | integer | No | Per page (default 50) |
get_test_runGet a Test Lab run with every item (case, steps with dataset values filled in, status, assignee, comment), its stats and the defects raised in it.
| Name | Type | Required | Description |
|---|
run_id | integer | Yes | Run id |
create_test_runStart a Test Lab run in a project.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project id or uniq_id |
name | string | Yes | Run name |
description | string | No | Description |
environment | string | No | Environment name (max 100) |
milestone_id | string | No | Sprint / milestone id or uniq_id |
assigned_to | string | No | Assignee user id or uniq_id; every item is assigned to them |
case_ids | array | No | Run exactly these cases |
suite_ids | array | No | Or every case in these suites |
filter_priority | string | No | Narrow by comma-separated priorities |
filter_automation | string | No | Narrow by manual, to_automate or automated |
update_test_runRename a Test Lab run or change its description, environment, sprint or assignee.
| Name | Type | Required | Description |
|---|
run_id | integer | Yes | Run id |
name | string | No | Run name |
description | string | No | Description |
environment | string | No | Environment name (max 100) |
milestone_id | string | No | Sprint / milestone id or uniq_id |
assigned_to | string | No | Assignee user id or uniq_id; every item is assigned to them |
record_test_resultRecord a result in an active Test Lab run: one item (with optional per-step results) or the same result on several items of one run.
| Name | Type | Required | Description |
|---|
item_ids | array | Yes | Run item ids (from get_test_run), all in one run |
status | string | Yes | untested, passed, failed, blocked, skipped or retest |
comment | string | No | Result comment |
elapsed_sec | integer | No | Time spent, seconds |
step_results | array | No | Per-step results for a single item: [{"i": 0, "status": "passed"}] |
list_test_result_historyResult history of one Test Lab run item, newest first, with step results and any defect raised.
| Name | Type | Required | Description |
|---|
item_id | integer | Yes | Run item id |
close_test_runClose (complete) a Test Lab run or end an exploratory session.
| Name | Type | Required | Description |
|---|
run_id | integer | Yes | Run id |
rerun_failed_testsStart a new Test Lab run containing the failed and blocked items of an earlier run.
| Name | Type | Required | Description |
|---|
run_id | integer | Yes | Run id to rerun from |
delete_test_runDelete a Test Lab run (soft delete).
| Name | Type | Required | Description |
|---|
run_id | integer | Yes | Run id |
Test Lab: Exploratory sessions3#
Timed exploratory sessions and their notes.
start_exploratory_sessionStart a Test Lab exploratory session (the /test-lab#/explore screen): a run with a charter and no scripted items.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project id or uniq_id |
name | string | Yes | Session name |
charter | string | No | Charter: what to explore and why |
environment | string | No | Environment |
add_exploratory_noteLog a finding in an active Test Lab exploratory session: a note, bug, idea or question.
| Name | Type | Required | Description |
|---|
run_id | integer | Yes | Exploratory session (run) id |
type | string | Yes | note, bug, idea or question |
text | string | Yes | What you found |
list_exploratory_notesList the findings (notes, bugs, ideas, questions) of a Test Lab exploratory session.
| Name | Type | Required | Description |
|---|
run_id | integer | Yes | Exploratory session (run) id |
Test Lab: Baselines5#
Frozen snapshots of a project's test cases: compare and restore.
list_test_baselinesList Test Lab baselines (frozen snapshots of a project's test cases, the /test-lab#/baselines screen).
| Name | Type | Required | Description |
|---|
project_id | string | No | Project id or uniq_id; omit for all your projects |
create_test_baselineFreeze the active test cases of a project (or of a suite and its sub-suites) as a Test Lab baseline, to compare against or restore from later.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project id or uniq_id |
name | string | Yes | Baseline name, e.g. Release 4.2 |
description | string | No | Description |
suite_id | integer | No | Only this suite and its sub-suites |
compare_test_baselineCompare a Test Lab baseline with the current test cases (default) or another baseline of the same project: which cases changed (and which fields), were added, removed or moved.
| Name | Type | Required | Description |
|---|
baseline_id | integer | Yes | Baseline id |
to_baseline_id | integer | No | Compare with this baseline instead of the current cases |
changed_only | boolean | No | Leave out unchanged cases |
restore_test_baselineRestore test cases to their content in a Test Lab baseline.
| Name | Type | Required | Description |
|---|
baseline_id | integer | Yes | Baseline id |
case_ids | array | Yes | Test case ids to restore |
delete_test_baselineDelete a Test Lab baseline and its frozen cases (permanent, as in Test Lab).
| Name | Type | Required | Description |
|---|
baseline_id | integer | Yes | Baseline id |
Test Lab: Defects8#
File, update and relate defects.
list_defectsList Test Lab defects (the /test-lab#/defects list), newest BUG number first.
| Name | Type | Required | Description |
|---|
project_id | string | No | Project id or uniq_id; omit for all your projects |
status | string | No | Comma-separated workflow statuses |
severity | string | No | Comma-separated severities |
priority | string | No | Comma-separated priorities |
resolution | string | No | Comma-separated resolutions |
assigned_to | integer | No | Assignee user id |
case_id | integer | No | Only defects raised against this test case |
run_id | integer | No | Only defects raised in this run |
open_only | boolean | No | Only defects in an open-category status |
search | string | No | Matches title or tags; a number also matches the BUG number |
page | integer | No | Page (default 1) |
limit | integer | No | Per page (default 50, max 300) |
get_defectGet a Test Lab defect with all its fields, related defects, watchers, change history, links (tasks, cases, runs), comments and attachments.
| Name | Type | Required | Description |
|---|
defect_id | integer | Yes | Defect id |
create_defectReport a defect in Test Lab (/test-lab#/defects) for a project.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project id or uniq_id |
title | string | Yes | Defect title (max 500 chars) |
status | string | No | Initial workflow status; default the first one (new). Closed statuses need a resolution |
resolution | string | No | Resolution, required when creating directly in a closed status |
update_defectUpdate a Test Lab defect.
| Name | Type | Required | Description |
|---|
defect_id | integer | Yes | Defect id (from list_defects / get_defect) |
title | string | No | Defect title (max 500 chars) |
resolution | string | No | Resolution |
set_defect_statusMove a Test Lab defect to another workflow status (default new, open, in_progress, fixed, retest, verified, closed, rejected, duplicate).
| Name | Type | Required | Description |
|---|
defect_id | integer | Yes | Defect id |
status | string | Yes | Workflow status key, e.g. in_progress or closed (labels like "In Progress" also work) |
resolution | string | No | Resolution, required for closed statuses: fixed, wont_fix, duplicate, cannot_reproduce, works_as_designed |
delete_defectDelete a Test Lab defect (soft delete, as in the Test Lab UI).
| Name | Type | Required | Description |
|---|
defect_id | integer | Yes | Defect id |
add_defect_relationRelate two Test Lab defects: duplicate_of, relates, blocks or blocked_by.
| Name | Type | Required | Description |
|---|
defect_id | integer | Yes | Defect id |
relation | string | Yes | duplicate_of, relates, blocks or blocked_by |
related_defect_id | integer | No | Other defect id |
related_defect_no | integer | No | Or the other defect's BUG number in the same project |
remove_defect_relationRemove a relation between two Test Lab defects by its relation id (from get_defect relations).
| Name | Type | Required | Description |
|---|
relation_id | integer | Yes | Relation id |
Versions and releases: Versions, releases and approvals29#
Versions and releases, their items, progress, readiness, approval chains and release notes.
list_versionsList versions (planned product versions such as 4.2) in one project, or across every project you can access when project_id is omitted.
| Name | Type | Required | Description |
|---|
project_id | string | No | Project numeric id or uniq_id; omit for all your projects |
status | string | No | Only this status: Draft, Planned, Active, On Hold, Released or Archived |
owner_id | integer | No | Only versions owned by this user id |
search | string | No | Matches name or key |
include_archived | boolean | No | Include Archived versions (default false) |
sort | string | No | name, key, status, owner_id, planned_start_dt, planned_end_dt or created (default planned_end_dt) |
direction | string | No | asc or desc (default desc) |
page | integer | No | Page number, from 1 (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
get_versionGet one version with its owner, dates, status, the statuses it can move to next, item and release counts, and its recent change history.
| Name | Type | Required | Description |
|---|
version_id | integer | Yes | Version id (from list_versions) |
create_versionCreate a version in a project.
| Name | Type | Required | Description |
|---|
project_id | string | Yes | Project numeric id or uniq_id |
name | string | Yes | Version name, e.g. Spring release |
key | string | Yes | Short unique key in the project, e.g. v4.2 |
description | string | No | Description |
goal | string | No | Goal of the version |
owner_id | string | No | Owner user id or uniq_id; must be an active member of the workspace; empty string clears it |
planned_start_dt | string | No | Planned start date (YYYY-MM-DD; empty string clears it) |
planned_end_dt | string | No | Planned end date, on or after the start date (YYYY-MM-DD; empty string clears it) |
update_versionUpdate a version's name, description, goal, owner or planned dates.
| Name | Type | Required | Description |
|---|
version_id | integer | Yes | Version id (from list_versions) |
name | string | No | Version name |
description | string | No | Description |
goal | string | No | Goal of the version |
owner_id | string | No | Owner user id or uniq_id; must be an active member of the workspace; empty string clears it |
planned_start_dt | string | No | Planned start date (YYYY-MM-DD; empty string clears it) |
planned_end_dt | string | No | Planned end date, on or after the start date (YYYY-MM-DD; empty string clears it) |
transition_versionMove a version to another status: Draft, Planned, Active, On Hold, Released or Archived.
| Name | Type | Required | Description |
|---|
version_id | integer | Yes | Version id (from list_versions) |
status | string | Yes | Target status: Draft, Planned, Active, On Hold, Released or Archived |
delete_versionDelete a version (soft delete, as the Delete button in the app; the plugin calls this archiving).
| Name | Type | Required | Description |
|---|
version_id | integer | Yes | Version id (from list_versions) |
list_version_itemsList the work items (epics, features, stories, tasks, defects) linked to a version, newest first, with title, number, status, due date and assignee.
| Name | Type | Required | Description |
|---|
version_id | integer | Yes | Version id (from list_versions) |
page | integer | No | Page number, from 1 (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
add_version_itemsLink work items to a version in one all-or-nothing call (up to 100).
| Name | Type | Required | Description |
|---|
version_id | integer | Yes | Version id (from list_versions) |
items | array | Yes | Items to link |
remove_version_itemUnlink one work item from a version. item_id is the link id shown by list_version_items, not the task id.
| Name | Type | Required | Description |
|---|
version_id | integer | Yes | Version id (from list_versions) |
item_id | integer | Yes | Link id from list_version_items |
get_version_progressCompletion of a version: linked items done out of total, overall percent, and per type.
| Name | Type | Required | Description |
|---|
version_id | integer | Yes | Version id (from list_versions) |
get_release_roadmapRoadmap of a project, or of every project you can access when project_id is omitted: versions in planned start order, each with its releases.
| Name | Type | Required | Description |
|---|
project_id | string | No | Project numeric id or uniq_id; omit for every project you can access |
status | string | No | Comma-separated version statuses: Draft, Planned, Active, On Hold, Released or Archived |
include_archived | boolean | No | Include Archived versions (default false) |
page | integer | No | Page number, from 1 (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
list_releasesList releases (shippable builds of a version, such as 4.2.1) for a version, a project, or every project you can access.
| Name | Type | Required | Description |
|---|
version_id | integer | No | Only releases of this version |
project_id | string | No | Project numeric id or uniq_id; omit for all your projects |
status | string | No | Only this status: Draft, Planned, Testing, Ready, Approved, Released, Rolled Back or Cancelled |
type | string | No | Only this type: Major, Minor, Patch, Hotfix, Beta or Release Candidate |
search | string | No | Matches name or release number |
sort | string | No | name, status, type, planned_release_dt or created (default planned_release_dt) |
direction | string | No | asc or desc (default desc) |
page | integer | No | Page number, from 1 (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
get_releaseGet one release with its version, type, dates, owner, status, approval chain status, the statuses you can move it to next (shipping and rolling back appear only with those permissions), whether its item scope is frozen (scope_locked, from Ready onwards), item count and recent change history.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
create_releaseCreate a release under a version; it starts in Draft. release_number must be unique in the version (letters, digits, dot, dash, underscore, space; max 50). type is one of Major, Minor, Patch, Hotfix, Beta or Release Candidate.
| Name | Type | Required | Description |
|---|
version_id | integer | Yes | Version id the release belongs to |
release_number | string | Yes | Release number, e.g. 4.2.1 |
name | string | Yes | Release name |
type | string | Yes | Release type: Major, Minor, Patch, Hotfix, Beta or Release Candidate |
description | string | No | Description |
planned_release_dt | string | No | Planned release date, not in the past when creating (YYYY-MM-DD; empty string clears it) |
owner_id | string | No | Owner user id or uniq_id; must be an active member of the workspace; empty string clears it |
update_releaseUpdate a release's name, description, type, planned date or owner.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
name | string | No | Release name |
description | string | No | Description |
type | string | No | Release type: Major, Minor, Patch, Hotfix, Beta or Release Candidate |
planned_release_dt | string | No | Planned release date, not in the past when creating (YYYY-MM-DD; empty string clears it) |
owner_id | string | No | Owner user id or uniq_id; must be an active member of the workspace; empty string clears it |
transition_releaseMove a release to another status: Draft, Planned, Testing, Ready, Approved, Released, Rolled Back or Cancelled.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
status | string | Yes | Target status: Draft, Planned, Testing, Ready, Approved, Released, Rolled Back or Cancelled |
delete_releaseDelete a release (soft delete, as in the app).
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
list_release_itemsList the work items included in a release, newest first, with title, status and assignee.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
page | integer | No | Page number, from 1 (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
add_release_itemsInclude version items in a release, all or nothing (up to 100).
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
version_item_ids | array | Yes | Link ids from list_version_items |
remove_release_itemRemove one item from a release. item_id is the link id from list_release_items.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
item_id | integer | Yes | Link id from list_release_items |
get_release_readinessWhether a release is ready to move to Ready: percent of its items done (Resolved or Closed) against the threshold for its type (Major and Minor 100, others 90), open stories, tasks and defects, open critical or blocker defects (any one makes it not ready), items blocked by an unfinished predecessor, unresolved dependencies, and required checklist items still unchecked (blocking_required_items). ready is false when it has no items.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
list_my_pending_approvalsList release approval steps waiting for you, with the release, the level, and can_act (true when every lower level is already approved, and false on your own releases when the company enables separation of duties).
This tool takes no arguments.
get_release_approval_chainThe approval chain of a release: each level's approver, status, comment and time, the chain status (in_approval, approved, rejected, cancelled), and whether you can act now.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
approve_release_stepApprove a release approval step assigned to you.
| Name | Type | Required | Description |
|---|
step_id | integer | Yes | Approval step id from list_my_pending_approvals |
comment | string | Yes | Your comment (required; basic HTML allowed) |
reject_release_stepReject a release approval step assigned to you, with a required comment explaining why.
| Name | Type | Required | Description |
|---|
step_id | integer | Yes | Approval step id from list_my_pending_approvals |
comment | string | Yes | Your comment (required; basic HTML allowed) |
cancel_release_approval_chainCancel the whole approval chain of a release (every live step).
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
get_release_notesGet a release's notes (markdown), whether they were generated or written by hand (is_manual_override), and when.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
generate_release_notesGenerate a release's notes from its items: New Features (epics, features), Improvements (stories, tasks) and Fixed Issues (defects).
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
confirm | boolean | No | Replace hand-written notes (default false) |
update_release_notesReplace a release's notes with your own markdown.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
content | string | Yes | Release notes in markdown |
Versions and releases: Release dependencies3#
Dependencies between releases.
list_release_dependenciesWhat a release waits on (blocked_by) and what waits on it (blocks).
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
add_release_dependencyMake a release wait on an upstream release. hard (default) blocks moving the release to Released while the upstream is not shipped or cancelled; soft is informational.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | The release that waits (blocked release) |
upstream_release_id | integer | Yes | The release it waits on |
dependency_type | string | No | hard (default) or soft |
reason | string | No | Why it waits, shown with the dependency |
remove_release_dependencyDelete a dependency, addressed through either of its releases (the waiting one or the upstream).
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Either release of the dependency |
dependency_id | integer | Yes | Dependency id from list_release_dependencies |
Versions and releases: Go-live checklist4#
The checklist a release must clear before going live.
list_release_checklistA release's go-live checklist in order: each item's text, whether it is required, and whether, by whom and when it was checked.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
add_release_checklist_itemAppend an item to a release's go-live checklist.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
label | string | Yes | Item text, up to 500 characters |
is_required | boolean | No | Whether it blocks Ready until checked (default false) |
set_release_checklist_itemCheck or uncheck an item of a release's checklist.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
item_id | integer | Yes | Checklist item id from list_release_checklist |
checked | boolean | Yes | true to check, false to uncheck |
delete_release_checklist_itemDelete an item from a release's checklist.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
item_id | integer | Yes | Checklist item id from list_release_checklist |
Versions and releases: Blackout windows5#
Windows when releases may not go live, and overrides.
list_blackout_windowsList the company's release blackout windows (periods when releases should not ship, such as a code freeze), latest first: start and end, hard or soft enforcement, one-off or yearly recurrence, and the release types and project ids it applies to (empty means all).
| Name | Type | Required | Description |
|---|
include_inactive | boolean | No | Also list deactivated windows |
search | string | No | Matches the window name |
page | integer | No | Page number, from 1 (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
create_blackout_windowCreate a company-wide release blackout window. starts_at and ends_at take YYYY-MM-DD or YYYY-MM-DD HH:MM (end after start). enforcement is hard or soft; recurrence none (default) or annually, which repeats the same dates every year.
| Name | Type | Required | Description |
|---|
name | string | Yes | Window name, e.g. Year-end freeze |
starts_at | string | Yes | Start, YYYY-MM-DD or YYYY-MM-DD HH:MM |
ends_at | string | Yes | End, YYYY-MM-DD or YYYY-MM-DD HH:MM |
enforcement | string | Yes | hard or soft |
recurrence | string | No | none (default) or annually |
description | string | No | Optional description |
applies_to_release_types | array | No | Release types it applies to; empty for all |
applies_to_project_ids | array | No | Project numeric ids or uniq_ids it applies to; empty for all |
deactivate_blackout_windowDeactivate a blackout window so it no longer applies.
| Name | Type | Required | Description |
|---|
window_id | integer | Yes | Window id from list_blackout_windows |
check_release_blackoutCheck whether a release would ship inside an active blackout window: windows that apply to its project and type and cover the date, split into hard and soft, skipping windows already overridden for it.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
date | string | No | Date to check instead of the planned date, YYYY-MM-DD |
override_release_blackoutRecord an override that lets a release ship inside a blackout window, with the reason (requires the VRM administration permission).
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
window_id | integer | Yes | Window id from list_blackout_windows |
reason | string | Yes | Why the release may ship anyway |
Versions and releases: Customer impact6#
Customer segments and the impact a release has on them.
list_impact_segmentsList the company's customer impact segments (e.g. enterprise, smb) by label.
| Name | Type | Required | Description |
|---|
include_inactive | boolean | No | Also list deactivated segments |
search | string | No | Matches label or key |
page | integer | No | Page number, from 1 (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
create_impact_segmentCreate a customer impact segment. key is lower-cased and may hold only letters, digits and underscores (max 100), unique in the company even among deactivated segments; label is the display name.
| Name | Type | Required | Description |
|---|
key | string | Yes | Segment key, e.g. enterprise |
label | string | Yes | Display name, e.g. Enterprise |
description | string | No | Optional description |
deactivate_impact_segmentDeactivate a customer impact segment.
| Name | Type | Required | Description |
|---|
segment_id | integer | Yes | Segment id from list_impact_segments |
assign_impact_segmentsMark a version item as affecting customer segments.
| Name | Type | Required | Description |
|---|
version_item_id | integer | Yes | Link id from list_version_items |
segment_ids | array | Yes | Segment ids from list_impact_segments |
unassign_impact_segmentRemove one customer segment from a version item.
| Name | Type | Required | Description |
|---|
version_item_id | integer | Yes | Link id from list_version_items |
segment_id | integer | Yes | Segment id |
get_customer_impact_reportReleases shipped between from and to (YYYY-MM-DD, default the current year) that included version items assigned to a customer segment, latest first: release number, name, type, ship date, how many such items it shipped (segment_count) and its release notes.
| Name | Type | Required | Description |
|---|
segment_id | integer | Yes | Segment id from list_impact_segments |
from | string | No | Shipped on or after, YYYY-MM-DD |
to | string | No | Shipped on or before, YYYY-MM-DD |
page | integer | No | Page number, from 1 (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
Versions and releases: Release templates4#
Reusable release templates.
list_release_templatesList the company's release templates by name: release type, default release fields and go-live checklist.
| Name | Type | Required | Description |
|---|
search | string | No | Matches the template name |
page | integer | No | Page number, from 1 (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
get_release_templateOne release template with its type, default release fields (default_fields) and checklist items.
| Name | Type | Required | Description |
|---|
template_id | integer | Yes | Template id from list_release_templates |
create_release_templateCreate a release template: a unique name, an optional release type (Major, Minor, Patch, Hotfix, Beta, Release Candidate), default release fields (name, release_number, description, planned_release_dt, owner_id) and go-live checklist items in order, each required unless is_required is false.
| Name | Type | Required | Description |
|---|
name | string | Yes | Template name, unique in the company |
type | string | No | Release type releases from it get by default |
defaults | object | No | Default release fields: name, release_number, description, planned_release_dt, owner_id |
checklist_items | array | No | Checklist items in order |
create_release_from_templateCreate a Draft release under a version from a template.
| Name | Type | Required | Description |
|---|
template_id | integer | Yes | Template id from list_release_templates |
version_id | integer | Yes | Version to create the release under |
release_number | string | No | Release number, e.g. 4.2.1 |
name | string | No | Release name |
type | string | No | Major, Minor, Patch, Hotfix, Beta or Release Candidate |
description | string | No | Release description |
planned_release_dt | string | No | Planned date, YYYY-MM-DD, not in the past |
owner_id | string | No | Owner user numeric id or uniq_id |
Versions and releases: Analytics, calendar and dashboard7#
Release analytics, the calendar, roadmap, dashboard and activity.
get_release_analyticsRelease analytics over the projects you can access: approval cycle time (median and 90th percentile hours per approval level and approver), predictability (mean days late or early per release type and quarter), defect leakage (defects linked to each shipped release) and release velocity (releases shipped per quarter and type). release_type narrows cycle time and predictability; project_id narrows release velocity only, as in Orangescrum.
| Name | Type | Required | Description |
|---|
project_id | string | No | Project numeric id or uniq_id; omit for every project you can access |
release_type | string | No | Major, Minor, Patch, Hotfix, Beta or Release Candidate |
get_release_time_in_statusHow many hours a release spent in each status, from its status history in order; the last segment is its current status, counted until now.
| Name | Type | Required | Description |
|---|
release_id | integer | Yes | Release id (from list_releases) |
get_release_failure_trendPer month over a period (3m, 6m, 12m default, 24m): how many releases were rolled back, cancelled, or shipped later than planned (slipped), for one project or every project you can access.
| Name | Type | Required | Description |
|---|
project_id | string | No | Project numeric id or uniq_id; omit for every project you can access |
period | string | No | 3m, 6m, 12m (default) or 24m |
get_version_burndownA version's burndown over its planned start to end dates (ideal versus remaining items per day; empty with reason no_planned_window when the dates are not set) and its weekly velocity.
| Name | Type | Required | Description |
|---|
version_id | integer | Yes | Version id (from list_versions) |
get_release_calendarReleases planned or shipped between from and to (YYYY-MM-DD, default the current month), by planned date, at most 500, for one project or every project you can access, optionally one type or status.
| Name | Type | Required | Description |
|---|
from | string | No | Start date, YYYY-MM-DD |
to | string | No | End date, YYYY-MM-DD |
project_id | string | No | Project numeric id or uniq_id; omit for every project you can access |
type | string | No | Only this type |
status | string | No | Only this status |
get_release_dashboardThe release dashboard: up to 20 upcoming unshipped releases by planned date, each with its readiness (percent done, open items, critical defects, dependencies, ready flag), and up to 100 releases shipped in the last 90 days.
| Name | Type | Required | Description |
|---|
project_id | string | No | Project numeric id or uniq_id; omit for every project you can access |
type | string | No | Only this release type |
list_version_release_activityThe audit trail of a release or a version, newest first: each field change, status move, item link, approval, checklist or note event with old and new values, who did it and when. get_release and get_version show only the last 10; this pages through all of it.
| Name | Type | Required | Description |
|---|
entity_type | string | Yes | Release or Version |
entity_id | integer | Yes | Release or version id |
page | integer | No | Page number, from 1 (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
Versions and releases: Workflow rules and lookups2#
Version workflow rules and which versions a work item belongs to.
get_version_release_workflowThe status workflow in force for versions or releases, company-wide or for a project: every status, the moves allowed from each, which moves need the approval chain, the conditions attached to a move (e.g. readiness at least 90%), terminal statuses, and where the rules come from (project, company or built-in defaults).
| Name | Type | Required | Description |
|---|
entity_type | string | Yes | Version or Release |
project_id | string | No | Project numeric id or uniq_id, for its own rules; omit for the company rules |
get_work_item_versionsWhich versions a work item is linked to, among projects you can access, latest planned end first, with the link id (version_item_id) for remove_version_item or assign_impact_segments. entity_type is Epic, Feature, Story, Task or Defect; entity_id is the numeric task or defect id.
| Name | Type | Required | Description |
|---|
entity_type | string | Yes | Epic, Feature, Story, Task or Defect |
entity_id | integer | Yes | Task or defect numeric id |
Scaled Agile (SAFe): Agile Release Trains13#
Release trains with their teams, roles and projects.
list_artsList the workspace's Agile Release Trains (ARTs), newest first, with each train's cadence (PI and iteration length in weeks, whether it has an IP iteration), status, active team count and program increments.
| Name | Type | Required | Description |
|---|
status | string | No | active or archived |
page | integer | No | Page number (default 1) |
limit | integer | No | Items per page, 1 to 100 (default 25) |
get_artGet one Agile Release Train: its cadence and status, the teams on it (team_id and name), the teams that could still be attached (attachable_teams), the SAFe role holders (RTE, product manager, system architect, business owners, each with an assignment id), linked projects and its program increments.
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id (from list_arts) |
get_art_healthHealth of an Agile Release Train at a glance: its current program increment and how far through it is (the Executing PI, else the one whose dates include today, else the newest), PI counts by status, the current PI's objectives and business value delivered (actual over planned), open ROAM risks, completion of work items planned onto the ART, dependency count and the Release Train Engineer.
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id |
list_art_dependenciesList the backlog dependencies (blocks, related, duplicates, parent_of) that touch any work item planned onto an Agile Release Train, newest first — including dependencies on items in other trains, which is where cross-ART risk shows.
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id |
create_artCreate an Agile Release Train. code is upper-cased and must be unique in the workspace.
| Name | Type | Required | Description |
|---|
name | string | Yes | Train name, up to 120 characters |
code | string | Yes | Short unique code, up to 20 characters, e.g. PAY |
description | string | No | What the train delivers |
program_id | integer | No | Program (project with purpose program) to group it under |
pi_length_weeks | integer | No | PI length in weeks (default 10) |
iteration_length_weeks | integer | No | Iteration length in weeks (default 2) |
has_ip_iteration | boolean | No | Whether each PI ends with an IP iteration (default true) |
update_artUpdate an Agile Release Train's name, code, description, program or cadence.
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id |
name | string | No | New name |
code | string | No | New code |
description | string | No | New description |
program_id | integer | No | Program to group it under, 0 for none |
pi_length_weeks | integer | No | PI length in weeks |
iteration_length_weeks | integer | No | Iteration length in weeks |
has_ip_iteration | boolean | No | Whether PIs end with an IP iteration |
archive_artArchive an Agile Release Train (action archive) or bring an archived one back (action restore).
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id |
action | string | Yes | archive or restore |
attach_art_teamAttach a team to an Agile Release Train from today. get_art lists the teams that can be attached (attachable_teams).
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id |
team_id | integer | Yes | Team id (from get_art attachable_teams) |
detach_art_teamDetach a team from an Agile Release Train as of today.
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id |
team_id | integer | Yes | Team id |
attach_art_projectLink a project to an Agile Release Train, so its epics, features and stories appear in the train's backlog.
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id |
project_id | integer | Yes | Project id |
detach_art_projectUnlink a project from an Agile Release Train.
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id |
project_id | integer | Yes | Project id |
assign_art_roleGive a workspace member a SAFe role on an Agile Release Train: rte (Release Train Engineer), product_manager, system_architect or business_owner.
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id |
user_id | integer | Yes | Member's user id |
role | string | Yes | rte, product_manager, system_architect or business_owner |
revoke_art_roleRevoke a SAFe role assignment on an Agile Release Train as of today.
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id |
assignment_id | integer | Yes | Role assignment id (from get_art roles) |
Scaled Agile (SAFe): Program increments and the program board9#
Plan, lock and close program increments; iterations; the program board.
list_program_incrementsList program increments (PIs), latest start first, with their iterations.
| Name | Type | Required | Description |
|---|
art_id | integer | No | Only PIs of this ART |
status | string | No | planning, executing or closed |
page | integer | No | Page number (default 1) |
limit | integer | No | Items per page, 1 to 100 (default 25) |
get_program_incrementGet one program increment: its ART, theme, business context, dates, status (planning, executing, closed), iterations, PI objectives and ROAM risks.
| Name | Type | Required | Description |
|---|
pi_id | integer | Yes | Program increment id |
create_program_incrementCreate a program increment (PI) on an ART, in Planning.
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART the PI belongs to |
name | string | Yes | PI name, up to 80 characters, e.g. PI 26.4 |
start_date | string | Yes | First day, YYYY-MM-DD |
end_date | string | Yes | Last day, YYYY-MM-DD |
theme | string | No | Optional PI theme |
business_context | string | No | Optional business context |
update_program_incrementUpdate a program increment's name, theme, business context or dates.
| Name | Type | Required | Description |
|---|
pi_id | integer | Yes | Program increment id |
name | string | No | New name |
theme | string | No | New theme |
business_context | string | No | New business context |
start_date | string | No | New first day, YYYY-MM-DD |
end_date | string | No | New last day, YYYY-MM-DD |
transition_program_incrementMove a program increment along its lifecycle: lock (Planning to Executing, which freezes its plan) or close (Executing to Closed).
| Name | Type | Required | Description |
|---|
pi_id | integer | Yes | Program increment id |
action | string | Yes | lock or close |
get_iterationGet one iteration of a program increment: its dates, whether it is the IP iteration, the backlog items planned into it (planned_items) and the items placed in its program board cells (board_items).
| Name | Type | Required | Description |
|---|
iteration_id | integer | Yes | Iteration id (from get_program_increment) |
get_program_boardGet the program board of a program increment: its iterations (columns), the ART's teams (rows), the work items placed in each team-and-iteration cell with their committed load, and the dependencies touching those items, including ones reaching outside the PI.
| Name | Type | Required | Description |
|---|
pi_id | integer | Yes | Program increment id |
place_on_program_boardPlace a work item (usually a feature) in a team-and-iteration cell of a program increment's board, with how much of the team's capacity it commits (1 to 100 percent, default 100).
| Name | Type | Required | Description |
|---|
pi_id | integer | Yes | Program increment id |
item_id | integer | Yes | Work item id |
team_id | integer | Yes | Team id (from get_program_board teams) |
iteration_id | integer | Yes | Iteration id of this PI |
committed_load_pct | integer | No | Capacity committed, 1 to 100 (default 100) |
remove_from_program_boardRemove a placement from a program increment's board.
| Name | Type | Required | Description |
|---|
pi_id | integer | Yes | Program increment id |
entry_id | integer | Yes | Board entry id (from get_program_board) |
Scaled Agile (SAFe): PI objectives, risks and confidence votes8#
PI objectives, ROAM risks and confidence votes.
list_pi_objectivesList a program increment's team PI objectives, committed first, with planned business value (1 to 10) and, once recorded, actual business value.
| Name | Type | Required | Description |
|---|
pi_id | integer | Yes | Program increment id |
create_pi_objectiveAdd a PI objective: what a team (or the whole ART when team_id is omitted) intends to achieve, committed or as a stretch (uncommitted) objective, with planned business value 1 to 10 (default 5).
| Name | Type | Required | Description |
|---|
pi_id | integer | Yes | Program increment id |
description | string | Yes | The objective |
team_id | integer | No | Team the objective belongs to |
is_committed | boolean | No | Committed (true, default) or stretch (false) |
planned_business_value | integer | No | Planned business value 1 to 10 (default 5) |
update_pi_objectiveUpdate a PI objective's description, team, committed flag or planned business value, or record the actual business value delivered (0 to 10), which business owners score at the end of the PI and which drives PI predictability.
| Name | Type | Required | Description |
|---|
objective_id | integer | Yes | Objective id |
description | string | No | New description |
team_id | integer | No | Team, 0 for the whole ART |
is_committed | boolean | No | Committed or stretch |
planned_business_value | integer | No | Planned business value 1 to 10 |
actual_business_value | integer | No | Actual business value delivered 0 to 10 |
list_roam_risksList a program increment's ROAM risks, newest first, each Resolved, Owned, Accepted or Mitigated, with its owner.
| Name | Type | Required | Description |
|---|
pi_id | integer | Yes | Program increment id |
status | string | No | resolved, owned, accepted or mitigated |
create_roam_riskRaise a risk on a program increment and ROAM it: resolved, owned (default), accepted or mitigated, optionally with an owner.
| Name | Type | Required | Description |
|---|
pi_id | integer | Yes | Program increment id |
description | string | Yes | The risk |
status | string | No | resolved, owned (default), accepted or mitigated |
owner_id | integer | No | Member who owns the risk |
update_roam_riskUpdate a ROAM risk's description, owner or status (resolved, owned, accepted, mitigated).
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
description | string | No | New description |
status | string | No | resolved, owned, accepted or mitigated |
owner_id | integer | No | Owner, 0 for none |
cast_confidence_voteCast your fist-of-five confidence vote (1 to 5) on a program increment's plan, for a voting round (default 1).
| Name | Type | Required | Description |
|---|
pi_id | integer | Yes | Program increment id |
vote | integer | Yes | Confidence 1 (none) to 5 (high) |
round | integer | No | Voting round 1 to 10 (default 1) |
team_id | integer | No | Team you vote for |
get_confidence_vote_summaryConfidence vote results for a program increment, per round: number of votes and average overall and per team.
| Name | Type | Required | Description |
|---|
pi_id | integer | Yes | Program increment id |
Scaled Agile (SAFe): Backlog, dependencies and WSJF9#
Backlog planning, the portfolio kanban, dependencies and WSJF scoring.
list_safe_backlogList the SAFe backlog: epics, features and stories with their ART, PI, iteration, team, kanban state, rank and latest WSJF score.
| Name | Type | Required | Description |
|---|
art_id | integer | No | ART |
pi_id | integer | No | Program increment |
team_id | integer | No | Team |
level | string | No | epic, feature or story |
project_id | integer | No | Project |
program_id | integer | No | Program |
q | string | No | Search in titles |
page | integer | No | Page number (default 1) |
limit | integer | No | Items per page, 1 to 100 (default 25) |
get_safe_backlog_itemGet one epic, feature or story with its SAFe planning (ART, PI, iteration and team, with names), kanban state and the states it can move to next, rank, sizing, latest WSJF score and recent WSJF history, and its backlog dependencies.
| Name | Type | Required | Description |
|---|
item_id | integer | Yes | Work item id of an epic, feature or story |
update_safe_backlog_planningSet an epic, feature or story's SAFe planning: ART, program increment, iteration, team, rank, story subtype (user or enabler), enabler kind (architectural, infrastructure, exploration, compliance), feature estimate and epic size.
| Name | Type | Required | Description |
|---|
item_id | integer | Yes | Work item id |
art_id | integer | No | ART |
pi_id | integer | No | Program increment |
iteration_id | integer | No | Iteration |
team_id | integer | No | Team |
rank | integer | No | Backlog rank, lower first |
story_subtype | string | No | user or enabler |
enabler_kind | string | No | architectural, infrastructure, exploration or compliance |
feature_estimate | integer | No | Feature estimate, 0 or more |
epic_size | string | No | Epic size label, up to 10 characters |
transition_safe_backlog_itemMove an epic, feature or story to another kanban state of its level (see list_safe_kanban_states, or next_states on get_safe_backlog_item).
| Name | Type | Required | Description |
|---|
item_id | integer | Yes | Work item id |
state_id | integer | Yes | Target kanban state id |
comment | string | No | Why, up to 500 characters |
list_safe_kanban_statesList the portfolio kanban states for epics, features and stories (or one level): order, whether each is an initial or terminal state, WIP limit, and the states each one may move to next — each transition rule with the extra permission it demands, if any, and whether it is a global default.
| Name | Type | Required | Description |
|---|
level | string | No | epic, feature or story (default all three) |
add_backlog_dependencyRecord a dependency between two backlog items: the first blocks (default), is related to, duplicates or is the parent of the second.
| Name | Type | Required | Description |
|---|
from_item_id | integer | Yes | Item the dependency starts from |
to_item_id | integer | Yes | Item it points to |
dependency_type | string | No | blocks (default), related, duplicates or parent_of |
note | string | No | Optional note, up to 500 characters |
remove_backlog_dependencyRemove a backlog dependency by its id (from get_safe_backlog_item or list_art_dependencies).
| Name | Type | Required | Description |
|---|
dependency_id | integer | Yes | Dependency id |
record_wsjf_scoreScore an epic, feature or story for Weighted Shortest Job First.
| Name | Type | Required | Description |
|---|
item_id | integer | Yes | Work item id |
business_value | integer | Yes | User / business value |
time_criticality | integer | Yes | Time criticality |
risk_reduction | integer | Yes | Risk reduction / opportunity enablement |
job_size | integer | Yes | Job size |
get_wsjf_leaderboardRank an ART's epics, features or stories (default features) by their latest WSJF score, highest first, unscored last — the order to pull work in.
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id |
level | string | No | epic, feature (default) or story |
Scaled Agile (SAFe): Inspect & Adapt and flow metrics7#
Inspect & Adapt sessions, improvement items and flow metrics.
list_inspect_adapt_sessionsList Inspect & Adapt sessions, most recent first, with their PI, facilitator, improvement item count and the predictability the web app last cached.
| Name | Type | Required | Description |
|---|
pi_id | integer | No | Only the session of this PI |
page | integer | No | Page number (default 1) |
limit | integer | No | Items per page, 1 to 100 (default 25) |
get_inspect_adapt_sessionGet one Inspect & Adapt session: its PI, system demo notes, facilitator, improvement items from the problem-solving workshop, and PI predictability computed now — per team and for the ART, actual over planned business value of committed objectives.
| Name | Type | Required | Description |
|---|
session_id | integer | Yes | Session id |
create_inspect_adapt_sessionOpen the Inspect & Adapt session for a program increment, with the date it is held, optional system demo notes and a facilitator.
| Name | Type | Required | Description |
|---|
pi_id | integer | Yes | Program increment id |
held_on | string | Yes | Date held, YYYY-MM-DD |
system_demo_notes | string | No | Notes from the system demo |
facilitator_id | integer | No | Facilitating member |
add_improvement_itemAdd an improvement item from the problem-solving workshop to an Inspect & Adapt session: the problem, its root cause and countermeasure, an owner, and the PI the fix is targeted at.
| Name | Type | Required | Description |
|---|
session_id | integer | Yes | Session id |
problem_statement | string | Yes | The problem |
root_cause | string | No | Root cause |
countermeasure | string | No | Countermeasure |
owner_id | integer | No | Owning member |
target_pi_id | integer | No | PI the fix is targeted at |
update_improvement_itemUpdate an improvement item's problem, root cause, countermeasure, owner, target PI or status (open, in_progress, done, dropped).
| Name | Type | Required | Description |
|---|
session_id | integer | Yes | Session id |
improvement_id | integer | Yes | Improvement item id |
problem_statement | string | No | New problem statement |
root_cause | string | No | Root cause |
countermeasure | string | No | Countermeasure |
owner_id | integer | No | Owner, 0 for none |
target_pi_id | integer | No | Target PI, 0 for none |
status | string | No | open, in_progress, done or dropped |
get_flow_metricsGet an Agile Release Train's flow metrics: flow velocity, distribution, time, load and efficiency as stored period series, or one metric.
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id |
metric | string | No | flow_velocity, flow_distribution, flow_time, flow_load or flow_efficiency (default all) |
from | string | No | Earliest period start, YYYY-MM-DD |
to | string | No | Latest period end, YYYY-MM-DD |
pi_id | integer | No | Restrict distribution totals to this PI |
recompute_flow_velocityRecompute an Agile Release Train's weekly flow velocity: for each Monday-to-Sunday week, how many of its backlog items moved into a terminal kanban state.
| Name | Type | Required | Description |
|---|
art_id | integer | Yes | ART id |
Scaled Agile (SAFe): Dashboard, pickers and permissions4#
The SAFe dashboard, program and team pickers, and the caller's SAFe permissions.
get_safe_dashboardThe Scaled Agile portfolio at a glance, optionally for one ART or one Program: the current program increment (days left, features done, average confidence vote, ROAM counts), flow (items finished in 7 days, cycle time, WIP), items per kanban state per level, each active ART's Executing PI progress and blocking dependencies, objective status (achieved / on track / at risk / behind), dependencies by type, per-team progress with a 4-week throughput series, features by project and the top risks.
| Name | Type | Required | Description |
|---|
art_id | integer | No | Narrow the PI, flow, heatmap and dependency figures to this ART |
program_id | integer | No | Narrow work item figures to this Program's projects (see list_safe_programs) |
list_safe_programsList the workspace's active Programs — the portfolio grouping an Agile Release Train belongs to (projects whose purpose is "program") — with how many live projects each holds.
| Name | Type | Required | Description |
|---|
q | string | No | Search text matched against name or description |
limit | integer | No | Maximum rows (default 500, max 1000) |
list_safe_teamsList the workspace's active teams (status active and not past their end date) with member counts.
| Name | Type | Required | Description |
|---|
q | string | No | Search text matched against name or description |
limit | integer | No | Maximum rows (default 500, max 1000) |
get_safe_permissionsShow what you are allowed to do in Scaled Agile: every SAFe permission (e.g. pi_lock, objective_record_bv, backlog_transition) with whether your role passes it, grouped as the web app's permission matrix groups them.
This tool takes no arguments.
Resource management8#
Availability and capacity, utilization of logged time, the allocation report and skills.
get_resource_availabilityResource availability over a date range (the Resource Availability page): for each resource, capacity hours (the company's work hours on working days; weekends, company holidays, 2nd/4th Saturdays when enabled and the person's leave days have none), hours booked on tasks, overload hours, free hours, utilization %, the dates they are overloaded and on leave, their skills, and a status (available / busy / over_utilized).
| Name | Type | Required | Description |
|---|
start_date | string | No | First day, YYYY-MM-DD (default: first day of the current month) |
end_date | string | No | Last day, YYYY-MM-DD (default: end of start_date's month); at most 92 days after start_date |
project_id | integer | No | Only members of this project |
user_ids | array | No | Only these users (ids from list_users) |
skill_ids | array | No | Only people holding any of these skills (ids from list_resource_skills) |
role_id | integer | No | Only members with this company role |
business_unit_id | integer | No | Only members of this business unit |
experience | number | No | Only people with a skill at exactly this many years of experience |
include_daily | boolean | No | Add a per-day breakdown for each resource (default false) |
page | integer | No | Page of resources, default 1 |
limit | integer | No | Resources per page, 1-100 (default 10) |
get_resource_day_bookingsWhat one person is booked on for a single day (the cell popup of the Resource Availability page): each task with booked and overload hours, the day's work hours, hours logged, used hours (the larger of booked and logged), available hours, and whether the day is a weekend, holiday or a leave day (with the reason).
| Name | Type | Required | Description |
|---|
user_id | integer | Yes | Resource (user id) |
date | string | Yes | Day, YYYY-MM-DD |
get_resource_summarySummary of one person's availability over a date range (the resource summary popup of the Resource Availability page): total, working, weekend, holiday and leave days; capacity, booked, overload, used and remaining hours; utilization %; overloaded dates; the tasks they are booked on (most hours first); their leaves and the holidays in the range.
| Name | Type | Required | Description |
|---|
user_id | integer | Yes | Resource (user id) |
start_date | string | No | First day, YYYY-MM-DD (default: first day of the current month) |
end_date | string | No | Last day, YYYY-MM-DD (default: end of start_date's month); at most 92 days after start_date |
get_resource_utilizationResource utilization from logged time (the Utilization page's Log View): hours spent grouped by any of date, resource, project, task_title, task_group, task_type, label and is_billable (default: all but task_type), with totals over everything that matches (spent, billable, non-billable, estimate of the distinct tasks, resource and task counts).
| Name | Type | Required | Description |
|---|
start_date | string | No | First day, YYYY-MM-DD (default: first day of the current month) |
end_date | string | No | Last day, YYYY-MM-DD (default: end of start_date's month); at most 366 days after start_date |
group_by | array | No | Columns to group by |
project_ids | array | No | Only these projects |
user_ids | array | No | Only time logged by these users |
label_ids | array | No | Only tasks with any of these labels |
is_billable | boolean | No | Only billable (true) or non-billable (false) time |
statuses | array | No | Task status tokens: 1 New, 2 In Progress, 3 Closed, 5 Resolved, c<id> for a custom status |
search | string | No | Match resource name, log description, and project name / task title when those are grouped |
sort_by | string | No | hours, or a grouped column: resource, project, date, task_title |
sort_dir | string | No | asc or desc (default asc) |
page | integer | No | Page, default 1 |
limit | integer | No | Rows per page, 1-100 (default 50) |
get_team_utilizationTeam utilization (the Utilization page's Capacity View): for each resource, hours logged against capacity per ISO week of a month (period=month) or per month of a calendar quarter (period=quarter), with a utilization % and band per bucket (red up to 40% or exactly 80%, amber between 40% and 80%, green above 80%), plus per-bucket team totals.
| Name | Type | Required | Description |
|---|
period | string | No | month (weekly buckets, default) or quarter (monthly buckets) |
date | string | No | Any day in the month or quarter, YYYY-MM-DD (default today) |
basis | string | No | work_hours (default) or booked |
project_ids | array | No | Only time (and bookings) on these projects |
user_ids | array | No | Only these users |
role_ids | array | No | Only members holding these company roles |
get_allocation_reportThe Resource Allocation Report: per task, hours per day over a date range, with daily totals and the grand total. view=estimated (default) shows planned effort: the hours booked plus overloaded for each task per day when Resource Availability is on (mode bookings), otherwise each task's estimate spread evenly from its start to its due date (mode estimate_spread); it covers active tasks starting or due in the range. view=spent shows hours logged per task per day, split billable / non-billable.
| Name | Type | Required | Description |
|---|
view | string | No | estimated (default) or spent |
start_date | string | No | First day, YYYY-MM-DD (default: first day of the current month) |
end_date | string | No | Last day, YYYY-MM-DD (default: end of start_date's month); at most 92 days after start_date |
project_ids | array | No | Only these projects |
user_ids | array | No | Only tasks assigned to (estimated) or time logged by (spent) these users |
role_id | integer | No | Only people holding this company role |
limit | integer | No | Tasks to return, 1-200 (default 50) |
get_allocation_weekly_statusThe weekly status tab of the Resource Allocation Report: open tasks (new or in progress) created in the date range, bucketed by due date into overdue (due before now), current (due by the end of the range, or no due date) and future (due after the range), with counts and the number of projects involved.
| Name | Type | Required | Description |
|---|
start_date | string | No | First day, YYYY-MM-DD (default: first day of the current month) |
end_date | string | No | Last day, YYYY-MM-DD (default: end of start_date's month); at most 92 days after start_date |
project_ids | array | No | Only these projects |
user_ids | array | No | Only tasks assigned to these users |
role_id | integer | No | Only tasks assigned to people holding this company role |
list_resource_skillsList the workspace's skills, alphabetically, each with the people holding it and their years of experience.
| Name | Type | Required | Description |
|---|
search | string | No | Part of the skill name |
user_id | integer | No | Only skills this person holds |
project_id | integer | No | Only skills held by members of this project |
page | integer | No | Page, default 1 |
limit | integer | No | Skills per page, 1-100 (default 25) |
Attendance7#
Clock status, clock in and out, attendance records, who is in today, the dashboard and reports.
get_attendance_statusYour attendance right now: whether you are clocked in (and since when, where, on which project), today's clock sessions with total hours and the day status (Present / Present (Late)), the work locations clock_in accepts (work_location_id), and whether the company's clock restrictions (IP allowlist, geo-fence) allow clocking through MCP at all (clock_restrictions.can_clock_via_mcp, with the reason when not).
This tool takes no arguments.
clock_inClock yourself in now (your own attendance only).
| Name | Type | Required | Description |
|---|
work_location_id | integer | No | Work location id (from get_attendance_status) |
project_id | integer | No | Project to clock against; you must be a member |
notes | string | No | Optional note |
clock_outClock yourself out of your open session (even one started on an earlier day), with an optional note that replaces the session's note.
| Name | Type | Required | Description |
|---|
notes | string | No | Optional note |
list_attendance_recordsTimesheet of clock sessions for a period (default the last 30 days, at most 92 days): per-day totals with first clock-in, last clock-out and the day status (Present, Present (Half Day / Partial / Late / Overtime), credit), plus the individual sessions (paged, newest first).
| Name | Type | Required | Description |
|---|
user_id | integer | No | User id (default: you) |
start_date | string | No | YYYY-MM-DD (default 30 days ago) |
end_date | string | No | YYYY-MM-DD (default today) |
page | integer | No | Sessions page (default 1) |
per_page | integer | No | Sessions per page, max 100 (default 20) |
get_team_attendanceWho is in, out or on leave on a day (default today): for each employee you can see (your direct reports, or the whole company with view-all attendance access) their presence (clocked_in, clocked_out, not_clocked_in), first clock-in, last clock-out, hours, any approved leave covering the day, and the team grid's day status (Weekend, Holiday, Leave, Present..., Absent), with counts.
| Name | Type | Required | Description |
|---|
date | string | No | YYYY-MM-DD (default today) |
presence | string | No | clocked_in, clocked_out, not_clocked_in or on_leave |
search | string | No | Filter by employee name |
page | integer | No | Page (default 1) |
per_page | integer | No | Employees per page, max 100 (default 50) |
get_attendance_dashboardYour Attendance & Leave dashboard: today's clock summary, this year's leave request counts (pending, approved, rejected), the next five holidays, and for managers and admins who is on leave today with present / on leave / absent counts over their team or company, plus the number of active users.
This tool takes no arguments.
get_attendance_reportAn attendance report for a period (default this month to date): attendance_summary (days present, total and average hours per person) or late_arrivals (each late clock-in).
| Name | Type | Required | Description |
|---|
report_type | string | Yes | attendance_summary or late_arrivals |
start_date | string | No | YYYY-MM-DD (default first of this month) |
end_date | string | No | YYYY-MM-DD (default today) |
user_id | integer | No | Narrow to one user in your scope |
page | integer | No | late_arrivals page (default 1) |
per_page | integer | No | late_arrivals page size (default 20, max 100) |
Leave12#
Leave types, balances, holidays, requests, approvals and reports.
list_leave_typesThe active leave types you can apply for (id, name, code, paid, whether half days are allowed).
This tool takes no arguments.
get_leave_balancesLeave balances per leave type for a year (default this year): annual quota, carried forward, accrued, used, pending and available days.
| Name | Type | Required | Description |
|---|
user_id | integer | No | User id (default: you) |
year | integer | No | Year (default this year) |
list_holidaysThe company's holiday calendar for a year (default this year): company and global holidays with date, weekday, type and whether it is a half day.
| Name | Type | Required | Description |
|---|
year | integer | No | Year (default this year) |
list_leave_requestsLeave requests, newest first. scope: my (your own), team (your direct reports; everyone with view-all leave access) or all (the whole company with view-all leave access, otherwise your own).
| Name | Type | Required | Description |
|---|
scope | string | No | my, team or all |
status | string | No | pending, in_approval, approved, rejected or cancelled |
leave_type_id | integer | No | Leave type id |
user_id | integer | No | Narrow to one user within the scope |
start_date | string | No | Requests starting on or after YYYY-MM-DD |
end_date | string | No | Requests ending on or before YYYY-MM-DD |
page | integer | No | Page (default 1) |
per_page | integer | No | Per page, max 100 (default 20) |
get_leave_requestOne leave request with its approval chain: each level's approver (or role), status, comment and when they acted, and whether it is waiting on you (can_act).
| Name | Type | Required | Description |
|---|
leave_request_id | integer | Yes | Leave request id |
preview_leave_daysHow many leave days a request over the dates would count, exactly as apply_leave will: weekends, holidays and (where observed) 2nd/4th Saturdays are excluded; a half day counts 0.5.
| Name | Type | Required | Description |
|---|
start_date | string | Yes | YYYY-MM-DD |
end_date | string | Yes | YYYY-MM-DD |
is_half_day | boolean | No | Half-day request (single date) |
apply_leaveApply for leave for yourself: leave_type_id (from list_leave_types), start_date, end_date and a reason; for a half day set is_half_day with the same start and end date and optionally half_day_period (first_half or second_half).
| Name | Type | Required | Description |
|---|
leave_type_id | integer | Yes | Leave type id |
start_date | string | Yes | YYYY-MM-DD |
end_date | string | Yes | YYYY-MM-DD |
reason | string | Yes | Reason for the leave |
is_half_day | boolean | No | Half day (start and end must match) |
half_day_period | string | No | first_half or second_half |
cancel_leave_requestCancel a leave request that is still pending or in approval; its days return to the available balance and its pending approvals are withdrawn.
| Name | Type | Required | Description |
|---|
leave_request_id | integer | Yes | Leave request id |
get_leave_reportA leave report: leave_summary (requests and days per person by status and leave type, for requests inside the period, default this month to date) or leave_balance (this year's balances per person and type).
| Name | Type | Required | Description |
|---|
report_type | string | Yes | leave_summary or leave_balance |
start_date | string | No | YYYY-MM-DD (default first of this month) |
end_date | string | No | YYYY-MM-DD (default today) |
user_id | integer | No | Narrow to one user in your scope |
list_leave_approvalsLeave requests waiting on your approval, one row per approval step assigned to you, with the request, the full approval chain and can_act (true once every lower level has approved).
This tool takes no arguments.
approve_leave_requestApprove a leave request at your level of its approval chain, with a required comment.
| Name | Type | Required | Description |
|---|
leave_request_id | integer | Yes | Leave request id |
comment | string | Yes | Approval comment (required) |
reject_leave_requestReject a leave request at your level of its approval chain, with a required comment.
| Name | Type | Required | Description |
|---|
leave_request_id | integer | Yes | Leave request id |
comment | string | Yes | Rejection reason (required) |
Risk management: Register7#
Create, read, update, move through the workflow and delete risks.
list_risksList and search the Risk Management register (not SAFe ROAM risks): each risk's display id (RISK-0042), title, score and rating, status, owner and project.
| Name | Type | Required | Description |
|---|
project_id | integer | No | Only risks of this project |
status | string | No | Workflow state key, e.g. identified, mitigation_in_progress, closed_resolved |
rating | string | No | Rating level: low, medium, high or critical |
category | string | No | Category, e.g. technical |
risk_type | string | No | Threat or Opportunity |
owner_id | integer | No | Only risks owned by this member |
min_score | integer | No | Only risks scoring at least this |
open_only | boolean | No | Leave out closed risks |
search | string | No | Text to find in display id, title, description or tags |
sort | string | No | created (default), modified, display_id, title, score, residual_score, rating, status, category, review_date, probability or impact |
direction | string | No | asc or desc (default) |
page | integer | No | Page number (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
get_riskRead one risk in full: assessment (inherent and residual score and rating), mitigation, dates, ISMS fields, and where it stands in its workflow — every status it can move to next, whether you may take that step, whether it needs a comment and which required fields are still empty.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id (the number in risk_id, not the RISK-0042 display id) |
get_risk_settingsEverything needed to fill a risk in correctly.
This tool takes no arguments.
create_riskCreate a Risk Management risk (for SAFe program risks use create_roam_risk).
| Name | Type | Required | Description |
|---|
title | string | Yes | Short name of the risk (max 255 characters) |
description | string | No | What could happen and why |
impact_description | string | No | What happens if the risk materialises |
project_id | integer | No | Project the risk belongs to (on create defaults to the first project) |
category | string | No | Category from get_risk_settings (e.g. technical, financial) |
risk_type | string | No | Threat or Opportunity |
risk_source | string | No | Stakeholder, Team, Process, External, Audit or Other |
owner_id | integer | No | Risk owner, an active member (on create defaults to you) |
secondary_owner_id | integer | No | Co-owner, different from the owner; 0 clears |
mitigation_owner_id | integer | No | Member accountable for the mitigation; 0 clears |
probability | integer | No | Likelihood rating, 1 to the methodology scale (usually 5) |
impact | integer | No | Impact rating, 1 to the methodology scale |
residual_probability | integer | No | Likelihood after treatment |
residual_impact | integer | No | Impact after treatment |
vulnerability_rating | integer | No | Vulnerability rating (ISMS methodologies) |
confidentiality_rating | integer | No | Confidentiality rating (asset-based methodologies) |
integrity_rating | integer | No | Integrity rating (asset-based methodologies) |
availability_rating | integer | No | Availability rating (asset-based methodologies) |
residual_vulnerability_rating | integer | No | Vulnerability rating after treatment |
threat_id | integer | No | Threat catalogue item (list_risk_catalogue type=threats); seeds probability when unset; 0 clears |
vulnerability_id | integer | No | Vulnerability catalogue item; seeds vulnerability_rating when unset; 0 clears |
soa_controls | string | No | ISO/IEC 27001 Annex A controls, comma-separated (e.g. 5.15, 8.7) |
existing_controls | string | No | Controls already in place |
residual_details | string | No | Residual risk description (on create defaults to the title) |
remarks | string | No | Free-form remarks |
response_strategy | string | No | avoid, mitigate, transfer, accept, exploit, share or enhance |
mitigation_plan | string | No | Planned mitigation actions |
contingency_plan | string | No | Fallback if the mitigation fails |
mitigation_status | string | No | Not Started, In Progress, Completed or On Hold |
mitigation_due_date | string | No | Mitigation due date, YYYY-MM-DD |
budget_impact | number | No | Financial impact in company currency (needs the View Financial Impact permission) |
schedule_impact | integer | No | Schedule delay in days |
review_date | string | No | Next review date, YYYY-MM-DD |
target_resolution_date | string | No | Target resolution date, YYYY-MM-DD |
date_identified | string | No | Date identified, YYYY-MM-DD (defaults to today) |
risk_proximity | string | No | Imminent, Near-term, Medium-term or Long-term |
escalation_level | string | No | Free text, e.g. Team, Management, Executive (max 30) |
tags | string | No | Comma-separated tags |
workflow_id | integer | No | Workflow from get_risk_settings; omit for the company default |
update_riskUpdate a risk's fields; only the fields you pass change, and the score and rating are recomputed.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
title | string | No | Short name of the risk (max 255 characters) |
description | string | No | What could happen and why |
impact_description | string | No | What happens if the risk materialises |
project_id | integer | No | Project the risk belongs to (on create defaults to the first project) |
category | string | No | Category from get_risk_settings (e.g. technical, financial) |
risk_type | string | No | Threat or Opportunity |
risk_source | string | No | Stakeholder, Team, Process, External, Audit or Other |
owner_id | integer | No | Risk owner, an active member (on create defaults to you) |
secondary_owner_id | integer | No | Co-owner, different from the owner; 0 clears |
mitigation_owner_id | integer | No | Member accountable for the mitigation; 0 clears |
probability | integer | No | Likelihood rating, 1 to the methodology scale (usually 5) |
impact | integer | No | Impact rating, 1 to the methodology scale |
residual_probability | integer | No | Likelihood after treatment |
residual_impact | integer | No | Impact after treatment |
vulnerability_rating | integer | No | Vulnerability rating (ISMS methodologies) |
confidentiality_rating | integer | No | Confidentiality rating (asset-based methodologies) |
integrity_rating | integer | No | Integrity rating (asset-based methodologies) |
availability_rating | integer | No | Availability rating (asset-based methodologies) |
residual_vulnerability_rating | integer | No | Vulnerability rating after treatment |
threat_id | integer | No | Threat catalogue item (list_risk_catalogue type=threats); seeds probability when unset; 0 clears |
vulnerability_id | integer | No | Vulnerability catalogue item; seeds vulnerability_rating when unset; 0 clears |
soa_controls | string | No | ISO/IEC 27001 Annex A controls, comma-separated (e.g. 5.15, 8.7) |
existing_controls | string | No | Controls already in place |
residual_details | string | No | Residual risk description (on create defaults to the title) |
remarks | string | No | Free-form remarks |
response_strategy | string | No | avoid, mitigate, transfer, accept, exploit, share or enhance |
mitigation_plan | string | No | Planned mitigation actions |
contingency_plan | string | No | Fallback if the mitigation fails |
mitigation_status | string | No | Not Started, In Progress, Completed or On Hold |
mitigation_due_date | string | No | Mitigation due date, YYYY-MM-DD |
budget_impact | number | No | Financial impact in company currency (needs the View Financial Impact permission) |
schedule_impact | integer | No | Schedule delay in days |
review_date | string | No | Next review date, YYYY-MM-DD |
target_resolution_date | string | No | Target resolution date, YYYY-MM-DD |
date_identified | string | No | Date identified, YYYY-MM-DD (defaults to today) |
risk_proximity | string | No | Imminent, Near-term, Medium-term or Long-term |
escalation_level | string | No | Free text, e.g. Team, Management, Executive (max 30) |
tags | string | No | Comma-separated tags |
workflow_id | integer | No | Workflow from get_risk_settings; omit for the company default |
transition_riskMove a risk to another status of its workflow (get_risk lists the allowed next statuses).
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
status | string | Yes | Target state key, e.g. identified, under_assessment, mitigation_in_progress, escalated, monitoring, closed_resolved |
comment | string | No | Why; required for some steps |
delete_riskDelete a risk from the register.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
Comments on a risk.
list_risk_commentsList the comments on a risk, oldest first, with author and time.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
page | integer | No | Page number (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
add_risk_commentPost a comment on a risk.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
comment | string | Yes | Comment text |
mention_user_ids | array | No | Members to mention |
update_risk_commentEdit a comment on a risk.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
comment_id | integer | Yes | Comment id |
comment | string | Yes | New text |
delete_risk_commentDelete a comment on a risk.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
comment_id | integer | Yes | Comment id |
Risk management: Links6#
Links to work items and to other risks.
list_risk_linksList the work items (tasks) linked to a risk with their link type, and the related risks with their relationship (parent, dependent, duplicate, derived).
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
list_task_risksList the Risk Management risks linked to a work item (task), with the link type, score, rating and status — the task risk panel of the web app.
| Name | Type | Required | Description |
|---|
task_id | integer | Yes | Work item (task) id |
link_risk_taskLink a work item (task) to a risk, e.g. a task the risk blocks or that mitigates it.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
task_id | integer | Yes | Work item (task) id |
link_type | string | No | How they relate, e.g. blocks (default), mitigates, relates_to |
unlink_risk_taskRemove the link between a work item (task) and a risk; list_risk_links shows the current links.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
task_id | integer | Yes | Work item (task) id |
link_risksRelate a risk to another risk of the workspace: parent, dependent (default), duplicate or derived.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
related_risk_id | integer | Yes | The other risk |
relationship_type | string | No | parent, dependent (default), duplicate or derived |
unlink_risksRemove the relationship (parent, dependent, duplicate or derived) from a risk to another risk; both risks stay as they are.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
related_risk_id | integer | Yes | The other risk |
Risk management: Watchers and approvals5#
Watchers and the approval steps of a risk.
add_risk_watcherAdd a member as a watcher of a risk; they are notified of status changes and comments.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
user_id | integer | Yes | Member to add |
remove_risk_watcherStop a member watching a risk, so they no longer get its status-change and comment notifications.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
user_id | integer | Yes | Watcher to remove |
list_risk_approvalsList risk approval steps.
| Name | Type | Required | Description |
|---|
risk_id | integer | No | Only this risk |
status | string | No | pending (default without risk_id), approved or rejected |
approve_risk_stepApprove one approval step of a risk, addressed by its step_index from list_risk_approvals.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
step_index | integer | No | 0-based position of the step (default 0) |
reject_risk_stepReject one approval step of a risk, addressed by its step_index from list_risk_approvals, with the reason.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
step_index | integer | No | 0-based position of the step (default 0) |
comment | string | Yes | Reason for rejecting |
Risk management: Dashboard, heat map and reports5#
The risk dashboard, heat map, reports, ISMS catalogues, settings and audit trail.
get_risk_dashboardThe Risk Management dashboard: total and open risks, closure rate, escalated share and average resolution time; counts by rating, status and category; mitigation progress; overdue reviews; recently added risks; and open risks blocking work items.
This tool takes no arguments.
get_risk_heatmapThe probability × impact heat map (risk matrix) of open risks: one cell per rating pair on the methodology scale, with its risks and the rating band the cell falls in.
| Name | Type | Required | Description |
|---|
project_id | integer | No | Only risks of this project |
category | string | No | Only this category |
get_risk_reportRun a Risk Management report: register (every risk with score, rating, owner, status), summary (counts and shares by rating, category, status), overdue (past review date), trend (opened and closed per month, last six months), escalated, dependencies (risks with links), treatment (treatment plan, planned vs actual closure, lateness), residual (inherent vs residual score, reduction, within acceptance) or soa_coverage (risks per ISO 27001 Annex A control).
| Name | Type | Required | Description |
|---|
type | string | Yes | register, summary, overdue, trend, escalated, dependencies, treatment, residual or soa_coverage |
list_risk_catalogueList an ISMS catalogue: threats or vulnerabilities (with their default rating and how many risks use them — pass the id as threat_id / vulnerability_id), or the ISO/IEC 27001:2022 Annex A controls (for soa_controls), with how many risks map to each.
| Name | Type | Required | Description |
|---|
type | string | Yes | threats, vulnerabilities or controls |
include_inactive | boolean | No | Also list inactive catalogue items |
list_risk_activityA risk's audit trail, newest first: creation, every field change with old and new value, status moves, comments, links, watchers and approvals, with who and when.
| Name | Type | Required | Description |
|---|
risk_id | integer | Yes | Risk id |
page | integer | No | Page number (default 1) |
limit | integer | No | Results per page (default 25, max 100) |
Checklists: Config and catalog reads4#
Checklists - config and catalog reads.
get_checklist_configRead the company checklist framework configuration: whether it is enabled, the bypass and custom-group policy flags, and the required-groups matrix per work-item type.
| Name | Type | Required | Description |
|---|
work_item_type | string | No | Optional filter for the required-groups matrix. One of: |
list_checklist_groupsList the company catalogue checklist groups (system and custom).
| Name | Type | Required | Description |
|---|
active_only | boolean | No | When true, only active groups are returned |
list_checklist_templatesList the company checklist templates with their items.
This tool takes no arguments.
get_work_item_checklistRead a work item's checklist: its groups with nested items and the overall/per-group completion status.
| Name | Type | Required | Description |
|---|
work_item_type | string | Yes | One of: |
work_item_id | integer | Yes | Numeric id of the work item |
Checklists: Catalog management6#
Checklists - catalog management.
create_checklist_groupCreate a custom company-catalogue checklist group.
| Name | Type | Required | Description |
|---|
name | string | Yes | The group name (unique per company) |
color | string | No | Optional hex colour, e.g. #3366ff |
is_active | boolean | No | Whether the group is active (default true) |
update_checklist_groupUpdate a catalogue checklist group.
| Name | Type | Required | Description |
|---|
group_id | integer | Yes | The catalogue group id |
name | string | No | New name (custom groups only) |
color | string | No | New hex colour, e.g. #3366ff |
is_active | boolean | No | Whether the group is active |
delete_checklist_groupDelete a custom catalogue checklist group (and its templates).
| Name | Type | Required | Description |
|---|
group_id | integer | Yes | The catalogue group id |
create_checklist_templateCreate a checklist template that owns one catalogue group and a list of item labels.
| Name | Type | Required | Description |
|---|
checklist_group_id | integer | Yes | The catalogue group this template owns |
name | string | Yes | The template name |
auto_attach | boolean | No | Auto-apply to new work items of the enabled types (default false) |
is_active | boolean | No | Whether the template is active (default true) |
items | array | No | Ordered checklist item labels |
update_checklist_templateUpdate a checklist template.
| Name | Type | Required | Description |
|---|
template_id | integer | Yes | The template id |
name | string | No | New template name |
checklist_group_id | integer | No | Move the template to a different catalogue group |
auto_attach | boolean | No | Whether to auto-apply on create |
is_active | boolean | No | Whether the template is active |
items | array | No | Replacement ordered item labels (omit to leave items unchanged) |
delete_checklist_templateDelete a checklist template and its items.
| Name | Type | Required | Description |
|---|
template_id | integer | Yes | The template id |
Checklists: Per work item10#
Checklists - per work item.
add_checklist_itemAdd a checklist item to a group on a work item.
| Name | Type | Required | Description |
|---|
work_item_type | string | Yes | One of: |
work_item_id | integer | Yes | Numeric id of the work item |
work_item_group_id | integer | Yes | The work-item group instance to add the item to |
label | string | Yes | The checklist item text |
update_checklist_itemUpdate a checklist item's label (text only).
| Name | Type | Required | Description |
|---|
item_id | integer | Yes | The checklist item id |
label | string | Yes | The new item text |
delete_checklist_itemDelete a checklist item from a work item.
| Name | Type | Required | Description |
|---|
item_id | integer | Yes | The checklist item id |
complete_checklist_itemMark a checklist item complete or incomplete.
| Name | Type | Required | Description |
|---|
item_id | integer | Yes | The checklist item id |
is_completed | boolean | No | Set true to complete, false to uncomplete; omit to toggle |
add_checklist_groupAttach an existing catalogue checklist group (by its catalogue group id) to a work item.
| Name | Type | Required | Description |
|---|
work_item_type | string | Yes | One of: |
work_item_id | integer | Yes | Numeric id of the work item |
source_group_id | integer | Yes | The catalogue group id to attach |
create_custom_checklist_groupCreate a one-off custom checklist group directly on a work item (not from the catalogue).
| Name | Type | Required | Description |
|---|
work_item_type | string | Yes | One of: |
work_item_id | integer | Yes | Numeric id of the work item |
name | string | Yes | The custom group name |
rename_checklist_groupRename a checklist group on a work item (this work item only — never the shared catalogue).
| Name | Type | Required | Description |
|---|
work_item_group_id | integer | Yes | The work-item group instance id |
name | string | Yes | The new group name |
delete_work_item_checklist_groupRemove a checklist group (and its items) from a work item.
| Name | Type | Required | Description |
|---|
work_item_group_id | integer | Yes | The work-item group instance id |
reorder_checklist_groupsSet the display order of a work item's checklist groups.
| Name | Type | Required | Description |
|---|
work_item_type | string | Yes | One of: |
work_item_id | integer | Yes | Numeric id of the work item |
group_ids | array | Yes | Work-item group instance ids in the desired order |
add_checklist_group_from_templateCopy a checklist template (its group and all items) onto a work item as an independent group.
| Name | Type | Required | Description |
|---|
work_item_type | string | Yes | One of: |
work_item_id | integer | Yes | Numeric id of the work item |
template_id | integer | Yes | The checklist template id to copy |