---
title: "Call automations.get"
method: POST
path: "/api/v1/tools/automations.get"
tags: ["automations"]
---

# Call automations.get

`POST /api/v1/tools/automations.get`

## Request

- Base URL: `https://app.goosybear.ai`
- URL: `https://app.goosybear.ai/api/v1/tools/automations.get`
- Auth: HTTP bearer

'show me the steps of the welcome automation', 'what does the onboarding automation do right now?' — read one automation in this workspace, named by its board_id (automations.list gives each one), with the steps, edges and trigger of the version it runs: the switched-on version, or its newest draft when none is switched on. The steps come back exactly as stored, in the shape `automations.author` takes, and latest_version says whether a newer draft exists. It changes nothing. An automation of another workspace, or a board with no automation, answers not found. Not for listing every automation and its status — that is `automations.list`.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with `workspace_ambiguous` and lists the choices — offer them, never pick one.

## Headers

- `x-request-id` string

## Request body

- object
  - `board_id` string, uuid, required: The automation's board id, as `automations.list` returns it in board_id.
  - `workspace` string: Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

## Response `200`

The call was admitted and dispatched. `ok` says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

- union
  - object: The tool ran and answered.
    - `ok` true, required
    - `board_id` string, uuid, required
    - `definition_id` string, uuid, required: The automation's definition id, as `automations.list` returns it.
    - `name` string, required: The automation's name.
    - `version` object, nullable, required: One stored version of the automation.
      - `number` integer, required: The version number, as the automation's versions list shows it.
      - `is_live` boolean, required: True when this is the switched-on version; false when the automation has none switched on and this is its newest draft.
      - `status` string, required: The version's stored status.
      - `steps` unknown, required
      - `edges` unknown, required
      - `trigger` unknown, required
      - `review_gated` boolean, required: True when each run waits for a person's review before it acts.
      - `created_at` string, required: When this version was saved (ISO 8601).
    - `latest_version` integer, nullable, required: The newest version number, draft or live; when it is above version.number a newer draft exists. Null when no version is saved.
    - `workspace` string, required: The slug of the workspace this call ran in.
    - `working_in` object, required: Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.
      - `label` string, required: The chip words — e.g. "working in: Acme Main".
      - `note` string, required: Why this workspace — e.g. "your default", "this call only".
      - `workspace` string, required: The resolved workspace's slug.
      - `source` 'call-override' | 'key-pin' | 'stored-default' | 'sole-reachable', required: Which rung of the R7 precedence resolved the workspace.
  - ToolRefusal: A call that was admitted and dispatched, and did not succeed.
    - `ok` false, required
    - `code` string, required: The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code.
    - `message` string, required: A sentence a person can act on.
    - `workspaces` string[]: On a workspace refusal: the slugs this key may pass as `workspace`.
    - `issues` object[]: On `invalid_arguments`: which fields failed, and why.
      - `path` string, required
      - `message` string, required
    - `path` string: On an authoring refusal: where in your call's input it points, e.g. `steps.<key>.params.<field>`.
    - `fix` string: On an authoring refusal: the change to your call that would pass.
    - `instruction` string: On an authoring refusal: what to do next with it.

## Other responses

- `400`: The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran.
- `401`: No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space.
- `403`: The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which.
- `404`: No such tool. The body names no tool and is identical for every unrecognised name.
- `429`: Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`.

---

[API](https://skmtc.dev/goosybear/apis/goosy-bear-api.md) · [All operations](https://skmtc.dev/goosybear/apis/goosy-bear-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goosybear/apis/goosy-bear-api/revisions/bd8f793b36b5?raw)