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

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 endpoint 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.

Servers

https://api.github.com

Path parameters

Name	Type	Required	Description
`repo`	String	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.
`owner`	String	Yes	The account owner of the repository. The name is not case sensitive.

Query parameters

Name	Type	Required	Description
`page`	Integer	No	The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default value: 1
`exclude_pull_requests`	Boolean	No	If `true` pull requests are omitted from the response (empty array). Default value: false
`head_sha`	String	No	Only returns workflow runs that are associated with the specified `head_sha`.
`created`	String	No	Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax."
`check_suite_id`	Integer	No	Returns workflow runs with the `check_suite_id` that you specify.
`per_page`	Integer	No	The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default value: 30
`branch`	String	No	Returns workflow runs associated with a branch. Use the name of the branch of the `push`.
`event`	String	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`	String	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`. Possible values: `"requested"` `"completed"` `"success"` `"waiting"` `"stale"` `"cancelled"` `"action_required"` `"skipped"` `"neutral"` `"in_progress"` `"queued"` `"failure"` `"pending"` `"timed_out"`
`actor`	String	No	Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.