Skip to main content
Manja / GitHub

Get a workflow

Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.

GET/repos/{owner}/{repo}/actions/workflows/{workflow_id}
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
owner string
required
repo string
required
workflow_id path
required

The ID of the workflow. You can also pass the workflow file name as a string.

Responses

application/json Workflow object

Response

badge_url string
required

Example: https://github.com/actions/setup-ruby/workflows/CI/badge.svg

created_at string<date-time>
required

Example: 2019-12-06T14:20:20.000Z

deleted_at string<date-time>
optional

Example: 2019-12-06T14:20:20.000Z

html_url string
required

Example: https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml

id integer
required

Example: 5

name string
required

Example: CI

node_id string
required

Example: MDg6V29ya2Zsb3cxMg==

path string
required

Example: ruby.yaml

state string
required

Example: active

Allowed: "active""deleted""disabled_fork""disabled_inactivity""disabled_manually"

updated_at string<date-time>
required

Example: 2019-12-06T14:20:20.000Z

url string
required

Example: https://api.github.com/repos/actions/setup-ruby/workflows/5