read_query
Query Targetprocess work items by resource with filters, sorting, includes, and pagination. Returns matching items with count and truncation status for controlled, paged data retrieval.
Instructions
Query a collection of any resource with where/include/orderBy (layer 1), fully paged. Returns {count, truncated, items}; default limit 500, max 5000. Use include to keep results small.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum items to return (default 500, max 5000). A capped result says truncated: true. | |
| where | No | v1 filter, e.g. (EntityState.Name eq 'Open') and (Project.Id eq 2). Operators: eq, ne, gt, gte, lt, lte, contains, in; no 'or'. | |
| append | No | Calculated values, e.g. [Tasks-Count,Bugs-Count] | |
| exclude | No | Fields to omit | |
| include | No | Fields to return, e.g. [Id,Name,Project[Name],Tasks[Id,Name]] | |
| orderBy | No | Sort field; "Field desc" is accepted | |
| resource | Yes | Resource name (UserStory) or plural path (UserStories); see read_meta | |
| orderByDesc | No | Sort field, descending |