Skip to main content
GET
/
v4
/
workflows
/
{workflowId}
/
data
cURL
curl -X GET "https://api.kadoa.com/v4/workflows/123456789/data?format=json&sortBy=postedDate&order=desc&filters=%5B%7B%22field%22%3A%22jobTitle%22%2C%22operator%22%3A%22CONTAINS%22%2C%22value%22%3A%22Manager%22%7D%2C%7B%22field%22%3A%22postedDate%22%2C%22operator%22%3A%22GREATER_THAN%22%2C%22value%22%3A%222023-01-01%22%7D%5D&page=1&limit=25" \
-H "x-api-key: YOUR_API_KEY"

{
  "workflowId": "<string>",
  "data": [
    {}
  ],
  "pagination": {
    "totalCount": 123,
    "page": 123,
    "totalPages": 123,
    "limit": 123
  },
  "runId": "<string>",
  "executedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Headers

​
x-api-key
string

API key for authorization

​
Authorization
string

Bearer token for authorization

Path Parameters

​
workflowId
string
required

ID of the workflow to retrieve data from

Query Parameters

​
runId
string

ID of a specific run to retrieve data from

​
format
enum<string>
default:json

Format of the response data

Available options:
json,
csv
​
sortBy
string

Field to sort the results by

​
order
enum<string>
default:asc

Sort order (ascending or descending)

Available options:
asc,
desc
​
filters
string

JSON-encoded array of filter objects

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
limit
integer
default:25

Number of items per page (0 for streaming all data)

Required range: x >= 0
​
gzip
boolean
default:false

Enable gzip compression for the response

​
rowIds
string

Filter results by specific row IDs (comma-separated or JSON array)

​
includeAnomalies
boolean
default:false

Include validation anomalies for each row in the response

​
download
enum<string>
default:stream

"stream" (default) returns the data inline (subject to a 5-minute response timeout). "link" materializes the full result set as a CSV in object storage and returns a JSON body with an export id; the caller then streams the file from GET /v4/workflows/{workflowId}/data/exports/{exportId}. Use "link" for large exports that would exceed the streaming timeout. Currently requires format=csv.

Available options:
stream,
link

Response

Workflow data returned successfully. The application/json body has two shapes: the default streaming shape (workflowId, data, pagination), and the download=link shape (export id pointing at a materialized CSV; fetch via the exports endpoint).

Default streaming response (download omitted or download=stream).

​
workflowId
string
required
​
data
object[]
required
​
pagination
object
required
​
runId
string | null
​
executedAt
string<date-time> | null