---
title: "Get Flow Execution"
method: GET
path: "/channel/whatsapp/flow-execution/{id}"
tags: ["Flows"]
---

# Get Flow Execution

`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`

Get Flow Execution by Id.

## Path parameters

- `id` string, uuid, required

## Response `200`

- FlowExecutionReadDetail
  - `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
  - `id` string, uuid
  - `has_priority` boolean
  - `flow_execution_variables` unknown
  - `start_on` string, date-time, nullable
  - `num_contacts` integer
  - `expired` integer
  - `running` integer
  - `completed` integer
  - `canceled` integer
  - `failed` integer
  - `created_on` string, date-time
  - `avg_completion_time` string
  - `status_reason` string, nullable, required
  - `status_triggered_by` SimpleUser, required
    - `first_name` string
    - `last_name` string
    - `email` string, email, required
    - `id` integer, required
    - `profile_image` string, uri, nullable
    - `role` integer, nullable
  - `status_last_change_on` string, date-time, nullable, required
  - `created_by` SimpleUser, required
    - `first_name` string
    - `last_name` string
    - `email` string, email, required
    - `id` integer, required
    - `profile_image` string, uri, nullable
    - `role` integer, nullable
  - `contact_filters` FlowExecutionContactFilterEdit[]: 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
    - `field` string, required
    - `comparison` 'exact' | '!exact' | 'gte' | 'gt' | 'lte' | 'lt' | 'isnull' | '!isnull' | 'icontains' | '!icontains', required: * `exact` - Exact * `!exact` - Different * `gte` - Gte * `gt` - Gt * `lte` - Lte * `lt` - Lt * `isnull` - Is Null * `!isnull` - Not Null * `icontains` - Contains * `!icontains` - Not Contains
    - `value` string, required
    - `id` string, uuid
  - `contact_import` string, uuid, nullable
  - `flow` FlowSimpleRead, required
    - `id` string, required
    - `name` string, required
    - `created_by` SimpleUser, required
      - `first_name` string
      - `last_name` string
      - `email` string, email, required
      - `id` integer, required
      - `profile_image` string, uri, nullable
      - `role` integer, nullable
    - `created_on` string, date-time
    - `is_active` boolean
    - `status` 'DRAFT' | 'PUBLISHED': * `DRAFT` - Draft * `PUBLISHED` - Published
    - `is_legacy` boolean
    - `channel` SimpleChannel, required
      - `id` integer, required
      - `channel_type` 'WHATSAPP' | 'EMAIL' | 'INSTAGRAM' | 'FB_MESSENGER' | 'TELEGRAM' | 'SMS' | 'VOICE': * `WHATSAPP` - Whatsapp * `EMAIL` - Email * `INSTAGRAM` - Instagram * `FB_MESSENGER` - Fb Messenger * `TELEGRAM` - Telegram * `SMS` - Sms * `VOICE` - Voice
      - `name` string
      - `channel_id` string, required
      - `status` 'NEW' | 'ACTIVE' | 'INACTIVE': * `NEW` - New * `ACTIVE` - Active * `INACTIVE` - Inactive
      - `created_on` string, date-time
      - `channel_provider` 'META_CLOUD_API' | 'TECH_PROVIDER_CLOUD_API' | 'D360_CLOUD_API' | '360DIALOG': * `META_CLOUD_API` - Meta Cloud Api * `TECH_PROVIDER_CLOUD_API` - Tech Provider Cloud Api * `D360_CLOUD_API` - D360 Cloud Api * `360DIALOG` - Dialog360
      - `is_sandbox` boolean
    - `flow_execution_variables` string[], nullable
    - `trigger_type` 'INBOUND_ANY_MESSAGE' | 'INBOUND_SPECIFIC_MESSAGE' | 'OUTBOUND_CAMPAIGN_API' | 'OUTBOUND_CAMPAIGN_CSV' | 'OUTBOUND_CAMPAIGN_SEGMENT' | 'OUTBOUND_ANY' | 'META_C2WA' | 'INTEGRATIONS_HUBSPOT' | 'INTEGRATIONS_ZAPIER' | 'FROM_FLOW' | 'CSAT' | 'OTHER', required: * `INBOUND_ANY_MESSAGE` - Inbound Any Message * `INBOUND_SPECIFIC_MESSAGE` - Inbound Specific Message * `OUTBOUND_CAMPAIGN_API` - Outbound Campaign Api * `OUTBOUND_CAMPAIGN_CSV` - Outbound Campaign Csv * `OUTBOUND_CAMPAIGN_SEGMENT` - Outbound Campaign Segment * `OUTBOUND_ANY` - Outbound Any * `META_C2WA` - Meta C2Wa * `INTEGRATIONS_HUBSPOT` - Integrations Hubspot * `INTEGRATIONS_ZAPIER` - Integrations Zapier * `FROM_FLOW` - From Flow * `CSAT` - Csat * `OTHER` - Other
    - `trigger_config` unknown
  - `flow_version` FlowVersionSimpleRead, required
    - `id` string, uuid
    - `flow` FlowSimpleRead, required
      - `id` string, required
      - `name` string, required
      - `created_by` SimpleUser, required
        - `first_name` string
        - `last_name` string
        - `email` string, email, required
        - `id` integer, required
        - `profile_image` string, uri, nullable
        - `role` integer, nullable
      - `created_on` string, date-time
      - `is_active` boolean
      - `status` 'DRAFT' | 'PUBLISHED': * `DRAFT` - Draft * `PUBLISHED` - Published
      - `is_legacy` boolean
      - `channel` SimpleChannel, required
        - `id` integer, required
        - `channel_type` 'WHATSAPP' | 'EMAIL' | 'INSTAGRAM' | 'FB_MESSENGER' | 'TELEGRAM' | 'SMS' | 'VOICE': * `WHATSAPP` - Whatsapp * `EMAIL` - Email * `INSTAGRAM` - Instagram * `FB_MESSENGER` - Fb Messenger * `TELEGRAM` - Telegram * `SMS` - Sms * `VOICE` - Voice
        - `name` string
        - `channel_id` string, required
        - `status` 'NEW' | 'ACTIVE' | 'INACTIVE': * `NEW` - New * `ACTIVE` - Active * `INACTIVE` - Inactive
        - `created_on` string, date-time
        - `channel_provider` 'META_CLOUD_API' | 'TECH_PROVIDER_CLOUD_API' | 'D360_CLOUD_API' | '360DIALOG': * `META_CLOUD_API` - Meta Cloud Api * `TECH_PROVIDER_CLOUD_API` - Tech Provider Cloud Api * `D360_CLOUD_API` - D360 Cloud Api * `360DIALOG` - Dialog360
        - `is_sandbox` boolean
      - `flow_execution_variables` string[], nullable
      - `trigger_type` 'INBOUND_ANY_MESSAGE' | 'INBOUND_SPECIFIC_MESSAGE' | 'OUTBOUND_CAMPAIGN_API' | 'OUTBOUND_CAMPAIGN_CSV' | 'OUTBOUND_CAMPAIGN_SEGMENT' | 'OUTBOUND_ANY' | 'META_C2WA' | 'INTEGRATIONS_HUBSPOT' | 'INTEGRATIONS_ZAPIER' | 'FROM_FLOW' | 'CSAT' | 'OTHER', required: * `INBOUND_ANY_MESSAGE` - Inbound Any Message * `INBOUND_SPECIFIC_MESSAGE` - Inbound Specific Message * `OUTBOUND_CAMPAIGN_API` - Outbound Campaign Api * `OUTBOUND_CAMPAIGN_CSV` - Outbound Campaign Csv * `OUTBOUND_CAMPAIGN_SEGMENT` - Outbound Campaign Segment * `OUTBOUND_ANY` - Outbound Any * `META_C2WA` - Meta C2Wa * `INTEGRATIONS_HUBSPOT` - Integrations Hubspot * `INTEGRATIONS_ZAPIER` - Integrations Zapier * `FROM_FLOW` - From Flow * `CSAT` - Csat * `OTHER` - Other
      - `trigger_config` unknown
    - `is_current_version` boolean, required
    - `version_name` string
    - `version_description` string, nullable
    - `published_by` SimpleUser, required
      - `first_name` string
      - `last_name` string
      - `email` string, email, required
      - `id` integer, required
      - `profile_image` string, uri, nullable
      - `role` integer, nullable
    - `created_on` string, date-time
    - `last_updated_on` string, date-time, required
    - `num_contacts` integer
    - `completed` integer
    - `expired` integer
    - `running` integer
    - `canceled` integer
    - `failed` integer
    - `avg_completion_time` string
  - `last_run_on` string, date-time, required: The last time that the Flow Execution was run.

---

[API](https://skmtc.dev/activecampaign/apis/whatsapp-api.md) - [All operations](https://skmtc.dev/activecampaign/apis/whatsapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/activecampaign/apis/whatsapp-api/revisions/6c7855d91b4d?raw)
