Skip to main content
POST
Query workflows

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Filter

end_time
string<date-time>
entity
string

e.g. plan, invoice, subscription

entity_id
string

e.g. plan_01ABC123

expand
string
filters
object[]

filters allows complex filtering based on multiple fields (same as FeatureFilter)

limit
integer
Required range: 1 <= x <= 1000
offset
integer
Required range: x >= 0
order
enum<string>
Available options:
asc,
desc
sort
object[]
start_time
string<date-time>
status
enum<string>
Available options:
published,
deleted,
archived
task_queue
string
workflow_id
string

Workflow-specific filters

workflow_status
string

e.g. Running, Completed, Failed

workflow_type
string

Response

OK

items
object[]
pagination
object