Flows

Get Flow Execution

Get Flow Execution by Id.

get/channel/whatsapp/flow-execution/{id}

Request

  • Base URL
    https://{youraccountname}.api-us1.com/api/3
  • URL
    https://{youraccountname}.api-us1.com/api/3/channel/whatsapp/flow-execution/{id}
  • Auth
    API key in header Token

Path parameters

idstring uuid required

A Flow Execution Id to retrive.

Response

status'PROCESSING' | 'READY' | 'AWAITING_CONFIRMATION' | 'CONFIRMED' | 'STARTING' | 'RUNNING' | 'COMPLETED' | 'CANCELED' required
  • PROCESSING - Processing
  • READY - Ready
  • AWAITING_CONFIRMATION - Awaiting Confirmation
  • CONFIRMED - Confirmed
  • STARTING - Starting
  • RUNNING - Running
  • COMPLETED - Completed
  • CANCELED - Canceled
execute_for'FILTERS' | 'LIST' | 'ALL' required
  • FILTERS - Filters
  • LIST - List
  • ALL - All
idstring uuid
has_priorityboolean
flow_execution_variablesunknown
start_onstring date-time nullable
num_contactsinteger
expiredinteger
runninginteger
completedinteger
canceledinteger
failedinteger
created_onstring date-time
avg_completion_timestring
status_reasonstring nullable required
status_last_change_onstring date-time nullable required
contact_importstring uuid nullable
last_run_onstring date-time required

The last time that the Flow Execution was run.

Changes

No recorded changes to this operation across all 1 revision of this API.