Skip to content
forgit api docs

Get a workflow

GET
/repos/{owner}/{repo}/actions/workflows/{workflow_id}

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.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

The account owner of the repository. The name is not case sensitive.

repo
required
string

The name of the repository without the .git extension. The name is not case sensitive.

workflow_id
required
One of:
integer

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

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Workflow

A GitHub Actions workflow

object
id
required
integer
node_id
required
string
name
required
string
path
required
string
state
required
string
Allowed values: active deleted disabled_fork disabled_inactivity disabled_manually
created_at
required
string format: date-time
updated_at
required
string format: date-time
url
required
string
html_url
required
string
badge_url
required
string
deleted_at
string format: date-time
Examples
Example default 
{
  "id": 161335,
  "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
  "name": "CI",
  "path": ".github/workflows/blank.yaml",
  "state": "active",
  "created_at": "2020-01-08T23:48:37.000-08:00",
  "updated_at": "2020-01-08T23:50:21.000-08:00",
  "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335",
  "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
  "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg"
}