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.
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs- Source
github-v3-rest.json- Revision
f5f067c1e6f6- Active snapshot
85e53e3d0d65
Request
Path Parameters
- owner stringrequired
- repo stringrequired
- workflow_id pathrequired
The ID of the workflow. You can also pass the workflow file name as a string.
Query Parameters
- actor stringoptional
Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.
- branch stringoptional
Returns workflow runs associated with a branch. Use the name of the branch of the `push`.
- event stringoptional
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 stringoptional
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 integeroptional
Results per page (max 100)
- page integeroptional
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 booleanoptional
If `true` pull requests are omitted from the response (empty array).
Responses
Response
Headers
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last" workflow_runs array[Workflow Run object]required
items Workflow Run objectAn invocation of a workflow
An invocation of a workflow
The URL to the artifacts for the workflow run.
Example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts
The URL to cancel the workflow run.
Example: https://api.github.com/repos/github/hello-world/actions/runs/5/cancel
The ID of the associated check suite.
Example: 42
The node ID of the associated check suite.
Example: MDEwOkNoZWNrU3VpdGU0Mg==
The URL to the associated check suite.
Example: https://api.github.com/repos/github/hello-world/check-suites/12
Example: neutral
Example: push
Example: master
head_commit Simple Commit objectrequirednullable Simple Commit
Simple Commit
head_repository Minimal Repository objectrequiredMinimal Repository
Minimal Repository
Example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
Example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
Example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
Example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
Code Of Conduct
Example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
Example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
Example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
Example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
Example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
Example: http://api.github.com/repos/octocat/Hello-World/contributors
Example: 2011-01-26T19:01:12Z
Example: http://api.github.com/repos/octocat/Hello-World/deployments
Example: This your first repo!
Example: http://api.github.com/repos/octocat/Hello-World/downloads
Example: http://api.github.com/repos/octocat/Hello-World/events
Example: 0
Example: http://api.github.com/repos/octocat/Hello-World/forks
Example: octocat/Hello-World
Example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
Example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
Example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
Example: http://api.github.com/repos/octocat/Hello-World/hooks
Example: https://github.com/octocat/Hello-World
Example: 1296269
Example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
Example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
Example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
Example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
Example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
Example: http://api.github.com/repos/octocat/Hello-World/languages
Example: http://api.github.com/repos/octocat/Hello-World/merges
Example: http://api.github.com/repos/octocat/Hello-World/milestones{/number}
Example: Hello-World
Example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
Example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
Example: 0
Simple User
Example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
Example: 2011-01-26T19:06:43Z
Example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
Example: http://api.github.com/repos/octocat/Hello-World/stargazers
Example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
Example: http://api.github.com/repos/octocat/Hello-World/subscribers
Example: http://api.github.com/repos/octocat/Hello-World/subscription
Example: http://api.github.com/repos/octocat/Hello-World/tags
Example: http://api.github.com/repos/octocat/Hello-World/teams
A git repository
Example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
Example: 2011-01-26T19:14:43Z
Example: https://api.github.com/repos/octocat/Hello-World
Example: 0
Example: 5
The SHA of the head commit that points to the version of the workflow being run.
Example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
Example: https://github.com/github/hello-world/suites/4
The ID of the workflow run.
Example: 5
The URL to the jobs for the workflow run.
Example: https://api.github.com/repos/github/hello-world/actions/runs/5/jobs
The URL to download the logs for the workflow run.
Example: https://api.github.com/repos/github/hello-world/actions/runs/5/logs
The name of the workflow run.
Example: Build
Example: MDEwOkNoZWNrU3VpdGU1
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
repository Minimal Repository objectrequiredMinimal Repository
Minimal Repository
Example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
Example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
Example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
Example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
Code Of Conduct
Example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
Example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
Example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
Example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
Example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
Example: http://api.github.com/repos/octocat/Hello-World/contributors
Example: 2011-01-26T19:01:12Z
Example: http://api.github.com/repos/octocat/Hello-World/deployments
Example: This your first repo!
Example: http://api.github.com/repos/octocat/Hello-World/downloads
Example: http://api.github.com/repos/octocat/Hello-World/events
Example: 0
Example: http://api.github.com/repos/octocat/Hello-World/forks
Example: octocat/Hello-World
Example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
Example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
Example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
Example: http://api.github.com/repos/octocat/Hello-World/hooks
Example: https://github.com/octocat/Hello-World
Example: 1296269
Example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
Example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
Example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
Example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
Example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
Example: http://api.github.com/repos/octocat/Hello-World/languages
Example: http://api.github.com/repos/octocat/Hello-World/merges
Example: http://api.github.com/repos/octocat/Hello-World/milestones{/number}
Example: Hello-World
Example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
Example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
Example: 0
Simple User
Example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
Example: 2011-01-26T19:06:43Z
Example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
Example: http://api.github.com/repos/octocat/Hello-World/stargazers
Example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
Example: http://api.github.com/repos/octocat/Hello-World/subscribers
Example: http://api.github.com/repos/octocat/Hello-World/subscription
Example: http://api.github.com/repos/octocat/Hello-World/tags
Example: http://api.github.com/repos/octocat/Hello-World/teams
A git repository
Example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
Example: 2011-01-26T19:14:43Z
Example: https://api.github.com/repos/octocat/Hello-World
Example: 0
The URL to rerun the workflow run.
Example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun
Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.
Example: 1
The auto incrementing run number for the workflow run.
Example: 106
The start time of the latest run. Resets on re-run.
Example: completed
The URL to the workflow run.
Example: https://api.github.com/repos/github/hello-world/actions/runs/5
The ID of the parent workflow.
Example: 5
The URL to the workflow.
Example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml