List workflow runs for a required workflow

List all workflow runs for a required workflow. 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. If the repository is private you must use an access token with the repo scope. For more information, see "Required Workflows."

{ "total_count": 0, "workflow_runs": [ { "actor": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "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}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "artifacts_url": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts", "cancel_url": "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel", "check_suite_id": 42, "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", "check_suite_url": "https://api.github.com/repos/github/hello-world/check-suites/12", "conclusion": "neutral", "created_at": "2019-08-24T14:15:22Z", "display_title": "Simple Workflow", "event": "push", "head_branch": "master", "head_commit": { "author": { "email": "string", "name": "string" }, "committer": { "email": "string", "name": "string" }, "id": "string", "message": "string", "timestamp": "2019-08-24T14:15:22Z", "tree_id": "string" }, "head_repository": { "allow_forking": true, "archive_url": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "archived": true, "assignees_url": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}", "clone_url": "string", "code_of_conduct": { "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n", "html_url": "http://example.com", "key": "contributor_covenant", "name": "Contributor Covenant", "url": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "collaborators_url": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "http://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "http://api.github.com/repos/octocat/Hello-World/contributors", "created_at": "2011-01-26T19:01:12.000Z", "default_branch": "string", "delete_branch_on_merge": true, "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments", "description": "This your first repo!", "disabled": true, "downloads_url": "http://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "http://api.github.com/repos/octocat/Hello-World/events", "fork": true, "forks": 0, "forks_count": 0, "forks_url": "http://api.github.com/repos/octocat/Hello-World/forks", "full_name": "octocat/Hello-World", "git_commits_url": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "string", "has_discussions": true, "has_downloads": true, "has_issues": true, "has_pages": true, "has_projects": true, "has_wiki": true, "homepage": "string", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks", "html_url": "https://github.com/octocat/Hello-World", "id": 1296269, "is_template": true, "issue_comment_url": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "http://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "http://api.github.com/repos/octocat/Hello-World/labels{/name}", "language": "string", "languages_url": "http://api.github.com/repos/octocat/Hello-World/languages", "license": { "key": "string", "name": "string", "node_id": "string", "spdx_id": "string", "url": "string" }, "merges_url": "http://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}", "mirror_url": "string", "name": "Hello-World", "network_count": 0, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "notifications_url": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "open_issues": 0, "open_issues_count": 0, "owner": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "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}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "permissions": { "admin": true, "maintain": true, "pull": true, "push": true, "triage": true }, "private": true, "pulls_url": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}", "pushed_at": "2011-01-26T19:06:43.000Z", "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}", "role_name": "admin", "security_and_analysis": { "advanced_security": { "status": "enabled" }, "secret_scanning": { "status": "enabled" }, "secret_scanning_push_protection": { "status": "enabled" } }, "size": 0, "ssh_url": "string", "stargazers_count": 0, "stargazers_url": "http://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_count": 0, "subscribers_url": "http://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "http://api.github.com/repos/octocat/Hello-World/subscription", "svn_url": "string", "tags_url": "http://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "http://api.github.com/repos/octocat/Hello-World/teams", "temp_clone_token": "string", "topics": [ "string" ], "trees_url": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "updated_at": "2011-01-26T19:14:43.000Z", "url": "https://api.github.com/repos/octocat/Hello-World", "visibility": "string", "watchers": 0, "watchers_count": 0, "web_commit_signoff_required": false }, "head_repository_id": 5, "head_sha": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", "html_url": "https://github.com/github/hello-world/suites/4", "id": 5, "jobs_url": "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs", "logs_url": "https://api.github.com/repos/github/hello-world/actions/runs/5/logs", "name": "Build", "node_id": "MDEwOkNoZWNrU3VpdGU1", "path": "octocat/octo-repo/.github/workflows/ci.yml@main", "previous_attempt_url": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3", "pull_requests": [ { "base": { "ref": "string", "repo": { "id": 0, "name": "string", "url": "string" }, "sha": "string" }, "head": { "ref": "string", "repo": { "id": 0, "name": "string", "url": "string" }, "sha": "string" }, "id": 0, "number": 0, "url": "string" } ], "referenced_workflows": [ { "path": "string", "ref": "string", "sha": "string" } ], "repository": { "allow_forking": true, "archive_url": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "archived": true, "assignees_url": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}", "clone_url": "string", "code_of_conduct": { "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n", "html_url": "http://example.com", "key": "contributor_covenant", "name": "Contributor Covenant", "url": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "collaborators_url": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "http://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "http://api.github.com/repos/octocat/Hello-World/contributors", "created_at": "2011-01-26T19:01:12.000Z", "default_branch": "string", "delete_branch_on_merge": true, "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments", "description": "This your first repo!", "disabled": true, "downloads_url": "http://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "http://api.github.com/repos/octocat/Hello-World/events", "fork": true, "forks": 0, "forks_count": 0, "forks_url": "http://api.github.com/repos/octocat/Hello-World/forks", "full_name": "octocat/Hello-World", "git_commits_url": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "string", "has_discussions": true, "has_downloads": true, "has_issues": true, "has_pages": true, "has_projects": true, "has_wiki": true, "homepage": "string", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks", "html_url": "https://github.com/octocat/Hello-World", "id": 1296269, "is_template": true, "issue_comment_url": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "http://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "http://api.github.com/repos/octocat/Hello-World/labels{/name}", "language": "string", "languages_url": "http://api.github.com/repos/octocat/Hello-World/languages", "license": { "key": "string", "name": "string", "node_id": "string", "spdx_id": "string", "url": "string" }, "merges_url": "http://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}", "mirror_url": "string", "name": "Hello-World", "network_count": 0, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "notifications_url": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "open_issues": 0, "open_issues_count": 0, "owner": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "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}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "permissions": { "admin": true, "maintain": true, "pull": true, "push": true, "triage": true }, "private": true, "pulls_url": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}", "pushed_at": "2011-01-26T19:06:43.000Z", "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}", "role_name": "admin", "security_and_analysis": { "advanced_security": { "status": "enabled" }, "secret_scanning": { "status": "enabled" }, "secret_scanning_push_protection": { "status": "enabled" } }, "size": 0, "ssh_url": "string", "stargazers_count": 0, "stargazers_url": "http://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_count": 0, "subscribers_url": "http://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "http://api.github.com/repos/octocat/Hello-World/subscription", "svn_url": "string", "tags_url": "http://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "http://api.github.com/repos/octocat/Hello-World/teams", "temp_clone_token": "string", "topics": [ "string" ], "trees_url": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "updated_at": "2011-01-26T19:14:43.000Z", "url": "https://api.github.com/repos/octocat/Hello-World", "visibility": "string", "watchers": 0, "watchers_count": 0, "web_commit_signoff_required": false }, "rerun_url": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun", "run_attempt": 1, "run_number": 106, "run_started_at": "2019-08-24T14:15:22Z", "status": "completed", "triggering_actor": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "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}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "updated_at": "2019-08-24T14:15:22Z", "url": "https://api.github.com/repos/github/hello-world/actions/runs/5", "workflow_id": 5, "workflow_url": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" } ] }

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

required_workflow_id_for_repo

integer

required

The ID of the required workflow that has run at least once in a repository.

Query Params

actor

string

optional

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

optional

Returns workflow runs associated with a branch. Use the name of the branch of the push.

event

string

optional

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

optional

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.

per_page

integer

optional

The number of results per page (max 100).

page

integer

optional

Page number of the results to fetch.

created

string

optional

Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax."

exclude_pull_requests

string

optional

If true pull requests are omitted from the response (empty array).

check_suite_id

integer

optional

Returns workflow runs with the check_suite_id that you specify.

head_sha

string

optional

Only returns workflow runs that are associated with the specified head_sha.

Responses

🟢200Response

application/json

Body

total_count

integer

required

workflow_runs

array[object (Workflow Run) {36}]

required

actor

object (Simple User)

optional

A GitHub user.

artifacts_url

string

required

The URL to the artifacts for the workflow run.

Example:

https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts

cancel_url

string

required

The URL to cancel the workflow run.

Example:

https://api.github.com/repos/github/hello-world/actions/runs/5/cancel

check_suite_id

integer

optional

The ID of the associated check suite.

Example:

check_suite_node_id

string

optional

The node ID of the associated check suite.

Example:

MDEwOkNoZWNrU3VpdGU0Mg==

check_suite_url

string

required

The URL to the associated check suite.

Example:

https://api.github.com/repos/github/hello-world/check-suites/12

conclusion

string | null

required

Example:

neutral

created_at

string <date-time>

required

display_title

string

required

The event-specific title associated with the run or the run-name if set, or the value of run-name if it is set in the workflow.

Example:

Simple Workflow

event

string

required

Example:

push

head_branch

string | null

required

Example:

master

head_commit

object (Simple Commit) | null

required

A commit.

head_repository

object (Minimal Repository)

required

Minimal Repository

head_repository_id

integer

optional

Example:

head_sha

string

required

The SHA of the head commit that points to the version of the workflow being run.

Example:

009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

html_url

string

required

Example:

https://github.com/github/hello-world/suites/4

integer

required

The ID of the workflow run.

Example:

jobs_url

string

required

The URL to the jobs for the workflow run.

Example:

https://api.github.com/repos/github/hello-world/actions/runs/5/jobs

logs_url

string

required

The URL to download the logs for the workflow run.

Example:

https://api.github.com/repos/github/hello-world/actions/runs/5/logs

name

string | null

optional

The name of the workflow run.

Example:

Build

node_id

string

required

Example:

MDEwOkNoZWNrU3VpdGU1

path

string

required

The full path of the workflow

Example:

octocat/octo-repo/.github/workflows/ci.yml@main

previous_attempt_url

string | null

optional

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

pull_requests

array[object (Pull Request Minimal) {5}] | null

required

referenced_workflows

array[object (Referenced workflow) {3}] | null

optional

repository

object (Minimal Repository)

required

Minimal Repository

rerun_url

string

required

The URL to rerun the workflow run.

Example:

https://api.github.com/repos/github/hello-world/actions/runs/5/rerun

run_attempt

integer

optional

Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.

Example:

run_number

integer

required

The auto incrementing run number for the workflow run.

Example:

106

run_started_at

string <date-time>

optional

The start time of the latest run. Resets on re-run.

status

string | null

required

Example:

completed

triggering_actor

object (Simple User)

optional

A GitHub user.

updated_at

string <date-time>

required

url

string

required

The URL to the workflow run.

Example:

https://api.github.com/repos/github/hello-world/actions/runs/5

workflow_id

integer

required

The ID of the parent workflow.

Example:

workflow_url

string

required

The URL to the workflow.

Example:

https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml