name | example | route | scope | type |
---|---|---|---|---|
List workflow runs for a repository |
octokit.rest.actions.listWorkflowRunsForRepo({ owner, repo }) |
GET /repos/{owner}/{repo}/actions/runs |
actions |
API method |
Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
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.
This API will return up to 1,000 results for each search when using the following parameters: actor
, branch
, check_suite_id
, created
, event
, head_sha
, status
.
octokit.rest.actions.listWorkflowRunsForRepo({
owner,
repo,
});
name | required | description |
---|---|---|
owner | yes |
The account owner of the repository. The name is not case sensitive. |
repo | yes |
The name of the repository without the |
actor | no |
Returns someone's workflow runs. Use the login for the user who created the |
branch | no |
Returns workflow runs associated with a branch. Use the name of the branch of the |
event | no |
Returns workflow run triggered by the event you specify. For example, |
status | no |
Returns workflow runs with the check run |
per_page | no |
The number of results per page (max 100). For more information, see "Using pagination in the REST API." |
page | no |
The page number of the results to fetch. For more information, see "Using pagination in the REST API." |
created | no |
Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax." |
exclude_pull_requests | no |
If |
check_suite_id | no |
Returns workflow runs with the |
head_sha | no |
Only returns workflow runs that are associated with the specified |
See also: GitHub Developer Guide documentation.