search_workitems
Find work items by filtering on type, status, assignee, creation/update dates, and more to retrieve matching tasks, requirements, or bugs.
Instructions
[Project Management] Search work items with various filter conditions. Paging is capped: page * perPage must not exceed 10000, otherwise the API returns 400 — narrow the filters to reach more results
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Tag ID, multiple values separated by commas | |
| page | No | Page number, starting from 1. Default is 1. Due to the search engine's deep-paging limit, page * perPage must not exceed 10000, otherwise the API returns 400; narrow the query with filters to reach more results | |
| sort | No | Sort order, default is desc. Possible values: desc (descending), asc (ascending) | desc |
| sprint | No | Sprint ID, multiple values separated by commas | |
| status | No | Status ID, multiple separated by commas. Status names and their IDs: Pending Confirmation (28), Pending Processing (100005), Reopened (30), Deferred Fix (34), Confirmed (32), Selected (625489), In Analysis (154395), Analysis Complete (165115), In Progress (100010), In Design (156603), Design Complete (307012), In Development (142838), Development Complete (100011), In Testing (100012) | |
| creator | No | Creator user ID, multiple values separated by commas. Special value 'self' can be used to represent the current user | |
| orderBy | No | Sort field, default is gmtCreate. Possible values: gmtCreate, subject, status, priority, assignedTo | gmtCreate |
| perPage | No | Number of items per page, range 0-200. Default is 20. page * perPage must not exceed 10000; use 200 to reduce the number of pages when iterating large result sets | |
| spaceId | Yes | Project ID or Program ID. Use with spaceType to specify the space type | |
| subject | No | Text contained in the title | |
| category | Yes | Search for work item types, such as Req (requirement), Task (task), Bug (defect), etc., multiple values separated by commas | |
| priority | No | Priority ID, multiple values separated by commas | |
| spaceType | No | Space type: Project (project) or Program (project set). Default is Project. Use 'Program' when spaceId refers to a program (project set) ID | Project |
| assignedTo | No | Assignee user ID, multiple values separated by commas. Special value 'self' can be used to represent the current user | |
| statusStage | No | Status stage ID, multiple values separated by commas | |
| createdAfter | No | Created not earlier than, format: YYYY-MM-DD | |
| updatedAfter | No | Updated not earlier than, format: YYYY-MM-DD | |
| workitemType | No | Work item type ID, multiple values separated by commas | |
| createdBefore | No | Created not later than, format: YYYY-MM-DD | |
| updatedBefore | No | Updated not later than, format: YYYY-MM-DD | |
| includeDetails | No | Set to true when you need work item descriptions/detailed content. This automatically fetches missing descriptions instead of requiring separate get_work_item calls. RECOMMENDED: Use includeDetails=true when user asks for 'detailed content', 'descriptions', or 'full information' of work items. This is more efficient than calling get_work_item multiple times. Default is false | |
| organizationId | Yes | Organization ID | |
| finishTimeAfter | No | Finish time not earlier than, format: YYYY-MM-DD | |
| finishTimeBefore | No | Finish time not later than, format: YYYY-MM-DD | |
| advancedConditions | No | Advanced filter conditions, JSON format | |
| subjectDescription | No | Text contained in title or description | |
| updateStatusAtAfter | No | Status update time not earlier than, format: YYYY-MM-DD | |
| updateStatusAtBefore | No | Status update time not later than, format: YYYY-MM-DD |