Skip to main content
GET
/
api
/
workflow
/
user
/
workflows
List workflows for the current user
curl --request GET \
  --url https://app.herondata.io/api/workflow/user/workflows \
  --header 'x-api-key: <api-key>'
import requests

url = "https://app.herondata.io/api/workflow/user/workflows"

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

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

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

fetch('https://app.herondata.io/api/workflow/user/workflows', 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.herondata.io/api/workflow/user/workflows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-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.herondata.io/api/workflow/user/workflows"

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

req.Header.Add("x-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.herondata.io/api/workflow/user/workflows")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/workflow/user/workflows")

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

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

response = http.request(request)
puts response.read_body
[
  {
    "alerts_muted_until": "2023-11-07T05:31:56Z",
    "dashboard_trigger_enabled": true,
    "dashboard_trigger_label": "<string>",
    "heron_id": "<string>",
    "is_default": true,
    "name": "<string>",
    "owners": {
      "group_slack_name": [
        "<string>"
      ],
      "user_email": [
        "[email protected]"
      ]
    }
  }
]

Authorizations

x-api-key
string
header
required

Response

200 - application/json

List of workflows

alerts_muted_until
string<date-time> | null
read-only
dashboard_trigger_enabled
boolean
read-only
dashboard_trigger_label
string | null
read-only
heron_id
string
read-only
is_default
boolean
read-only
name
string
read-only
owners
object