curl --request GET \
--url https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs', 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.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs",
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.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs"
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.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs")
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_jobs": [
{
"id": [
"e75e68e192e6fc04ea3940d302d7bec5"
],
"name": [
"Sample Workflow Job Name"
],
"workflow_id": [
"e3c908ad-dc8f-4edb-88f7-c84dec0aef99"
],
"workflow_name": [
"MyWorkflow"
],
"progress": [
90
],
"state": [
"in-process",
"succeeded",
"failed"
],
"workflow_version": "<string>",
"created_at": [
"2020-01-21T15:53:12.388317Z"
],
"updated_at": [
"2020-01-22T15:53:12.182617Z"
],
"elapsed_time": [
"136.08:01:23.5",
"1:23:45"
]
}
],
"next_page_token": "eyJ2IjoxLCJrIjoiam9iIn0"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"errors": [
{
"pointer": "/max_results",
"type": "invalid_value",
"detail": "max_results must be between 1 and 100."
}
],
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"errors": [
{
"pointer": "/max_results",
"type": "invalid_value",
"detail": "max_results must be between 1 and 100."
}
],
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}Returns a list of jobs associated with the specified workflow.
When a status or query filter is supplied, a page may contain fewer than max_results entries even when further pages exist; clients must continue paging while next_page_token is present rather than keying off the number of returned entries.
curl --request GET \
--url https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs', 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.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs",
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.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs"
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.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.up.telestream.com/workflow/v1/{space_id}/workflows/{workflow_id}/jobs")
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_jobs": [
{
"id": [
"e75e68e192e6fc04ea3940d302d7bec5"
],
"name": [
"Sample Workflow Job Name"
],
"workflow_id": [
"e3c908ad-dc8f-4edb-88f7-c84dec0aef99"
],
"workflow_name": [
"MyWorkflow"
],
"progress": [
90
],
"state": [
"in-process",
"succeeded",
"failed"
],
"workflow_version": "<string>",
"created_at": [
"2020-01-21T15:53:12.388317Z"
],
"updated_at": [
"2020-01-22T15:53:12.182617Z"
],
"elapsed_time": [
"136.08:01:23.5",
"1:23:45"
]
}
],
"next_page_token": "eyJ2IjoxLCJrIjoiam9iIn0"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"errors": [
{
"pointer": "/max_results",
"type": "invalid_value",
"detail": "max_results must be between 1 and 100."
}
],
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"errors": [
{
"pointer": "/max_results",
"type": "invalid_value",
"detail": "max_results must be between 1 and 100."
}
],
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}{
"title": "Not Found",
"status": 404,
"trace_id": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
"type": "about:blank",
"detail": "An unexpected error occurred",
"instance": "/workflow/v1/d290f1ee-6c54-4b01-90e6-d701748f0851/workflows"
}Authorizations
Static API key passed as a Bearer token in the Authorization header.
Each operation requires one of the scopes workflow:access,
workflow:workflow-management or workflow:admin (a hierarchy — admin implies
management implies access), declared per operation via the x-required-scope
extension. A key lacking the required scope receives 401 Unauthorized;
403 Forbidden indicates the organization's subscription is inactive.
Path Parameters
UP Space Id
"d290f1ee-6c54-4b01-90e6-d701748f0851"
Unique identifier of a Workflow
"e3c908ad-dc8f-4edb-88f7-c84dec0aef99"
Query Parameters
Opaque continuation token from a previous response's next_page_token; omit to fetch the first page
Maximum number of entries to return per page
1 <= x <= 100Filter WorkflowJobs by status
in-process, completed, created Filter jobs by query
