Skip to main content
GET
/
api
/
v2
/
workflows
/
run
/
status
Get Workflow Run Status
curl --request GET \
  --url https://app.octavehq.com/api/v2/workflows/run/status \
  --header 'api_key: <api-key>'
import requests

url = "https://app.octavehq.com/api/v2/workflows/run/status"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://app.octavehq.com/api/v2/workflows/run/status', 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://app.octavehq.com/api/v2/workflows/run/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$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://app.octavehq.com/api/v2/workflows/run/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.octavehq.com/api/v2/workflows/run/status")
  .header("api_key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/workflows/run/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "jobOId": "<string>",
    "totalCount": 123,
    "processedCount": 123,
    "successCount": 123,
    "failedCount": 123,
    "startedAt": "<string>",
    "completedAt": "<string>",
    "createdAt": "<string>",
    "workflowOId": "<string>",
    "callbackUrl": "<string>",
    "circuitBreakerReason": "<string>"
  }
}
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "message": "<string>"
}
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "message": "<string>"
}

Authorizations

api_key
string
header
required

Query Parameters

jobOId
string
required

The OId of the workflow run job to check status for

Minimum string length: 1
Example:

"bsjob_3rgkoHhR00cEdE9DjKeIK"

Response

Workflow run status

_metadata
object
required
data
object
required