> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Get GitHub workflow

> Get one GitHub Actions workflow by ID or file name.

`github.getWorkflow` gets one workflow definition.

```ts automations/get-github-workflow.automation.ts theme={null}
import { automation } from "automate.ax"
import { github } from "automate.ax/github"

export default automation("Get deploy workflow", () => {
  const workflow = github.getWorkflow({
    owner: "SentsCo",
    repository: "automate.ax",
    workflowId: "deploy.yml",
  })
})
```

Provide `owner`, `repository`, and a numeric workflow ID or workflow file name. Returns the workflow's `id`, `name`, `path`, and `state`. Requires Actions read permission.