Gets a specific workflow run. 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. GitHub Apps must have the actions:read permission to use this endpoint.

External Documentation

To learn more, visit the GitHub documentation.

​
Basic Parameters

ParameterDescription
OwnerThe account owner of the repository. The name is not case sensitive.
RepoThe name of the repository. The name is not case sensitive.
Run IDThe unique identifier of the workflow run.
Can be obtained via the List Workflow Runs action.

​
Advanced Parameters

ParameterDescription
Exclude Pull RequestsIf true pull requests are omitted from the response (empty array).

​
Example Output

{
	"id": 27494120239,
	"name": "<string>",
	"node_id": "<string>",
	"head_branch": "<string>",
	"head_sha": "<string>",
	"path": "<string>",
	"display_title": "<string>",
	"run_number": 5508,
	"event": "<string>",
	"status": "<string>",
	"conclusion": null,
	"workflow_id": 55784002,
	"check_suite_id": 21462296925,
	"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": 16496017,
		"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": 2,
	"referenced_workflows": [],
	"run_started_at": "2021-10-28T16:05:50Z",
	"triggering_actor": {
		"login": "<string>",
		"id": 160932201,
		"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": 12906590,
		"node_id": "<string>",
		"name": "<string>",
		"full_name": "<string>",
		"private": true,
		"owner": {
			"login": "<string>",
			"id": 120951496,
			"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": 436880632,
		"node_id": "<string>",
		"name": "<string>",
		"full_name": "<string>",
		"private": true,
		"owner": {
			"login": "<string>",
			"id": 53544329,
			"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

Get Workflow Run with Github and Send Results Via Email

Preview this Workflow on desktop