Skip to main content
Items carry a dynamic set of fields controlled by their process and container permissions. To understand the field model, available field types, and how to discover which fields you can set, see Items and fields.

​
get_item

Get a single work item by ID or key (e.g. GEM-123). Returns item details including status, priority, assignment, and time logged.
Property
Read-onlyYes

​
Parameters

ParameterTypeRequiredDescription
itemIdstringYesItem ID or key (e.g. GEM-123).

​
Returns

A CycleItemDto with the item’s key, name, status, container, board, cycle, work estimate, time logged, and resource assignment. Returns an empty object if the item is not found or the user lacks permission.

​
get_items

List work items in a container, filtered by the current user’s permissions.
Property
Read-onlyYes

​
Parameters

ParameterTypeRequiredDefaultDescription
containerIdstringYes—Container ID. Use get_containers.
includeClosedboolNofalseWhen true, includes closed items.

​
Returns

A list of CycleItemDto objects for items the current user can see.

​
search_items

Search for work items by keyword across containers. Matches on item name or sequence number.
Property
Read-onlyYes

​
Parameters

ParameterTypeRequiredDescription
keywordstringYesSearch term to match against item names and sequence numbers.
containerIdsstringNoComma-separated container IDs to limit scope. Searches all containers if omitted. Use get_containers.

​
Returns

A list of ItemMatch objects, each containing:
  • itemId, itemName, itemSequence — item identity
  • containerId, containerName, containerCode — container context

​
create_item

Create a new work item in the specified container with a given process type.
Property
Read-onlyNo

​
Parameters

ParameterTypeRequiredDescription
containerIdstringYesContainer to create the item in. Use get_containers to find IDs.
processIdstringYesProcess type for the item. Use get_container_process_list to find IDs.
namestringYesItem name/title.
descriptionstringNoItem description.
priorityIdstringNoPriority value ID. Use get_priority_list for valid values.
severityIdstringNoSeverity value ID. Use get_severity_list for valid values.
fieldsJsonstringNoAdditional fields as JSON: [{"fieldId":"<id>","value":"<value>"}]

​
Returns

A CycleItemDto with the created item’s key, name, status, container, and planning details.

​
update_item

Update an existing work item. Supports item ID or key format (e.g. GEM-123). Only provided fields are updated.
Property
Read-onlyNo

​
Parameters

ParameterTypeRequiredDescription
itemIdstringYesItem ID or key (e.g. GEM-123).
namestringNoNew item name.
statusIdstringNoStatus value ID. Use get_status_list.
priorityIdstringNoPriority value ID. Use get_priority_list.
severityIdstringNoSeverity value ID. Use get_severity_list.
resolutionIdstringNoResolution value ID. Use get_resolution_list.
fieldsJsonstringNoAdditional fields as JSON: [{"fieldId":"<id>","value":"<value>"}]

​
Returns

A CycleItemDto with the updated item details.

​
delete_item

Delete a work item by ID or key (e.g. GEM-123).
Property
Read-onlyNo

​
Parameters

ParameterTypeRequiredDescription
itemIdstringYesItem ID or key.

​
Returns

A confirmation message with the deleted item’s key.

​
copy_item

Duplicate a work item within the same container. Requires Add permission on the item’s container.
Property
Read-onlyNo

​
Parameters

ParameterTypeRequiredDescription
itemIdstringYesItem ID or key (e.g. GEM-123).

​
Returns

A CycleItemDto with the newly created copy’s details.

​
plan_item

Assign a work item to a board and cycle, optionally assigning a resource.
Property
Read-onlyNo

​
Parameters

ParameterTypeRequiredDescription
itemIdstringYesItem ID or key.
boardIdstringYesTarget board ID. Use get_board_cycle.
cycleIdstringYesTarget cycle ID. Use get_board_cycle.
resourceIdstringNoUser or job role ID to assign.
resourceTypestringNoUser or JobRole. Required when resourceId is provided.

​
Returns

A CycleItemDto with the updated planning details.

​
unplan_item

Remove an item from its board and cycle, clearing all planning fields (board, cycle, resource).
Property
Read-onlyNo

​
Parameters

ParameterTypeRequiredDescription
itemIdstringYesItem ID or key.

​
Returns

A CycleItemDto with the cleared planning fields.

​
get_items_by_resource

Get work items assigned to a specific user, filtered by the current user’s visibility permissions.
Property
Read-onlyYes

​
Parameters

ParameterTypeRequiredDefaultDescription
userIdstringYes—User ID to query items for. Use get_user_list.
includeClosedboolNofalseWhen true, includes closed items.

​
Returns

A list of CycleItemDto objects for items assigned to the specified user.

​
get_item_dependencies

Get the full dependency tree for a work item. Requires View permission on the container and FieldView permission on the dependency field.
Property
Read-onlyYes

​
Parameters

ParameterTypeRequiredDescription
itemIdstringYesItem ID or key (e.g. GEM-123).

​
Returns

A list of CycleItemDto objects representing the dependency tree, filtered to items the current user can see.

​
add_item_dependency

Add a parent-child dependency between two work items. Both IDs support key format (e.g. GEM-123). Requires View permission on both items.
Property
Read-onlyNo

​
Parameters

ParameterTypeRequiredDescription
parentIdstringYesParent item ID or key.
childIdstringYesChild item ID or key.

​
Returns

A confirmation message showing the created dependency link.

​
remove_item_dependency

Remove a work item from its dependency tree. The item becomes standalone but retains its children. Requires View permission on the item.
Property
Read-onlyNo

​
Parameters

ParameterTypeRequiredDescription
itemIdstringYesItem ID or key (e.g. GEM-123).

​
Returns

A confirmation message with the detached item’s key.