Workflows
Get workflow API
Retrieve a workflow with its draft metadata and every published version, including per-version campaign and outcome totals.
GET
/
workflows
/
{workflow_id}
cURL
curl --request GET \
--url https://api.bolna.ai/workflows/{workflow_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.bolna.ai/workflows/{workflow_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.bolna.ai/workflows/{workflow_id}', 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.bolna.ai/workflows/{workflow_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.bolna.ai/workflows/{workflow_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.bolna.ai/workflows/{workflow_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bolna.ai/workflows/{workflow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"workflow": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"latest_published_version": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"published": [
{
"version": 123,
"state": "draft",
"revision": 123,
"published_at": "2023-11-07T05:31:56Z",
"campaigns": 123,
"contacts": 123,
"success_count": 123,
"failure_count": 123,
"neutral_count": 123,
"terminal_count": 123
}
],
"settings": {
"webhook": {
"url": "https://hooks.example.com/bolna/workflow",
"headers": {
"X-Api-Key": "**********"
}
}
},
"draft": {
"version": 123,
"state": "draft",
"revision": 123,
"published_at": "2023-11-07T05:31:56Z",
"campaigns": 123,
"contacts": 123,
"success_count": 123,
"failure_count": 123,
"neutral_count": 123,
"terminal_count": 123
}
}{
"detail": {
"code": "revision_conflict",
"message": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique id of the workflow
Response
Workflow detail
Show child attributes
Show child attributes
Every published version, newest first, each with its campaign outcome totals.
Show child attributes
Show child attributes
The workflow's live settings. Header values are always returned as **********.
Show child attributes
Show child attributes
The current draft's metadata, or null if none exists.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl --request GET \
--url https://api.bolna.ai/workflows/{workflow_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.bolna.ai/workflows/{workflow_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.bolna.ai/workflows/{workflow_id}', 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.bolna.ai/workflows/{workflow_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.bolna.ai/workflows/{workflow_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.bolna.ai/workflows/{workflow_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bolna.ai/workflows/{workflow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"workflow": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"latest_published_version": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"published": [
{
"version": 123,
"state": "draft",
"revision": 123,
"published_at": "2023-11-07T05:31:56Z",
"campaigns": 123,
"contacts": 123,
"success_count": 123,
"failure_count": 123,
"neutral_count": 123,
"terminal_count": 123
}
],
"settings": {
"webhook": {
"url": "https://hooks.example.com/bolna/workflow",
"headers": {
"X-Api-Key": "**********"
}
}
},
"draft": {
"version": 123,
"state": "draft",
"revision": 123,
"published_at": "2023-11-07T05:31:56Z",
"campaigns": 123,
"contacts": 123,
"success_count": 123,
"failure_count": 123,
"neutral_count": 123,
"terminal_count": 123
}
}{
"detail": {
"code": "revision_conflict",
"message": "<string>"
}
}
