Retrieve a Workflow
Please note archived Workflows are NOT returned.
GET
/
v1
/
workflows
/
{uid}
Retrieve a Workflow
curl --request GET \
--url https://api.siit.io/v1/workflows/{uid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.siit.io/v1/workflows/{uid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.siit.io/v1/workflows/{uid}', 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.siit.io/v1/workflows/{uid}",
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.siit.io/v1/workflows/{uid}"
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.siit.io/v1/workflows/{uid}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siit.io/v1/workflows/{uid}")
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{
"uid": "<string>",
"author": "<string>",
"author_uid": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"executed_count": 0,
"name": "<string>",
"status": "draft",
"trigger_name": "app_access.created",
"trigger_type": "app_access",
"updated_at": "2023-11-07T05:31:56Z",
"manifest": {}
}{
"error": "<string>",
"troubleshoot": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The UID of the Workflow
Response
Workflow show
The UID of the Workflow
The user who created the workflow. Pass ?expand[]=field_name for full object.
DEPRECATED: Use author instead. The UID of the author.
datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")
Workflow's executions count.
The Workflow name
The status of the Workflow
Available options:
draft, live, paused, archived Available options:
app_access.created, app_access.status_changed, date.date, request.submitted, request.resolved, request.in_progress, request.waiting, request.reopened, request.snoozed, request.snooze_expired, request.admin_replied, request.user_replied, request.user_unresponsive, request.tag_added, request.sla_breached, request.admin_unresponsive, user.birthday_date, user.work_anniversary, user.job_start_date, user.job_leave_date, user.probation_end_date, user.last_working_date The type of Workflow trigger
Available options:
app_access, date, request, user datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")
The Workflow manifest, describing its trigger and branches. Its exact shape is published as a JSON Schema at GET /v1/workflows/manifest_schema. Conditions on a custom form input carry two read-only bookkeeping keys, pinned_version and valid, recording which version of that input the condition was last checked against and whether it still holds. The manifest can be sent back verbatim: both keys are re-derived on write, never read from the payload.
Retrieve a Workflow
curl --request GET \
--url https://api.siit.io/v1/workflows/{uid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.siit.io/v1/workflows/{uid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.siit.io/v1/workflows/{uid}', 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.siit.io/v1/workflows/{uid}",
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.siit.io/v1/workflows/{uid}"
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.siit.io/v1/workflows/{uid}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siit.io/v1/workflows/{uid}")
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{
"uid": "<string>",
"author": "<string>",
"author_uid": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"executed_count": 0,
"name": "<string>",
"status": "draft",
"trigger_name": "app_access.created",
"trigger_type": "app_access",
"updated_at": "2023-11-07T05:31:56Z",
"manifest": {}
}{
"error": "<string>",
"troubleshoot": "<string>"
}