> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://support.atomicwork.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://support.atomicwork.com/_mcp/server. # Load a request Kanban board (1D or 2D), single call POST https://{tenant}.atomicwork.com/api/v1/requests/kanban Content-Type: application/json ### Filtering Use the `filters` field to narrow results. Pass an empty array or omit the field to retrieve all records. Each filter object has the following fields: | Field | Type | Description | | ----------- | ------ | ------------------------------------------------------- | | `attribute` | string | The field to filter on (see Supported attributes below) | | `operator` | string | Comparison operator (see Available operators below) | | `values` | array | One or more `{ "value": }` objects | **Supported attributes** | Attribute | Typical operator | Description | | -------------- | ---------------- | --------------------------------------------------------------------- | | `status` | `IS_ANY_OF` | Ticket status (e.g. `OPEN`, `IN_PROGRESS`, `RESOLVED`, `CLOSED`). | | `type` | `IS_ANY_OF` | Request type (e.g. `INCIDENT`, `SERVICE_REQUEST`, `GENERAL_REQUEST`). | | `assignee_id` | `IS_ANY_OF` | Assigned agent user ID. | | `requester_id` | `IS_ANY_OF` | Requester user ID. | | `created_at` | `IS_BETWEEN` | Creation timestamp (ISO 8601). Use for date range filtering. | | `updated_at` | `IS_BETWEEN` | Last-updated timestamp (ISO 8601). | **Available operators** | Operator | Meaning | | ------------------------------------ | --------------------------------------------------------- | | `EQUALS` | Exact match | | `NOT_EQUALS` | Exclude exact match | | `IN` / `IS_ANY_OF` | Match any value in the list | | `IS_NOT_ANY_OF` | Exclude all listed values | | `IS_BETWEEN` | Inclusive range — pass exactly two values: `[start, end]` | | `IS_ON_OR_BEFORE` / `IS_ON_OR_AFTER` | Date/time boundary comparisons | | `CONTAINS` / `TEXT_CONTAINS` | Substring or set membership | | `IS_NULL` / `IS_NOT_NULL` | Null checks — `values` array can be empty | | `STARTS_WITH` / `ENDS_WITH` | String prefix/suffix match | **Example** ```json [ { "attribute": "status", "operator": "IS_ANY_OF", "values": [ { "value": "OPEN" }, { "value": "IN_PROGRESS" } ] }, { "attribute": "created_at", "operator": "IS_BETWEEN", "values": [ { "value": "2024-01-01T00:00:00Z" }, { "value": "2024-12-31T23:59:59Z" } ] } ] ``` Reference: https://support.atomicwork.com/api-reference/atomicwork-public-api/requests/postapi-v-1-requests-kanban ## Authentication - `X-Api-Key` header (required) — API Key authentication via header ## Request ### Headers - `X-Workspace-Id` (string, optional) ### Body (application/json) This endpoint expects an object. - `group_by` (list of string, required) - `view_name` (string, optional) - `filters` (list of ApiV1RequestsKanbanPostRequestBodyContentApplicationJsonSchemaFiltersItems, optional) - `sort` (string, optional, default: created_at:desc) - `page_size` (integer, optional, default: 25) - `workspace_id` (long, optional) ## Response ### 200 Successful response ## Types ### ApiV1RequestsKanbanPostRequestBodyContentApplicationJsonSchemaFiltersItems - `attribute` (string, optional) - `operator` (enum, optional) - Allowed values: `EQUALS`, `NOT_EQUALS`, `CONTAINS`, `NOT_CONTAINS`, `IN`, `NOT_IN`, `GREATER_THAN`, `LESS_THAN`, `GREATER_THAN_EQUALS`, `LESS_THAN_EQUALS`, `IS_BETWEEN`, `IS_NULL`, `IS_NOT_NULL`, `STARTS_WITH`, `ENDS_WITH`, `TEXT_CONTAINS`, `TEXT_DOES_NOT_CONTAINS`, `IS_ANY_OF`, `IS_NOT_ANY_OF`, `IS_EXACTLY`, `IS_ON_OR_BEFORE`, `IS_ON_OR_AFTER`, `IS_WITHIN` - `values` (list of ApiV1RequestsKanbanPostRequestBodyContentApplicationJsonSchemaFiltersItemsValuesItems, optional) ### ApiV1RequestsKanbanPostRequestBodyContentApplicationJsonSchemaFiltersItemsValuesItems - `value` (ApiV1RequestsKanbanPostRequestBodyContentApplicationJsonSchemaFiltersItemsValuesItemsValue, optional) — A bare scalar - number, string or boolean - never a JSON object or array. For entity-reference attributes pass the numeric id (e.g. 4009, not \{"id": 4009}). - `nested_filter` (any, optional) ### ApiV1RequestsKanbanPostRequestBodyContentApplicationJsonSchemaFiltersItemsValuesItemsValue A bare scalar - number, string or boolean - never a JSON object or array. For entity-reference attributes pass the numeric id (e.g. 4009, not \{"id": 4009}). ## Examples **Request** ```json { "0": { "attribute": "status", "operator": "IS_ANY_OF", "values": [ { "value": "OPEN" }, { "value": "IN_PROGRESS" } ] }, "1": { "attribute": "created_at", "operator": "IS_BETWEEN", "values": [ { "value": "2024-01-01T00:00:00Z" }, { "value": "2024-12-31T23:59:59Z" } ] }, "group_by": [ "string" ], "sort": "function sort() { [native code] }" } ``` **Response** ```json {} ``` **SDK Code** ```python Requests_postapi_v1_requests_kanban_example import requests url = "https://{tenant}.atomicwork.com/api/v1/requests/kanban" payload = { "0": { "attribute": "status", "operator": "IS_ANY_OF", "values": [{ "value": "OPEN" }, { "value": "IN_PROGRESS" }] }, "1": { "attribute": "created_at", "operator": "IS_BETWEEN", "values": [{ "value": "2024-01-01T00:00:00Z" }, { "value": "2024-12-31T23:59:59Z" }] }, "group_by": ["string"], "sort": "function sort() { [native code] }" } headers = { "X-Workspace-Id": "{{workspace_id}}", "X-Api-Key": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Requests_postapi_v1_requests_kanban_example const url = 'https://{tenant}.atomicwork.com/api/v1/requests/kanban'; const options = { method: 'POST', headers: { 'X-Workspace-Id': '{{workspace_id}}', 'X-Api-Key': '', 'Content-Type': 'application/json' }, body: '{"0":{"attribute":"status","operator":"IS_ANY_OF","values":[{"value":"OPEN"},{"value":"IN_PROGRESS"}]},"1":{"attribute":"created_at","operator":"IS_BETWEEN","values":[{"value":"2024-01-01T00:00:00Z"},{"value":"2024-12-31T23:59:59Z"}]},"group_by":["string"],"sort":"function sort() { [native code] }"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Requests_postapi_v1_requests_kanban_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://{tenant}.atomicwork.com/api/v1/requests/kanban" payload := strings.NewReader("{\n \"0\": {\n \"attribute\": \"status\",\n \"operator\": \"IS_ANY_OF\",\n \"values\": [\n {\n \"value\": \"OPEN\"\n },\n {\n \"value\": \"IN_PROGRESS\"\n }\n ]\n },\n \"1\": {\n \"attribute\": \"created_at\",\n \"operator\": \"IS_BETWEEN\",\n \"values\": [\n {\n \"value\": \"2024-01-01T00:00:00Z\"\n },\n {\n \"value\": \"2024-12-31T23:59:59Z\"\n }\n ]\n },\n \"group_by\": [\n \"string\"\n ],\n \"sort\": \"function sort() { [native code] }\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-Workspace-Id", "{{workspace_id}}") req.Header.Add("X-Api-Key", "") 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 Requests_postapi_v1_requests_kanban_example require 'uri' require 'net/http' url = URI("https://{tenant}.atomicwork.com/api/v1/requests/kanban") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["X-Workspace-Id"] = '{{workspace_id}}' request["X-Api-Key"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"0\": {\n \"attribute\": \"status\",\n \"operator\": \"IS_ANY_OF\",\n \"values\": [\n {\n \"value\": \"OPEN\"\n },\n {\n \"value\": \"IN_PROGRESS\"\n }\n ]\n },\n \"1\": {\n \"attribute\": \"created_at\",\n \"operator\": \"IS_BETWEEN\",\n \"values\": [\n {\n \"value\": \"2024-01-01T00:00:00Z\"\n },\n {\n \"value\": \"2024-12-31T23:59:59Z\"\n }\n ]\n },\n \"group_by\": [\n \"string\"\n ],\n \"sort\": \"function sort() { [native code] }\"\n}" response = http.request(request) puts response.read_body ``` ```java Requests_postapi_v1_requests_kanban_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://{tenant}.atomicwork.com/api/v1/requests/kanban") .header("X-Workspace-Id", "{{workspace_id}}") .header("X-Api-Key", "") .header("Content-Type", "application/json") .body("{\n \"0\": {\n \"attribute\": \"status\",\n \"operator\": \"IS_ANY_OF\",\n \"values\": [\n {\n \"value\": \"OPEN\"\n },\n {\n \"value\": \"IN_PROGRESS\"\n }\n ]\n },\n \"1\": {\n \"attribute\": \"created_at\",\n \"operator\": \"IS_BETWEEN\",\n \"values\": [\n {\n \"value\": \"2024-01-01T00:00:00Z\"\n },\n {\n \"value\": \"2024-12-31T23:59:59Z\"\n }\n ]\n },\n \"group_by\": [\n \"string\"\n ],\n \"sort\": \"function sort() { [native code] }\"\n}") .asString(); ``` ```php Requests_postapi_v1_requests_kanban_example request('POST', 'https://{tenant}.atomicwork.com/api/v1/requests/kanban', [ 'body' => '{ "0": { "attribute": "status", "operator": "IS_ANY_OF", "values": [ { "value": "OPEN" }, { "value": "IN_PROGRESS" } ] }, "1": { "attribute": "created_at", "operator": "IS_BETWEEN", "values": [ { "value": "2024-01-01T00:00:00Z" }, { "value": "2024-12-31T23:59:59Z" } ] }, "group_by": [ "string" ], "sort": "function sort() { [native code] }" }', 'headers' => [ 'Content-Type' => 'application/json', 'X-Api-Key' => '', 'X-Workspace-Id' => '{{workspace_id}}', ], ]); echo $response->getBody(); ``` ```csharp Requests_postapi_v1_requests_kanban_example using RestSharp; var client = new RestClient("https://{tenant}.atomicwork.com/api/v1/requests/kanban"); var request = new RestRequest(Method.POST); request.AddHeader("X-Workspace-Id", "{{workspace_id}}"); request.AddHeader("X-Api-Key", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"0\": {\n \"attribute\": \"status\",\n \"operator\": \"IS_ANY_OF\",\n \"values\": [\n {\n \"value\": \"OPEN\"\n },\n {\n \"value\": \"IN_PROGRESS\"\n }\n ]\n },\n \"1\": {\n \"attribute\": \"created_at\",\n \"operator\": \"IS_BETWEEN\",\n \"values\": [\n {\n \"value\": \"2024-01-01T00:00:00Z\"\n },\n {\n \"value\": \"2024-12-31T23:59:59Z\"\n }\n ]\n },\n \"group_by\": [\n \"string\"\n ],\n \"sort\": \"function sort() { [native code] }\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Requests_postapi_v1_requests_kanban_example import Foundation let headers = [ "X-Workspace-Id": "{{workspace_id}}", "X-Api-Key": "", "Content-Type": "application/json" ] let parameters = [ "0": [ "attribute": "status", "operator": "IS_ANY_OF", "values": [["value": "OPEN"], ["value": "IN_PROGRESS"]] ], "1": [ "attribute": "created_at", "operator": "IS_BETWEEN", "values": [["value": "2024-01-01T00:00:00Z"], ["value": "2024-12-31T23:59:59Z"]] ], "group_by": ["string"], "sort": "function sort() { [native code] }" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://{tenant}.atomicwork.com/api/v1/requests/kanban")! 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() ```