> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itential.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server. # Search work items with filtering, sorting, and pagination POST https://example.itential.io/work-center-service/work-items/search Content-Type: application/json Searches work items with filtering, sorting, and pagination. Reference: https://docs.itential.com/itential-platform/6/api-reference/work-center-service/search-work-items ## Authentication - `Authorization` header (basic auth, required) — Basic authentication of the form `Basic `. ## Request ### Body (application/json) This endpoint expects an object. - `filters` (list of object, optional) — Filter criteria. Multiple filters are ANDed together. - `field` (enum, required) — The field name to filter on. - Allowed values: `name`, `summary`, `owner`, `createdAt`, `executionStartTime`, `triggerType`, `triggerLabel`, `executionName`, `executionDescription` - `operator` (enum, required) — The filter operator. - Allowed values: `contains`, `equals`, `in`, `before`, `after` - `value` (string, required) — The filter value. Can be a string, array of strings, or null. - `sort` (object, optional) — Sort configuration. Defaults to createdAt descending. - `field` (enum, required) — The field to sort by. - Allowed values: `createdAt`, `executionStartTime`, `triggerLabel`, `triggerType`, `executionName`, `owner`, `name`, `summary`, `executionDescription` - `order` (enum, required) — The sort direction. - Allowed values: `asc`, `desc` - `skip` (double, optional) — Number of items to skip. Defaults to 0. - `limit` (double, optional) — Number of items to return (1-100). Defaults to 25. ## Response ### 200 Paginated work item summaries - `data` (list of object, required) — Paginated list of work item summaries. - `id` (string, required) — Unique identifier (UUID) of the work item. - `name` (string, required) — Human-readable name of the work item. - `summary` (string, required) — Brief summary of the work item. - `status` (enum, required) — Current status of the work item. - Allowed values: `pending`, `completed`, `canceled` - `groups` (object, required) — Access control groups. - `read` (list of string, required) — Array of group identifiers with read access to the work item. - `write` (list of string, required) — Array of group identifiers with write access to the work item. - `rootExecution` (object, required) — Root execution metadata. - `id` (string, required) — Unique identifier of the root execution that started the ancestry chain. - `name` (string, required) — Human-readable name of the root execution. - `trigger` (object, required) — Trigger information defining what initiated the root execution. - `type` (enum, required) — Type of trigger that initiated the work item. - Allowed values: `manual`, `endpoint`, `schedule`, `eventSystem`, `job`, `session` - `label` (string, required) — Human-readable label for the trigger. - `startTime` (string, required) — ISO 8601 timestamp when the root execution started. - `url` (string, optional) — Optional URL to access the root execution (e.g., workflow execution UI link). - `execution` (object, required) — Execution that invoked createWorkItem. - `id` (string, required) — Unique identifier of the running job or session that invoked createWorkItem. - `name` (string, required) — Human-readable name of the parent job or session. - `type` (string, required) — Opaque execution type passed to the ancestry adapter (e.g. job, session). - `url` (string, optional) — Optional URL to access the execution. - `description` (string, optional) — Optional description of the execution, useful for differentiating between concurrent executions. - `metrics` (object, required) — Work item operational metrics. - `owner` (string, required) — Account ID of the operator who claimed the work item. - `claimTime` (string, required) — ISO 8601 timestamp when the work item was claimed. - `finishState` (string, required) — Opaque finish state string emitted by the view component on completion. - `ownerUsername` (string, optional) — Resolved username of the operator who claimed the work item. - `createdAt` (string, required) — ISO 8601 creation timestamp. - `updatedAt` (string, required) — ISO 8601 last updated timestamp. ## Errors ### 500 Internal Server Error Error response from API - `any` ## Examples **Request** ```json {} ``` **Response** ```json { "data": [ { "id": "string", "name": "string", "summary": "string", "status": "pending", "groups": { "read": [ "string" ], "write": [ "string" ] }, "rootExecution": { "id": "string", "name": "string", "trigger": { "type": "manual", "label": "string" }, "startTime": "2024-01-15T09:30:00Z", "url": "string" }, "execution": { "id": "string", "name": "string", "type": "string", "url": "string", "description": "string" }, "metrics": { "owner": "string", "claimTime": "string", "finishState": "string", "ownerUsername": "string" }, "createdAt": "string", "updatedAt": "string" } ] } ``` **SDK Code** ```python import requests url = "https://example.itential.io/work-center-service/work-items/search" payload = {} headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://example.itential.io/work-center-service/work-items/search'; const options = {method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{}'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://example.itential.io/work-center-service/work-items/search" payload := strings.NewReader("{}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://example.itential.io/work-center-service/work-items/search") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://example.itential.io/work-center-service/work-items/search") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('POST', 'https://example.itential.io/work-center-service/work-items/search', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://example.itential.io/work-center-service/work-items/search"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Content-Type": "application/json"] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://example.itential.io/work-center-service/work-items/search")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```