POST
/
api
/
flows
/
filter
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "my-flow",
    "tags": [
      "tag-1",
      "tag-2"
    ],
    "labels": {
      "key": "value1",
      "key2": 42
    }
  }
]

Headers

​
x-prefect-api-version
string

Body

application/json
​
offset
integer
default:0
Required range: x >= 0
​
flows
object

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

​
flow_runs
object

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

​
task_runs
object

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

​
deployments
object

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

​
work_pools
object

Filter work pools. Only work pools matching all criteria will be returned

​
sort
enum<string>

Defines flow sorting options.

Available options:
CREATED_DESC,
UPDATED_DESC,
NAME_ASC,
NAME_DESC
​
limit
integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

​
id
string<uuid>
required
​
created
string<date-time> | null
required
​
updated
string<date-time> | null
required
​
name
string
required

The name of the flow

Examples:

"my-flow"

​
tags
string[]

A list of flow tags

Examples:
["tag-1", "tag-2"]
​
labels
object | null

A dictionary of key-value labels. Values can be strings, numbers, or booleans.

Examples:
{ "key": "value1", "key2": 42 }