Skip to main content
POST
/
workflows
/
search
Query workflows
curl --request POST \
  --url https://us.api.flexprice.io/v1/workflows/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "end_time": "2023-11-07T05:31:56Z",
  "entity": "<string>",
  "entity_id": "<string>",
  "expand": "<string>",
  "filters": [
    {
      "field": "<string>",
      "value": {
        "array": [
          "<string>"
        ],
        "boolean": true,
        "date": "<string>",
        "number": 123,
        "string": "<string>"
      }
    }
  ],
  "limit": 500,
  "offset": 1,
  "sort": [
    {
      "field": "<string>"
    }
  ],
  "start_time": "2023-11-07T05:31:56Z",
  "task_queue": "<string>",
  "workflow_id": "<string>",
  "workflow_status": "<string>",
  "workflow_type": "<string>"
}
'
{
  "items": [
    {
      "close_time": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "duration_ms": 123,
      "entity": "<string>",
      "entity_id": "<string>",
      "run_id": "<string>",
      "start_time": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "task_queue": "<string>",
      "total_duration": "<string>",
      "workflow_id": "<string>",
      "workflow_type": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flexprice.io/llms.txt

Use this file to discover all available pages before exploring further.

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