listWorkflowRuns.md

name	example	route	scope	type
List workflow runs for a workflow	octokit.rest.actions.listWorkflowRuns({ owner, repo, workflow_id })	GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs	actions	API method

List workflow runs for a workflow

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.

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.

octokit.rest.actions.listWorkflowRuns({
  owner,
  repo,
  workflow_id,
});

Parameters

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 .git extension. The name is not case sensitive.
workflow_id	yes	The ID of the workflow. You can also pass the workflow file name as a string.
actor	no	Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.
branch	no	Returns workflow runs associated with a branch. Use the name of the branch of the push.
event	no	Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows."
status	no	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 Actions can set a status of waiting, pending, or requested.
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 true pull requests are omitted from the response (empty array).
check_suite_id	no	Returns workflow runs with the check_suite_id that you specify.
head_sha	no	Only returns workflow runs that are associated with the specified head_sha.

See also: GitHub Developer Guide documentation.