API delivery gives you complete control over when and how you retrieve your extracted data. Perfect for batch processing, scheduled jobs, or on-demand access.

​
Basic Usage

​
Get Latest Data

Retrieve the most recent data from a workflow:

curl -X GET https://api.kadoa.com/v4/workflows/{workflowId}/data \
  -H "x-api-key: YOUR_API_KEY"

​
Response Format

{
  "data": [
    {
      "id": "123",
      "title": "Product Name",
      "price": 99.99,
      "extractedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "metadata": {
    "workflowId": "workflow-123",
    "runId": "run-456",
    "totalRecords": 150,
    "hasMore": false
  }
}

​
Pagination and Filtering

​
Handle Large Datasets

Use pagination for efficient data retrieval:

curl -X GET https://api.kadoa.com/v4/workflows/{workflowId}/data?limit=100&offset=0 \
  -H "x-api-key: YOUR_API_KEY"

​
Filtering Options

Target specific data with query parameters:

  • Date Range: ?startDate=2024-01-01&endDate=2024-01-31
  • Status Filter: ?status=success
  • Changes Only: ?changesOnly=true
  • Fields: ?fields=title,price,extractedAt

​
Example with Filters

curl -X GET "https://api.kadoa.com/v4/workflows/{workflowId}/data?startDate=2024-01-01&changesOnly=true&limit=50" \
  -H "x-api-key: YOUR_API_KEY"

​
Data Formats

​
JSON (Default)

Standard JSON format, perfect for modern applications:

{
  "data": [...],
  "metadata": {...}
}

​
CSV Format

Add Accept: text/csv header for CSV output:

curl -X GET https://api.kadoa.com/v4/workflows/{workflowId}/data \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: text/csv"

​
Error Handling

​
Common HTTP Status Codes

CodeMeaningAction
200SuccessProcess data normally
400Bad RequestCheck query parameters
401UnauthorizedVerify API key
404Not FoundCheck workflow ID
429Rate LimitedWait and retry
500Server ErrorContact support

​
API Reference

For complete API documentation, see: