Sign in

v1

latestOpenAPI 3.0.32026-07-12101432.4 KB
Query

executeFlowsQuery

Executes a query against the Flows dataset and returns paginated results for use in Kanban card rendering.

Supports filtering with complex AND/OR logic, sorting, and offset-based pagination. Results are used to populate Kanban swimlane cards with real-time workflow task data.

post/v1/kanban/query/flows:execute

Request body

fromnumber

Zero-based offset for pagination. Use with size to paginate through results.

sizenumber

Number of results to return per page.

Example request

{
  "filters": {
    "items": [
      {
        "key": "assignee",
        "operator": "EQUALS",
        "value": "100020",
        "data_type": "string"
      }
    ],
    "combination": "OR"
  },
  "sorting": {
    "field": "created_at"
  },
  "size": 10
}

Response

Query executed successfully

resultsobject[]

Array of matching workflow task records. Fields vary based on the dataset and card configuration.

hitsnumber

Total number of records matching the query (across all pages).

page_numbernumber

Current page number (1-based).

page_sizenumber

Number of results per page (matches the size request parameter).

total_pagesnumber

Total number of available pages based on hits and page_size.

Example response

{
  "hits": 42,
  "page_number": 1,
  "page_size": 10,
  "total_pages": 5
}