Skip to main content
POST
/
api
/
item
/
filter
Executes a filter query against items and returns paginated results.
curl --request POST \
  --url https://{tenant}.ekso.app/api/item/filter \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "criteria": {
    "container": [
      "<string>"
    ],
    "conditionGroup": [
      {
        "condition": [
          {
            "id": "<string>",
            "leftSide": "<string>",
            "rightSide": "<string>",
            "operator": 123
          }
        ]
      }
    ],
    "includeClosed": true,
    "sortField": "<string>",
    "sortDescending": true
  },
  "page": 123,
  "internalStatusClosed": [
    "<string>"
  ],
  "internalStatusFieldId": "<string>"
}
'
{
  "items": [
    {
      "entity": "<string>",
      "containerId": "<string>",
      "processId": "<string>",
      "sequence": 123,
      "boardId": "<string>",
      "cycleId": "<string>",
      "resourceType": 123,
      "resourceId": "<string>",
      "dateOpened": "2023-11-07T05:31:56Z",
      "dateWorking": "2023-11-07T05:31:56Z",
      "dateClosed": "2023-11-07T05:31:56Z",
      "time": [
        {
          "id": "<string>",
          "dated": "2023-11-07T05:31:56Z",
          "userId": "<string>",
          "timeTypeId": "<string>",
          "timeLogged": "<string>",
          "comment": "<string>",
          "status": 123
        }
      ],
      "field": [
        {
          "fieldId": "<string>",
          "data": "<string>"
        }
      ],
      "meta": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "clockStart": "2023-11-07T05:31:56Z",
      "clockFinish": "2023-11-07T05:31:56Z",
      "clockDelta": 123,
      "clockHours": 123,
      "clockStatus": 123,
      "dependencyKey": "<string>",
      "dependencyIndent": 123,
      "dependencyChild": 123,
      "tenantId": "<string>",
      "id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "updated": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "deleted": true
    }
  ],
  "total": 123,
  "pageSize": 123,
  "pages": 123,
  "page": 123
}

Authorizations

Authorization
string
header
required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Body

The filter criteria and page number.

criteria
object
page
internalStatusClosed
string[]
internalStatusFieldId
string

Response

Paginated filter results including items, total count, and page metadata.

items
object[]
total
pageSize
pages
page