List automations

Returns all configured automation definitions.

GET /api/v1/automations

List automations

cURL

curl --request GET \
  --url https://api.example.com/api/v1/automations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/v1/automations"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/automations', 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.example.com/api/v1/automations",
  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.example.com/api/v1/automations"

	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.example.com/api/v1/automations")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/automations")

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

200

{
  "data": [
    {
      "id": "nightly-deps",
      "revision": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
      "name": "Nightly dependency update",
      "description": "Keeps dependencies fresh.",
      "target": {
        "repository": "fabro-sh/fabro",
        "ref": "main",
        "workflow": "dependency-update"
      },
      "triggers": [
        {
          "id": "manual",
          "type": "api",
          "enabled": true
        }
      ]
    }
  ],
  "meta": {
    "total": 1
  }
}

Query Structure

query($filter: AutomationFilterType) {
  automations {
    all(filter: $filter) {
      edges {
        node {
          id
          name
          resource_name
          event
          enabled
          integration_id
          created_at
        }
      }
    }
  }
}

Filter Argument

All filters are passed inside the filter argument. Each field accepts an input object with operators.

Available Filters

Filter	Input Type	Operators	Description
name	StringInputType	eq, ilike, like, in, between	Automation name
resource_name	ResourceNameInputType	eq	Triggering resource (e.g. goods_out)
event	EventInputType	eq	Triggering event (e.g. completed)
enabled	BooleanInputType	eq	Active status
integration_id	IdInputType	eq, in, filled	Linked integration
created_at	DatetimeInputType	eq, from, to, between	Creation time

More fields and filters available via GraphQL introspection.

Authorizations

BearerAuthSessionCookie

Authorization · string · header · required

Raw dev token passed as Authorization: Bearer fabro_dev_... when server.auth.methods includes dev-token.

Response

200 - application/json

Automation definitions

List envelope for automation definitions.

data · object[] · required

Show child attributes

meta · object · required

Metadata for automation list responses.

Show child attributes