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. If the repository is private you must use an access token with the repo scope.
External DocumentationTo learn more, visit the GitHub documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Owner | The account owner of the repository. The name is not case sensitive. |
| Repo | The name of the repository. The name is not case sensitive. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Workflow ID | The ID of the workflow. You can also pass the workflow file name as a string. Can be obtained via the List Repository Workflows action. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Actor | Returns someone’s workflow runs. Use the login for the user who created the push associated with the check suite or workflow run. |
| Branch | Returns workflow runs associated with a branch. Use the name of the branch of the push. |
| Check Suite ID | Returns workflow runs with the check_suite_id that you specify. |
| Created | Returns workflow runs created within the given date-time range. For more information on the syntax, see “Understanding the search syntax.”. |
| Event | Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see “Events that trigger workflows.”. |
| Exclude Pull Requests | If true pull requests are omitted from the response (empty array). |
| Page | Page number of the results to fetch. |
| Per Page | The number of results per page (max 100). |
| Status | 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. |
Example Output
{
"total_count": 23240,
"workflow_runs": [
{
"id": 26652069509,
"name": "<string>",
"node_id": "<string>",
"head_branch": "<string>",
"head_sha": "<string>",
"path": "<string>",
"display_title": "<string>",
"run_number": 11872,
"event": "<string>",
"status": "<string>",
"conclusion": null,
"workflow_id": 4900065,
"check_suite_id": 10582629588,
"check_suite_node_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"pull_requests": [],
"created_at": "2021-10-28T16:05:50Z",
"updated_at": "2021-10-28T16:05:50Z",
"actor": {
"login": "<string>",
"id": 2127402,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"run_attempt": 0,
"referenced_workflows": [],
"run_started_at": "2021-10-28T16:05:50Z",
"triggering_actor": {
"login": "<string>",
"id": 26708231,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"jobs_url": "<string>",
"logs_url": "<string>",
"check_suite_url": "<string>",
"artifacts_url": "<string>",
"cancel_url": "<string>",
"rerun_url": "<string>",
"previous_attempt_url": null,
"workflow_url": "<string>",
"head_commit": {
"id": "<string>",
"tree_id": "<string>",
"message": "<string>",
"timestamp": "<string>",
"author": {
"name": "<string>",
"email": "<string>"
},
"committer": {
"name": "<string>",
"email": "<string>"
}
},
"repository": {
"id": 254024569,
"node_id": "<string>",
"name": "<string>",
"full_name": "<string>",
"private": true,
"owner": {
"login": "<string>",
"id": 3947696,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"html_url": "<string>",
"description": null,
"fork": false,
"url": "<string>",
"forks_url": "<string>",
"keys_url": "<string>",
"collaborators_url": "<string>",
"teams_url": "<string>",
"hooks_url": "<string>",
"issue_events_url": "<string>",
"events_url": "<string>",
"assignees_url": "<string>",
"branches_url": "<string>",
"tags_url": "<string>",
"blobs_url": "<string>",
"git_tags_url": "<string>",
"git_refs_url": "<string>",
"trees_url": "<string>",
"statuses_url": "<string>",
"languages_url": "<string>",
"stargazers_url": "<string>",
"contributors_url": "<string>",
"subscribers_url": "<string>",
"subscription_url": "<string>",
"commits_url": "<string>",
"git_commits_url": "<string>",
"comments_url": "<string>",
"issue_comment_url": "<string>",
"contents_url": "<string>",
"compare_url": "<string>",
"merges_url": "<string>",
"archive_url": "<string>",
"downloads_url": "<string>",
"issues_url": "<string>",
"pulls_url": "<string>",
"milestones_url": "<string>",
"notifications_url": "<string>",
"labels_url": "<string>",
"releases_url": "<string>",
"deployments_url": "<string>"
},
"head_repository": {
"id": 84159838,
"node_id": "<string>",
"name": "<string>",
"full_name": "<string>",
"private": true,
"owner": {
"login": "<string>",
"id": 90779848,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"html_url": "<string>",
"description": null,
"fork": false,
"url": "<string>",
"forks_url": "<string>",
"keys_url": "<string>",
"collaborators_url": "<string>",
"teams_url": "<string>",
"hooks_url": "<string>",
"issue_events_url": "<string>",
"events_url": "<string>",
"assignees_url": "<string>",
"branches_url": "<string>",
"tags_url": "<string>",
"blobs_url": "<string>",
"git_tags_url": "<string>",
"git_refs_url": "<string>",
"trees_url": "<string>",
"statuses_url": "<string>",
"languages_url": "<string>",
"stargazers_url": "<string>",
"contributors_url": "<string>",
"subscribers_url": "<string>",
"subscription_url": "<string>",
"commits_url": "<string>",
"git_commits_url": "<string>",
"comments_url": "<string>",
"issue_comment_url": "<string>",
"contents_url": "<string>",
"compare_url": "<string>",
"merges_url": "<string>",
"archive_url": "<string>",
"downloads_url": "<string>",
"issues_url": "<string>",
"pulls_url": "<string>",
"milestones_url": "<string>",
"notifications_url": "<string>",
"labels_url": "<string>",
"releases_url": "<string>",
"deployments_url": "<string>"
}
},
{
"id": 11419156307,
"name": "<string>",
"node_id": "<string>",
"head_branch": "<string>",
"head_sha": "<string>",
"path": "<string>",
"display_title": "<string>",
"run_number": 12836,
"event": "<string>",
"status": "<string>",
"conclusion": "<string>",
"workflow_id": 9941870,
"check_suite_id": 8823190679,
"check_suite_node_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"pull_requests": [],
"created_at": "2021-10-28T16:05:50Z",
"updated_at": "2021-10-28T16:05:50Z",
"actor": {
"login": "<string>",
"id": 228021261,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"run_attempt": 1,
"referenced_workflows": [],
"run_started_at": "2021-10-28T16:05:50Z",
"triggering_actor": {
"login": "<string>",
"id": 140085866,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"jobs_url": "<string>",
"logs_url": "<string>",
"check_suite_url": "<string>",
"artifacts_url": "<string>",
"cancel_url": "<string>",
"rerun_url": "<string>",
"previous_attempt_url": null,
"workflow_url": "<string>",
"head_commit": {
"id": "<string>",
"tree_id": "<string>",
"message": "<string>",
"timestamp": "<string>",
"author": {
"name": "<string>",
"email": "<string>"
},
"committer": {
"name": "<string>",
"email": "<string>"
}
},
"repository": {
"id": 106468480,
"node_id": "<string>",
"name": "<string>",
"full_name": "<string>",
"private": true,
"owner": {
"login": "<string>",
"id": 9271758,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"html_url": "<string>",
"description": null,
"fork": false,
"url": "<string>",
"forks_url": "<string>",
"keys_url": "<string>",
"collaborators_url": "<string>",
"teams_url": "<string>",
"hooks_url": "<string>",
"issue_events_url": "<string>",
"events_url": "<string>",
"assignees_url": "<string>",
"branches_url": "<string>",
"tags_url": "<string>",
"blobs_url": "<string>",
"git_tags_url": "<string>",
"git_refs_url": "<string>",
"trees_url": "<string>",
"statuses_url": "<string>",
"languages_url": "<string>",
"stargazers_url": "<string>",
"contributors_url": "<string>",
"subscribers_url": "<string>",
"subscription_url": "<string>",
"commits_url": "<string>",
"git_commits_url": "<string>",
"comments_url": "<string>",
"issue_comment_url": "<string>",
"contents_url": "<string>",
"compare_url": "<string>",
"merges_url": "<string>",
"archive_url": "<string>",
"downloads_url": "<string>",
"issues_url": "<string>",
"pulls_url": "<string>",
"milestones_url": "<string>",
"notifications_url": "<string>",
"labels_url": "<string>",
"releases_url": "<string>",
"deployments_url": "<string>"
},
"head_repository": {
"id": 676144005,
"node_id": "<string>",
"name": "<string>",
"full_name": "<string>",
"private": true,
"owner": {
"login": "<string>",
"id": 152318919,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"html_url": "<string>",
"description": null,
"fork": false,
"url": "<string>",
"forks_url": "<string>",
"keys_url": "<string>",
"collaborators_url": "<string>",
"teams_url": "<string>",
"hooks_url": "<string>",
"issue_events_url": "<string>",
"events_url": "<string>",
"assignees_url": "<string>",
"branches_url": "<string>",
"tags_url": "<string>",
"blobs_url": "<string>",
"git_tags_url": "<string>",
"git_refs_url": "<string>",
"trees_url": "<string>",
"statuses_url": "<string>",
"languages_url": "<string>",
"stargazers_url": "<string>",
"contributors_url": "<string>",
"subscribers_url": "<string>",
"subscription_url": "<string>",
"commits_url": "<string>",
"git_commits_url": "<string>",
"comments_url": "<string>",
"issue_comment_url": "<string>",
"contents_url": "<string>",
"compare_url": "<string>",
"merges_url": "<string>",
"archive_url": "<string>",
"downloads_url": "<string>",
"issues_url": "<string>",
"pulls_url": "<string>",
"milestones_url": "<string>",
"notifications_url": "<string>",
"labels_url": "<string>",
"releases_url": "<string>",
"deployments_url": "<string>"
}
}
]
}
Workflow Library Example
List Workflow Runs with Github and Send Results Via Email