POST
/
api
/
flows
/
filter

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

200 - application/json
id
string
created
string | null
updated
string | null
name
string
required

The name of the flow

tags
string[]

A list of flow tags

labels
object | null

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