List Automations

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

import requests

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

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

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

fetch('https://api.checkfu.com/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.checkfu.com/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>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/automations"

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "workspace_id": "<string>",
      "version": 1,
      "name": "<string>",
      "description": "<string>",
      "external_id": "<string>",
      "created_by": "<string>",
      "identity": {
        "acted_as": "<string>"
      },
      "connected_runtime": "<string>",
      "status": "active",
      "paused_reason": {
        "kind": "manual",
        "error_type": "<unknown>"
      },
      "last_run_at": "<string>",
      "last_session_id": "<string>",
      "last_run_id": "<string>",
      "next_run_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "target": {
        "kind": "agent_definition",
        "agent_deployment_id": "<string>",
        "agent_deployment_revision_selection": {
          "type": "current"
        },
        "budget": {
          "limit": 1,
          "metric": "model_tokens"
        }
      },
      "surface_scope_id": "<string>",
      "trigger": {
        "kind": "schedule",
        "cron": "<string>",
        "timezone": "<string>",
        "dedupe_key": "<unknown>",
        "source": "<unknown>",
        "filter": "<unknown>"
      },
      "input": {
        "kind": "snapshot",
        "prompt": "<string>",
        "outcome": {
          "rubric": "<string>",
          "max_iterations": 10,
          "deliverables": [
            "<string>"
          ],
          "report": {
            "extraction": "json",
            "outputs": [
              {
                "key": "<string>",
                "title": "<string>",
                "type": "string",
                "description": "<string>",
                "acceptance": {
                  "kind": "one_of",
                  "values": [
                    "<string>"
                  ]
                }
              }
            ]
          }
        },
        "flow_review": {
          "model_routing_profile_key": "<string>",
          "criteria": [
            {
              "key": "<string>",
              "description": "<string>",
              "severity": "low"
            }
          ],
          "tier": "default"
        },
        "mounts": [
          {
            "kind": "project",
            "project_id": "<string>",
            "mount_path": "<string>",
            "revision_policy": {
              "kind": "latest"
            },
            "access": "read_only",
            "writeback": null
          }
        ],
        "prompt_template": "<unknown>"
      },
      "metadata": {}
    }
  ],
  "next_page": "<string>"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

List Automations

List Automations in the selected Workspace, filterable by agent_deployment_id (the AgentDeployment an agent-target Automation’s Sessions admit against; non-agent targets never match), principal, surface_scope, trigger kind (schedule, webhook, or subscription), and status (active or paused). Pass external_id for an exact lookup of the Automation holding that caller-chosen key through the workspace’s unique index; that form returns zero or one Automation, honors page, and always returns next_page: null, and it composes with the other filters — a keyed Automation failing one of them is absent rather than returned anyway. Rows carry scheduler-owned state — last Session and Run, last Dream, and the persisted next_run_at — but never the ingest secret or the encrypted input.

Checkfu support posture: alpha; hosted. Required evidence journey: automation-firing. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.

GET

automations

List Automations

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

import requests

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

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

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

fetch('https://api.checkfu.com/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.checkfu.com/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>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/automations"

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "workspace_id": "<string>",
      "version": 1,
      "name": "<string>",
      "description": "<string>",
      "external_id": "<string>",
      "created_by": "<string>",
      "identity": {
        "acted_as": "<string>"
      },
      "connected_runtime": "<string>",
      "status": "active",
      "paused_reason": {
        "kind": "manual",
        "error_type": "<unknown>"
      },
      "last_run_at": "<string>",
      "last_session_id": "<string>",
      "last_run_id": "<string>",
      "next_run_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "target": {
        "kind": "agent_definition",
        "agent_deployment_id": "<string>",
        "agent_deployment_revision_selection": {
          "type": "current"
        },
        "budget": {
          "limit": 1,
          "metric": "model_tokens"
        }
      },
      "surface_scope_id": "<string>",
      "trigger": {
        "kind": "schedule",
        "cron": "<string>",
        "timezone": "<string>",
        "dedupe_key": "<unknown>",
        "source": "<unknown>",
        "filter": "<unknown>"
      },
      "input": {
        "kind": "snapshot",
        "prompt": "<string>",
        "outcome": {
          "rubric": "<string>",
          "max_iterations": 10,
          "deliverables": [
            "<string>"
          ],
          "report": {
            "extraction": "json",
            "outputs": [
              {
                "key": "<string>",
                "title": "<string>",
                "type": "string",
                "description": "<string>",
                "acceptance": {
                  "kind": "one_of",
                  "values": [
                    "<string>"
                  ]
                }
              }
            ]
          }
        },
        "flow_review": {
          "model_routing_profile_key": "<string>",
          "criteria": [
            {
              "key": "<string>",
              "description": "<string>",
              "severity": "low"
            }
          ],
          "tier": "default"
        },
        "mounts": [
          {
            "kind": "project",
            "project_id": "<string>",
            "mount_path": "<string>",
            "revision_policy": {
              "kind": "latest"
            },
            "access": "read_only",
            "writeback": null
          }
        ],
        "prompt_template": "<unknown>"
      },
      "metadata": {}
    }
  ],
  "next_page": "<string>"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-24

Query Parameters

limit

integer

Required range: x >= 1

page

string

Pattern: ^c1_[0-9a-z]+$

order

enum<string>

Available options:

asc,

desc

agent_deployment_id

string

Pattern: ^adep_[0-9a-f]{32}$

principal

string

Pattern: ^prin_[0-9a-f]{32}$

surface_scope

string

Pattern: ^surf_[0-9a-f]{32}$

kind

enum<string>

Available options:

schedule,

webhook,

subscription

status

enum<string>

Available options:

active,

paused

external_id

string

Pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$

Response

Success

data

object[]

required

Show child attributes

next_page

string | null

required

Developer tools

Canonical tables

Author protocols

Generated HTTP API

List Automations

Authorizations

Headers

Query Parameters

Response