POST
/
api
/
task_runs
/
paginate
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "name": "my-task-run",
      "flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "task_key": "<string>",
      "state_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>",
          "deployment_concurrency_lease_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "task_version": "1.0",
      "parameters": {},
      "task_inputs": {},
      "context": {
        "my_var": "my_val"
      },
      "empirical_policy": {
        "max_retries": 0,
        "retry_delay_seconds": 0,
        "retries": 123,
        "retry_delay": 123,
        "retry_jitter_factor": 123
      },
      "tags": [
        "tag-1",
        "tag-2"
      ]
    }
  ],
  "count": 123,
  "limit": 123,
  "pages": 123,
  "page": 123
}

Headers

​
x-prefect-api-version
string

Body

application/json
​
sort
enum<string>

Defines task run sorting options.

Available options:
ID_DESC,
EXPECTED_START_TIME_ASC,
EXPECTED_START_TIME_DESC,
NAME_ASC,
NAME_DESC,
NEXT_SCHEDULED_START_TIME_ASC,
END_TIME_DESC
​
page
integer
default:1
Required range: x >= 1
​
flows
object | null

Filter for flows. Only flows matching all criteria will be returned.

​
flow_runs
object | null

Filter flow runs. Only flow runs matching all criteria will be returned

​
task_runs
object | null

Filter task runs. Only task runs matching all criteria will be returned

​
deployments
object | null

Filter for deployments. Only deployments matching all criteria will be returned.

​
limit
integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

​
results
TaskRunResponse · object[]
required
​
count
integer
required
​
limit
integer
required
​
pages
integer
required
​
page
integer
required