Text of docs.github.com › en › rest › actions › workflow-runs as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

REST API endpoints for workflow runs - GitHub Docs

Skip to main content Skip to content Collapse sidebar Expand sidebar The REST API is now versioned. For more information, see " About API versioning ." REST API endpoints for workflow runs Use the REST API to interact with workflow runs in GitHub Actions. About workflow runs in GitHub Actions You can use the REST API to view, re-run, cancel, and view logs for workflow runs in GitHub Actions. A workflow run is an instance of your workflow that runs when the pre-configured event occurs.

For more information, see Managing workflow runs . Re-run a job from a workflow run Re-run a job and its dependent jobs in a workflow run. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. Fine-grained access tokens for "Re-run a job from a workflow run" This endpoint works with the following fine-grained token types : GitHub App user access tokens GitHub App installation access tokens Fine-grained personal access tokens The fine-grained token must have the following permission set: "Actions" repository permissions (write) Parameters for "Re-run a job from a workflow run" Headers Name, Type, Description accept string Setting to application/vnd.github+json is recommended.

Path parameters Name, Type, Description owner string Required The account owner of the repository. The name is not case sensitive. repo string Required The name of the repository without the .git extension. The name is not case sensitive. job_id integer Required The unique identifier of the job. Body parameters Name, Type, Description enable_debug_logging boolean Whether to enable debug logging for the re-run. Default : false enable_debugger boolean Whether to enable the debugger for the re-run of this job.

Default : false HTTP response status codes for "Re-run a job from a workflow run" Status code Description 201 Created 403 Forbidden Code samples for "Re-run a job from a workflow run" Request example post /repos /{owner} /{repo} /actions /jobs /{job_ id} /rerun Copy to clipboard curl request example curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/repos/OWNER/REPO/actions/jobs/JOB_ID/rerun Response Status: 201 List workflow runs for a repository 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 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 .

Fine-grained access tokens for "List workflow runs for a repository" This endpoint works with the following fine-grained token types : GitHub App user access tokens GitHub App installation access tokens Fine-grained personal access tokens The fine-grained token must have the following permission set: "Actions" repository permissions (read) This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "List workflow runs for a repository" Headers Name, Type, Description accept string Setting to application/vnd.github+json is recommended. Path parameters Name, Type, Description owner string Required The account owner of the repository. The name is not case sensitive. repo string Required The name of the repository without the .git extension. The name is not case sensitive. Query parameters Name, Type, Description actor string 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 Returns workflow runs associated with a branch. Use the name of the branch of the push . event string 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 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 . Can be one of : completed , action_required , cancelled , failure , neutral , skipped , stale , success , timed_out , in_progress , queued , requested , waiting , pending per_page integer The number of results per page (max 100). For more information, see " Using pagination in the REST API ." Default : 30 page integer The page number of the results to fetch.

For more information, see " Using pagination in the REST API ." Default : 1 created string Returns workflow runs created within the given date-time range. For more information on the syntax, see " Understanding the search syntax ." exclude_pull_requests boolean If true pull requests are omitted from the response (empty array). Default : false check_suite_id integer Returns workflow runs with the check_suite_id that you specify. head_sha string Only returns workflow runs that are associated with the specified head_sha .

HTTP response status codes for "List workflow runs for a repository" Status code Description 200 OK 304 Not modified Code samples for "List workflow runs for a repository" Request example get /repos /{owner} /{repo} /actions /runs Copy to clipboard curl request example curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/repos/OWNER/REPO/actions/runs Response Status: 200 { "total_count": 1, "workflow_runs": [ { "id": 30433642, "name": "Build", "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", "check_suite_id": 42, "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", "head_branch": "master", "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", "path": ".github/workflows/build.yml@main", "run_number": 562, "event": "push", "display_title": "Update README.md", "status": "queued", "conclusion": null, "workflow_id": 159038, "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", "pull_requests": [], "created_at": "2020-01-22T19:33:08Z", "updated_at": "2020-01-22T19:33:08Z", "actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "run_attempt": 1, "run_started_at": "2020-01-22T19:33:08Z", "triggering_actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url"

The rest of this page is on the live site.