POST
/
api
/
work_pools
/
{name}
/
get_scheduled_flow_runs
[
  {
    "work_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "work_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "flow_run": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "name": "my-flow-run",
      "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "state_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deployment_version": "1.0",
      "work_queue_name": "<string>",
      "flow_version": "1.0",
      "parameters": {},
      "idempotency_key": "<string>",
      "context": {
        "my_var": "my_value"
      },
      "empirical_policy": {
        "max_retries": 0,
        "retry_delay_seconds": 0,
        "retries": 123,
        "retry_delay": 123,
        "pause_keys": [
          "<string>"
        ],
        "resuming": true,
        "retry_type": "in_process"
      },
      "tags": [
        "tag-1",
        "tag-2"
      ],
      "labels": {
        "key": "value1",
        "key2": 42
      },
      "parent_task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "state_type": "SCHEDULED",
      "state_name": "<string>",
      "run_count": 0,
      "expected_start_time": "2023-11-07T05:31:56Z",
      "next_scheduled_start_time": "2023-11-07T05:31:56Z",
      "start_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "total_run_time": 0,
      "estimated_run_time": 0,
      "estimated_start_time_delta": 0,
      "auto_scheduled": false,
      "infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "infrastructure_pid": "<string>",
      "created_by": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>",
        "display_value": "<string>"
      },
      "work_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "state": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "SCHEDULED",
        "name": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "message": "Run started",
        "data": "<any>",
        "state_details": {
          "flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "child_flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "scheduled_time": "2023-11-07T05:31:56Z",
          "cache_key": "<string>",
          "cache_expiration": "2023-11-07T05:31:56Z",
          "deferred": true,
          "untrackable_result": false,
          "pause_timeout": "2023-11-07T05:31:56Z",
          "pause_reschedule": false,
          "pause_key": "<string>",
          "run_input_keyset": {},
          "refresh_cache": true,
          "retriable": true,
          "transition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "task_parameters_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "traceparent": "<string>"
        }
      },
      "job_variables": {}
    }
  }
]

Headers

​
x-prefect-api-version
string

Path Parameters

​
name
string
required

The work pool name

Body

application/json
​
work_queue_names
string[]

The names of work pool queues

​
scheduled_before
string

The maximum time to look for scheduled flow runs

​
scheduled_after
string

The minimum time to look for scheduled flow runs

​
limit
integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

200
application/json
Successful Response
​
work_pool_id
string
required
​
work_queue_id
string
required
​
flow_run
object
required

An ORM representation of flow run data.

Was this page helpful?

Count Work PoolsCreate Work Queue