Get an specific flow execution

Get Flow Execution by Id.

GET /api/flow-execution/{id}

Get Flow Execution

cURL

curl --request GET \
  --url https://api.hilos.io/api/flow-execution/{id} \
  --header 'Authorization: <api-key>'

200

{
  "status": "PROCESSING",
  "execute_for": "FILTERS",
  "created_by": {
    "id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "[e-mail]",
    "profile_image": "<string>",
    "role": "AGENT"
  },
  "flow": {
    "id": "<string>",
    "name": "<string>",
    "created_by": {
      "id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "[e-mail]",
      "profile_image": "<string>",
      "role": "AGENT"
    },
    "channel": {
      "id": 123,
      "channel_id": "<string>",
      "channel_type": "WHATSAPP",
      "name": "<string>",
      "status": "NEW",
      "created_on": "2023-11-07T05:31:56Z",
      "channel_provider": "META_CLOUD_API",
      "is_sandbox": true
    },
    "created_on": "2023-11-07T05:31:56Z",
    "is_active": true,
    "status": "DRAFT",
    "is_legacy": true,
    "flow_execution_variables": [
      "<string>"
    ]
  },
  "flow_version": {
    "execution_type": "INBOUND",
    "flow": {
      "id": "<string>",
      "name": "<string>",
      "created_by": {
        "id": 123,
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "[e-mail]",
        "profile_image": "<string>",
        "role": "AGENT"
      },
      "channel": {
        "id": 123,
        "channel_id": "<string>",
        "channel_type": "WHATSAPP",
        "name": "<string>",
        "status": "NEW",
        "created_on": "2023-11-07T05:31:56Z",
        "channel_provider": "META_CLOUD_API",
        "is_sandbox": true
      },
      "created_on": "2023-11-07T05:31:56Z",
      "is_active": true,
      "status": "DRAFT",
      "is_legacy": true,
      "flow_execution_variables": [
        "<string>"
      ]
    },
    "is_current_version": true,
    "published_by": {
      "id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "[e-mail]",
      "profile_image": "<string>",
      "role": "AGENT"
    },
    "last_updated_on": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_name": "<string>",
    "version_description": "<string>",
    "created_on": "2023-11-07T05:31:56Z",
    "num_contacts": 1073741823,
    "completed": 1073741823,
    "expired": 1073741823,
    "running": 1073741823,
    "canceled": 1073741823,
    "failed": 1073741823,
    "avg_completion_time": "<string>"
  },
  "execution_type": "INBOUND",
  "last_run_on": "<string>",
  "inbound_trigger_with": "ANY_MESSAGE",
  "inbound_start_message": "<string>",
  "inbound_start_message_match_exact": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "has_priority": true,
  "flow_execution_variables": {},
  "start_on": "2023-11-07T05:31:56Z",
  "num_contacts": 1073741823,
  "expired": 1073741823,
  "running": 1073741823,
  "completed": 1073741823,
  "canceled": 1073741823,
  "failed": 1073741823,
  "created_on": "2023-11-07T05:31:56Z",
  "avg_completion_time": "<string>",
  "contact_filters": [
    {
      "field": "<string>",
      "comparison": "exact",
      "value": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "contact_import": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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.

Show child attributes

flow · object · required

The Flow that the Flow Execution is running.

Show child attributes

flow_version · object · required

The Flow Version that the Flow Execution is running.

Show child attributes

execution_type · enum<string> · required

Available options: INBOUND, OUTBOUND, API, FROM_FLOW

last_run_on · string · required

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

Show child attributes

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

Show child attributes

contact_import · string<uuid> | null