Sample - GitHub REST API
GET/repos/{owner}/{repo}/actions/workflows/{workflow_id}

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.

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

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
workflow_idintegerrequired
The ID of the workflow. You can also pass the workflow file name as a string.

1 status code
200Response
idintegerrequired
node_idstringrequired
namestringrequired
pathstringrequired
statestringrequired
Allowed:activedeleteddisabled_forkdisabled_inactivitydisabled_manually
created_atstringrequired
updated_atstringrequired
urlstringrequired
html_urlstringrequired
badge_urlstringrequired
deleted_atstringoptional