Skip to main content
GET
Get Flow Execution

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
string<uuid>
required

A Flow Execution Id to retrive.

Response

200 - application/json
status
enum<string>
required

The status of the Flow Execution.

Available options:
PROCESSING,
READY,
AWAITING_CONFIRMATION,
CONFIRMED,
STARTING,
RUNNING,
COMPLETED,
CANCELED,
PAUSED
execute_for
enum<string>
required
Available options:
FILTERS,
LIST,
ALL
created_by
object
required

The User that created the Flow Execution.

flow
object
required

The Flow that the Flow Execution is running.

flow_version
object
required

The Flow Version that the Flow Execution is running.

execution_type
enum<string>
required
Available options:
INBOUND,
OUTBOUND,
API,
FROM_FLOW
last_run_on
string
required
read-only

The last time that the Flow Execution was run.

inbound_trigger_with
enum<string>
Available options:
ANY_MESSAGE,
TEXT,
IMAGE,
FILE
inbound_start_message
string | null
inbound_start_message_match_exact
boolean
id
string<uuid>
has_priority
boolean
flow_execution_variables
object
start_on
string<date-time> | null
num_contacts
integer
Required range: 0 <= x <= 2147483647
expired
integer
Required range: 0 <= x <= 2147483647
running
integer
Required range: 0 <= x <= 2147483647
completed
integer
Required range: 0 <= x <= 2147483647
canceled
integer
Required range: 0 <= x <= 2147483647
failed
integer
Required range: 0 <= x <= 2147483647
created_on
string<date-time>
avg_completion_time
string
contact_filters
object[]

The filters to use to get the Contacts that the Flow Execution will run for. This field isn't required if executing the flow for a Contact List

contact_import
string<uuid> | null