API

Guides

Messages

Voice

WhatsApp Business

Groups

Contacts

Outbox

Account

Sender IDs

Teammate/Subaccount

Conversations

Workflows

Message Templates

Birthday Message

Opt-out

Other

Webhooks (v2)

Get execution

Returns one execution of a workflow with the payload it ran with and its result: the nodes that were visited, what every action did and why the run stopped. See Workflows for the values of status, stopped_reason and the results.

Base URL:

GET: https://api.smsgatewayapi.com/v1/flows/{flow_id}/executions/{execution_id}

Example:

GET: https://api.smsgatewayapi.com/v1/flows/flw_5d41402abc4b2a76b9719d911017c592/executions/0f2d9c4e-7b1a-4e6d-8c3f-5a6b7c8d9e0f
ParameterInputDescription
client_idAPI client IDDeveloper › API & Webhooks › API credentials
Required
client_secretAPI client secretA cs_ credential, shown once when you create it under Developer › API & Webhooks › API credentials
Required
flow_idworkflow IDThe public ID (flw_...) of the workflow as returned by List workflows; the numeric ID is accepted too
Required
execution_idexecution IDThe uuid of the execution as returned by List executions, Test workflow or Run workflow
Required
<?php
	//PHP - cURL
	$ch = curl_init();
	$url = "https://api.smsgatewayapi.com/v1/flows/{flow_id}/executions/{execution_id}";
	$client_id = "XXX"; // Your API client ID (required)
	$client_secret = "YYY"; // Your API client secret (required)
	
curl_setopt($ch, CURLOPT_URL, "$url"); curl_setopt($ch, CURLOPT_POST, false); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_VERBOSE, true); curl_setopt($ch, CURLOPT_HTTPHEADER, [ "X-Client-Id: $client_id", "X-Client-Secret: $client_secret", "Content-Type: application/json", ]); $response = curl_exec($ch); ?>

Example success response:

{
	"id": "0f2d9c4e-7b1a-4e6d-8c3f-5a6b7c8d9e0f",
	"source": "test",
	"status": "completed",
	"trigger_type": "inbound_message",
	"stopped_reason": "completed",
	"version_number": 3,
	"created_at": "2026-09-08T11:05:12+02:00",
	"payload": {
		"message": { "body": "Hello", "channel": "sms", "inbox_id": 0 },
		"contact": { "phone": "32470123456" },
		"system": { "date": "2026-09-08", "time": "10:30", "timezone": "Europe/Brussels" },
		"execution": { "run_count": 0 }
	},
	"result": {
		"visited_nodes": [
			{ "id": "trigger", "type": "triggerNode", "label": "Inbound message", "result": "triggered", "subtitle": "inbound_message", "incoming_edge_id": null },
			{ "id": "office_hours", "type": "conditionNode", "label": "Within office hours?", "result": "matched", "branch": "true", "incoming_edge_id": "e1" },
			{ "id": "assign", "type": "actionNode", "label": "Assign to support", "result": "would_execute", "subtitle": "Conversation would be assigned to one of alice, bob (round robin) unless it is already assigned", "incoming_edge_id": "e2" }
		],
		"actions": [
			{
				"type": "assign_conversation",
				"summary": "Conversation would be assigned to one of alice, bob (round robin) unless it is already assigned",
				"details": {
					"conversation_key": "32470123456",
					"assign_mode": "round_robin",
					"team_member": null,
					"team_members": [
						{ "team_member": "sub_3520a1ec234dbabe1232def67e858855", "name": "alice" },
						{ "team_member": "sub_9b74c9897bac770ffc029102a200c5de", "name": "bob" }
					],
					"only_if_unassigned": true,
					"status": "open"
				}
			}
		],
		"stopped_reason": "completed"
	}
}

Example error response:

{
	"error": 167,
	"errorMsg": "Flow execution [0f2d9c4e-7b1a-4e6d-8c3f-5a6b7c8d9e0f] not found"
}

SMS API

Smstools
Integrate our SMS Gateway by implementing our SMS API, and add text messaging to your platform in minutes. Free trial. SMS API
5 out of 5 based on 3302 user ratings.
SMSGATEWAYAPI API1

REGISTER NOW

Discover our SMS platform today!

REGISTER