Skip to main content
GET
Read Flow Run States

Headers

x-prefect-api-version
string

Query Parameters

flow_run_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required
type
enum<string>
required

Enumeration of state types.

Available options:
SCHEDULED,
PENDING,
RUNNING,
COMPLETED,
FAILED,
CANCELLED,
CRASHED,
PAUSED,
CANCELLING
name
string | null
timestamp
string<date-time>
message
string | null
Example:

"Run started"

data
any | null

Data associated with the state, e.g. a result. Content must be storable as JSON.

state_details
StateDetails · object