Skip to main content

List workflow runs

List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#parameters). 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.

GET/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs
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.

Query Parameters
actor string
optional

Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.

branch string
optional

Returns workflow runs associated with a branch. Use the name of the branch of the `push`.

event string
optional

Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)."

status string
optional

Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/[email protected]/rest/reference/checks#create-a-check-run)."

per_page integer
optional

Results per page (max 100)

page integer
optional

Page number of the results to fetch.

created string<date-time>
optional

Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/[email protected]/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."

exclude_pull_requests boolean
optional

If `true` pull requests are omitted from the response (empty array).

Responses

application/json object

Response

Headers
Link string
Example:
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"
total_count integer
required
workflow_runs array[Workflow Run object]
required
items Workflow Run object

An invocation of a workflow

artifacts_url string
required

The URL to the artifacts for the workflow run.

Example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts

cancel_url string
required

The URL to cancel the workflow run.

Example: https://api.github.com/repos/github/hello-world/actions/runs/5/cancel

check_suite_id integer
optional

The ID of the associated check suite.

Example: 42

check_suite_node_id string
optional

The node ID of the associated check suite.

Example: MDEwOkNoZWNrU3VpdGU0Mg==

check_suite_url string
required

The URL to the associated check suite.

Example: https://api.github.com/repos/github/hello-world/check-suites/12

conclusion string
requirednullable

Example: neutral

created_at string<date-time>
required
event string
required

Example: push

head_branch string
requirednullable

Example: master

head_commit Simple Commit object
requirednullable

Simple Commit

author object
requirednullable
committer object
requirednullable
id string
required
message string
required
timestamp string<date-time>
required
tree_id string
required
head_repository Minimal Repository object
required

Minimal Repository

allow_forking boolean
optional
archive_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}

archived boolean
optional
assignees_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}

blobs_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}

branches_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}

clone_url string
optional
code_of_conduct Code Of Conduct object
optional

Code Of Conduct

collaborators_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}

comments_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/comments{/number}

commits_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}

compare_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}

contents_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}

contributors_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/contributors

created_at string<date-time>
optionalnullable

Example: 2011-01-26T19:01:12Z

default_branch string
optional
delete_branch_on_merge boolean
optional
deployments_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/deployments

description string
requirednullable

Example: This your first repo!

disabled boolean
optional
downloads_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/downloads

events_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/events

fork boolean
required
forks integer
optional

Example: 0

forks_count integer
optional
forks_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/forks

full_name string
required

Example: octocat/Hello-World

git_commits_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}

git_refs_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}

git_tags_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}

git_url string
optional
has_downloads boolean
optional
has_issues boolean
optional
has_pages boolean
optional
has_projects boolean
optional
has_wiki boolean
optional
homepage string
optionalnullable
hooks_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/hooks

html_url string<uri>
required

Example: https://github.com/octocat/Hello-World

id integer
required

Example: 1296269

is_template boolean
optional
issue_comment_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}

issue_events_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number}

issues_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/issues{/number}

keys_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}

labels_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/labels{/name}

language string
optionalnullable
languages_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/languages

license object
optionalnullable
merges_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/merges

milestones_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/milestones{/number}

mirror_url string
optionalnullable
name string
required

Example: Hello-World

network_count integer
optional
node_id string
required

Example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5

notifications_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}

open_issues integer
optional

Example: 0

open_issues_count integer
optional
owner Simple User object
required

Simple User

permissions object
optional
private boolean
required
pulls_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}

pushed_at string<date-time>
optionalnullable

Example: 2011-01-26T19:06:43Z

releases_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/releases{/id}

size integer
optional
ssh_url string
optional
stargazers_count integer
optional
stargazers_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/stargazers

statuses_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}

subscribers_count integer
optional
subscribers_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/subscribers

subscription_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/subscription

svn_url string
optional
tags_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/tags

teams_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/teams

temp_clone_token string
optional
template_repository Repository object
optionalnullable

A git repository

topics array
optional
trees_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}

updated_at string<date-time>
optionalnullable

Example: 2011-01-26T19:14:43Z

url string<uri>
required

Example: https://api.github.com/repos/octocat/Hello-World

visibility string
optional
watchers integer
optional

Example: 0

watchers_count integer
optional
head_repository_id integer
optional

Example: 5

head_sha string
required

The SHA of the head commit that points to the version of the workflow being run.

Example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

html_url string
required

Example: https://github.com/github/hello-world/suites/4

id integer
required

The ID of the workflow run.

Example: 5

jobs_url string
required

The URL to the jobs for the workflow run.

Example: https://api.github.com/repos/github/hello-world/actions/runs/5/jobs

logs_url string
required

The URL to download the logs for the workflow run.

Example: https://api.github.com/repos/github/hello-world/actions/runs/5/logs

name string
optionalnullable

The name of the workflow run.

Example: Build

node_id string
required

Example: MDEwOkNoZWNrU3VpdGU1

previous_attempt_url string
optionalnullable

The URL to the previous attempted run of this workflow, if one exists.

Example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3

pull_requests array[Pull Request Minimal object]
requirednullable
repository Minimal Repository object
required

Minimal Repository

allow_forking boolean
optional
archive_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}

archived boolean
optional
assignees_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}

blobs_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}

branches_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}

clone_url string
optional
code_of_conduct Code Of Conduct object
optional

Code Of Conduct

collaborators_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}

comments_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/comments{/number}

commits_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}

compare_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}

contents_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}

contributors_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/contributors

created_at string<date-time>
optionalnullable

Example: 2011-01-26T19:01:12Z

default_branch string
optional
delete_branch_on_merge boolean
optional
deployments_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/deployments

description string
requirednullable

Example: This your first repo!

disabled boolean
optional
downloads_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/downloads

events_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/events

fork boolean
required
forks integer
optional

Example: 0

forks_count integer
optional
forks_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/forks

full_name string
required

Example: octocat/Hello-World

git_commits_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}

git_refs_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}

git_tags_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}

git_url string
optional
has_downloads boolean
optional
has_issues boolean
optional
has_pages boolean
optional
has_projects boolean
optional
has_wiki boolean
optional
homepage string
optionalnullable
hooks_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/hooks

html_url string<uri>
required

Example: https://github.com/octocat/Hello-World

id integer
required

Example: 1296269

is_template boolean
optional
issue_comment_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}

issue_events_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number}

issues_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/issues{/number}

keys_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}

labels_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/labels{/name}

language string
optionalnullable
languages_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/languages

license object
optionalnullable
merges_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/merges

milestones_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/milestones{/number}

mirror_url string
optionalnullable
name string
required

Example: Hello-World

network_count integer
optional
node_id string
required

Example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5

notifications_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}

open_issues integer
optional

Example: 0

open_issues_count integer
optional
owner Simple User object
required

Simple User

permissions object
optional
private boolean
required
pulls_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}

pushed_at string<date-time>
optionalnullable

Example: 2011-01-26T19:06:43Z

releases_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/releases{/id}

size integer
optional
ssh_url string
optional
stargazers_count integer
optional
stargazers_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/stargazers

statuses_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}

subscribers_count integer
optional
subscribers_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/subscribers

subscription_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/subscription

svn_url string
optional
tags_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/tags

teams_url string<uri>
required

Example: http://api.github.com/repos/octocat/Hello-World/teams

temp_clone_token string
optional
template_repository Repository object
optionalnullable

A git repository

topics array
optional
trees_url string
required

Example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}

updated_at string<date-time>
optionalnullable

Example: 2011-01-26T19:14:43Z

url string<uri>
required

Example: https://api.github.com/repos/octocat/Hello-World

visibility string
optional
watchers integer
optional

Example: 0

watchers_count integer
optional
rerun_url string
required

The URL to rerun the workflow run.

Example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun

run_attempt integer
optional

Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.

Example: 1

run_number integer
required

The auto incrementing run number for the workflow run.

Example: 106

run_started_at string<date-time>
optional

The start time of the latest run. Resets on re-run.

status string
requirednullable

Example: completed

updated_at string<date-time>
required
url string
required

The URL to the workflow run.

Example: https://api.github.com/repos/github/hello-world/actions/runs/5

workflow_id integer
required

The ID of the parent workflow.

Example: 5

workflow_url string
required

The URL to the workflow.

Example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml