Skip to main content
POST
Read Flows

Headers

x-prefect-api-version
string

Body

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

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

flow_runs
FlowRunFilter · object

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

task_runs
TaskRunFilter · object

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

deployments
DeploymentFilter · object

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

work_pools
WorkPoolFilter · object

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

sort
enum<string>
default:NAME_ASC

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

Pattern: ^[^/%&><]+$
Example:

"my-flow"

tags
string[]

A list of flow tags

Example:
labels
Labels · object | null

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

Example: