curl --request GET \
--url https://api.widgetic.com/embed/workflows/{workflowId}import requests
url = "https://api.widgetic.com/embed/workflows/{workflowId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.widgetic.com/embed/workflows/{workflowId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.widgetic.com/embed/workflows/{workflowId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.widgetic.com/embed/workflows/{workflowId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.widgetic.com/embed/workflows/{workflowId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.widgetic.com/embed/workflows/{workflowId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "Example status",
"versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"versionNumber": 42,
"publishedAt": "2026-01-15T09:30:00.000Z",
"startCompositionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"timezone": "Example timezone",
"graph": null,
"translations": {},
"eventToken": "Example eventToken"
},
"meta": {
"page": 1,
"size": 20,
"total": 135,
"limit": 20,
"offset": 0,
"hasNextPage": true,
"hasPreviousPage": false,
"nextCursor": "<string>",
"warnings": [
"<string>"
]
}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}Read the published Workflow of an embed
Public read of a workflow for the embed that carries workflow-id. No API key. The answer is the live version (its graph, the composition a new visitor starts on, the time zone, the languages its compositions can be shown in, and the token that lets the browser report counts), or status: paused with nothing else, in which case the embed shows only its first composition. A workflow that is a draft, archived or unknown answers 404, and the embed then behaves as a plain embed of its composition-id. So does a workflow whose owner is not being served (a plan that lapsed, a partner whose agreement is not in force): the answer is the one the compositions of that owner give.
Address. https://api.widgetic.com/embed/workflows/{workflowId}: the root of the API host, NOT under /v1. A client generated from this description for https://api.widgetic.com/v1 must be given the base address https://api.widgetic.com for the calls of the Public Embed tag.
The answer may be reused for a few seconds (Cache-Control: public, max-age=15), so a publish or a pause reaches visitors within moments. The graph is readable by anyone who has the workflow’s id: its rules run in the visitor’s browser, so a rule must never hold a secret.
curl --request GET \
--url https://api.widgetic.com/embed/workflows/{workflowId}import requests
url = "https://api.widgetic.com/embed/workflows/{workflowId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.widgetic.com/embed/workflows/{workflowId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.widgetic.com/embed/workflows/{workflowId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.widgetic.com/embed/workflows/{workflowId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.widgetic.com/embed/workflows/{workflowId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.widgetic.com/embed/workflows/{workflowId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "Example status",
"versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"versionNumber": 42,
"publishedAt": "2026-01-15T09:30:00.000Z",
"startCompositionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"timezone": "Example timezone",
"graph": null,
"translations": {},
"eventToken": "Example eventToken"
},
"meta": {
"page": 1,
"size": 20,
"total": 135,
"limit": 20,
"offset": 0,
"hasNextPage": true,
"hasPreviousPage": false,
"nextCursor": "<string>",
"warnings": [
"<string>"
]
}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}Path Parameters
Response
The live version, or the word paused
What a visitor's browser reads for a workflow. status is live with the published version, or paused
with nothing else: the embed then shows only its first composition.
Show child attributes
Show child attributes
{
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "Example status",
"versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"versionNumber": 42,
"publishedAt": "2026-01-15T09:30:00.000Z",
"startCompositionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"timezone": "Example timezone",
"graph": null,
"translations": {},
"eventToken": "Example eventToken"
}
Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.
Show child attributes
Show child attributes