Workflows

Get workflow data by ID

get/v4/workflows/{workflowId}/data

Request

  • Base URL: https://api.kadoa.com
  • URL: https://api.kadoa.com/v4/workflows/{workflowId}/data
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

workflowIdstring required

ID of the workflow to retrieve data from

Query parameters

runIdstring

ID of a specific run to retrieve data from

format'json' | 'csv'

Format of the response data

sortBystring

Field to sort the results by

order'asc' | 'desc'

Sort order (ascending or descending)

filtersstring

JSON-encoded array of filter objects

pageinteger

Page number for pagination

limitinteger

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

gzipboolean

Enable gzip compression for the response

rowIdsstring

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

download'stream' | 'link'

"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.

Headers

x-api-keystring

API key for authorization

Authorizationstring

Bearer token for authorization

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).

OR

Changes

No recorded changes to this operation across all 1 revision of this API.