GitHub · Schema
Workflow Run
An invocation of a workflow
CodeDeveloper ToolsPipelinesPlatformSoftware DevelopmentVersion ControlT1GitHubGit
Properties
| Name | Type | Description |
|---|---|---|
| id | integer | The ID of the workflow run. |
| name | stringnull | The name of the workflow run. |
| node_id | string | |
| check_suite_id | integer | The ID of the associated check suite. |
| check_suite_node_id | string | The node ID of the associated check suite. |
| head_branch | stringnull | |
| head_sha | string | The SHA of the head commit that points to the version of the workflow being run. |
| path | string | The full path of the workflow |
| run_number | integer | The auto incrementing run number for the workflow run. |
| run_attempt | integer | Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. |
| referenced_workflows | arraynull | |
| event | string | |
| status | stringnull | |
| conclusion | stringnull | |
| workflow_id | integer | The ID of the parent workflow. |
| url | string | The URL to the workflow run. |
| html_url | string | |
| pull_requests | arraynull | Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. |
| created_at | string | |
| updated_at | string | |
| actor | object | |
| triggering_actor | object | |
| run_started_at | string | The start time of the latest run. Resets on re-run. |
| jobs_url | string | The URL to the jobs for the workflow run. |
| logs_url | string | The URL to download the logs for the workflow run. |
| check_suite_url | string | The URL to the associated check suite. |
| artifacts_url | string | The URL to the artifacts for the workflow run. |
| cancel_url | string | The URL to cancel the workflow run. |
| rerun_url | string | The URL to rerun the workflow run. |
| previous_attempt_url | stringnull | The URL to the previous attempted run of this workflow, if one exists. |
| workflow_url | string | The URL to the workflow. |
| head_commit | object | |
| repository | object | |
| head_repository | object | |
| head_repository_id | integer | |
| display_title | string | 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. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/github/main/json-schema/github-workflow-run-schema.json",
"title": "Workflow Run",
"description": "An invocation of a workflow",
"x-generated": "2026-10-03",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/github-actions-api-openapi.yml#/components/schemas/workflow-run",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the workflow run."
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the workflow run."
},
"node_id": {
"type": "string"
},
"check_suite_id": {
"type": "integer",
"description": "The ID of the associated check suite."
},
"check_suite_node_id": {
"type": "string",
"description": "The node ID of the associated check suite."
},
"head_branch": {
"type": [
"string",
"null"
]
},
"head_sha": {
"description": "The SHA of the head commit that points to the version of the workflow being run.",
"type": "string"
},
"path": {
"description": "The full path of the workflow",
"type": "string"
},
"run_number": {
"type": "integer",
"description": "The auto incrementing run number for the workflow run."
},
"run_attempt": {
"type": "integer",
"description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run."
},
"referenced_workflows": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/referenced-workflow"
}
},
"event": {
"type": "string"
},
"status": {
"type": [
"string",
"null"
]
},
"conclusion": {
"type": [
"string",
"null"
]
},
"workflow_id": {
"type": "integer",
"description": "The ID of the parent workflow."
},
"url": {
"type": "string",
"description": "The URL to the workflow run."
},
"html_url": {
"type": "string"
},
"pull_requests": {
"description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/pull-request-minimal"
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"actor": {
"$ref": "#/$defs/simple-user"
},
"triggering_actor": {
"$ref": "#/$defs/simple-user"
},
"run_started_at": {
"type": "string",
"format": "date-time",
"description": "The start time of the latest run. Resets on re-run."
},
"jobs_url": {
"description": "The URL to the jobs for the workflow run.",
"type": "string"
},
"logs_url": {
"description": "The URL to download the logs for the workflow run.",
"type": "string"
},
"check_suite_url": {
"description": "The URL to the associated check suite.",
"type": "string"
},
"artifacts_url": {
"description": "The URL to the artifacts for the workflow run.",
"type": "string"
},
"cancel_url": {
"description": "The URL to cancel the workflow run.",
"type": "string"
},
"rerun_url": {
"description": "The URL to rerun the workflow run.",
"type": "string"
},
"previous_attempt_url": {
"description": "The URL to the previous attempted run of this workflow, if one exists.",
"type": [
"string",
"null"
]
},
"workflow_url": {
"description": "The URL to the workflow.",
"type": "string"
},
"head_commit": {
"$ref": "#/$defs/nullable-simple-commit"
},
"repository": {
"$ref": "#/$defs/minimal-repository"
},
"head_repository": {
"$ref": "#/$defs/minimal-repository"
},
"head_repository_id": {
"type": "integer"
},
"display_title": {
"type": "string",
"description": "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."
}
},
"required": [
"id",
"node_id",
"head_branch",
"run_number",
"display_title",
"event",
"status",
"conclusion",
"head_sha",
"path",
"workflow_id",
"url",
"html_url",
"created_at",
"updated_at",
"head_commit",
"head_repository",
"repository",
"jobs_url",
"logs_url",
"check_suite_url",
"cancel_url",
"rerun_url",
"artifacts_url",
"workflow_url",
"pull_requests"
],
"$defs": {
"code-of-conduct": {
"title": "Code Of Conduct",
"description": "Code Of Conduct",
"type": "object",
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"body": {
"type": "string"
},
"html_url": {
"type": [
"string",
"null"
],
"format": "uri"
}
},
"required": [
"url",
"html_url",
"key",
"name"
]
},
"minimal-repository": {
"title": "Minimal Repository",
"description": "Minimal Repository",
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"name": {
"type": "string"
},
"full_name": {
"type": "string"
},
"owner": {
"$ref": "#/$defs/simple-user"
},
"private": {
"type": "boolean"
},
"html_url": {
"type": "string",
"format": "uri"
},
"description": {
"type": [
"string",
"null"
]
},
"fork": {
"type": "boolean"
},
"url": {
"type": "string",
"format": "uri"
},
"archive_url": {
"type": "string"
},
"assignees_url": {
"type": "string"
},
"blobs_url": {
"type": "string"
},
"branches_url": {
"type": "string"
},
"collaborators_url": {
"type": "string"
},
"comments_url": {
"type": "string"
},
"commits_url": {
"type": "string"
},
"compare_url": {
"type": "string"
},
"contents_url": {
"type": "string"
},
"contributors_url": {
"type": "string",
"format": "uri"
},
"deployments_url": {
"type": "string",
"format": "uri"
},
"downloads_url": {
"type": "string",
"format": "uri"
},
"events_url": {
"type": "string",
"format": "uri"
},
"forks_url": {
"type": "string",
"format": "uri"
},
"git_commits_url": {
"type": "string"
},
"git_refs_url": {
"type": "string"
},
"git_tags_url": {
"type": "string"
},
"git_url": {
"type": "string"
},
"issue_comment_url": {
"type": "string"
},
"issue_events_url": {
"type": "string"
},
"issues_url": {
"type": "string"
},
"keys_url": {
"type": "string"
},
"labels_url": {
"type": "string"
},
"languages_url": {
"type": "string",
"format": "uri"
},
"merges_url": {
"type": "string",
"format": "uri"
},
"milestones_url": {
"type": "string"
},
"notifications_url": {
"type": "string"
},
"pulls_url": {
"type": "string"
},
"releases_url": {
"type": "string"
},
"ssh_url": {
"type": "string"
},
"stargazers_url": {
"type": "string",
"format": "uri"
},
"statuses_url": {
"type": "string"
},
"subscribers_url": {
"type": "string",
"format": "uri"
},
"subscription_url": {
"type": "string",
"format": "uri"
},
"tags_url": {
"type": "string",
"format": "uri"
},
"teams_url": {
"type": "string",
"format": "uri"
},
"trees_url": {
"type": "string"
},
"clone_url": {
"type": "string"
},
"mirror_url": {
"type": [
"string",
"null"
]
},
"hooks_url": {
"type": "string",
"format": "uri"
},
"svn_url": {
"type": "string"
},
"homepage": {
"type": [
"string",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"forks_count": {
"type": "integer"
},
"stargazers_count": {
"type": "integer"
},
"watchers_count": {
"type": "integer"
},
"size": {
"description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
"type": "integer"
},
"default_branch": {
"type": "string"
},
"open_issues_count": {
"type": "integer"
},
"is_template": {
"type": "boolean"
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"has_issues": {
"type": "boolean"
},
"has_projects": {
"type": "boolean"
},
"has_wiki": {
"type": "boolean"
},
"has_pages": {
"type": "boolean"
},
"has_downloads": {
"type": "boolean"
},
"has_discussions": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"disabled": {
"type": "boolean"
},
"visibility": {
"type": "string"
},
"pushed_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"permissions": {
"type": "object",
"properties": {
"admin": {
"type": "boolean"
},
"maintain": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"triage": {
"type": "boolean"
},
"pull": {
"type": "boolean"
}
}
},
"role_name": {
"type": "string"
},
"temp_clone_token": {
"type": "string"
},
"delete_branch_on_merge": {
"type": "boolean"
},
"subscribers_count": {
"type": "integer"
},
"network_count": {
"type": "integer"
},
"code_of_conduct": {
"$ref": "#/$defs/code-of-conduct"
},
"license": {
"type": [
"object",
"null"
],
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"spdx_id": {
"type": "string"
},
"url": {
"type": "string"
},
"node_id": {
"type": "string"
}
}
},
"forks": {
"type": "integer"
},
"open_issues": {
"type": "integer"
},
"watchers": {
"type": "integer"
},
"allow_forking": {
"type": "boolean"
},
"web_commit_signoff_required": {
"type": "boolean"
},
"security_and_analysis": {
"$ref": "#/$defs/security-and-analysis"
}
},
"required": [
"archive_url",
"assignees_url",
"blobs_url",
"branches_url",
"collaborators_url",
"comments_url",
"commits_url",
"compare_url",
"contents_url",
"contributors_url",
"deployments_url",
"description",
"downloads_url",
"events_url",
"fork",
"forks_url",
"full_name",
"git_commits_url",
"git_refs_url",
"git_tags_url",
"hooks_url",
"html_url",
"id",
"node_id",
"issue_comment_url",
"issue_events_url",
"issues_url",
"keys_url",
"labels_url",
"languages_url",
"merges_url",
"milestones_url",
"name",
"notifications_url",
"owner",
"private",
"pulls_url",
"releases_url",
"stargazers_url",
"statuses_url",
"subscribers_url",
"subscription_url",
"tags_url",
"teams_url",
"trees_url",
"url"
]
},
"nullable-simple-commit": {
"title": "Simple Commit",
"description": "A commit.",
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "SHA for the commit"
},
"tree_id": {
"type": "string",
"description": "SHA for the commit's tree"
},
"message": {
"description": "Message describing the purpose of the commit",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the commit",
"format": "date-time",
"type": "string"
},
"author": {
"type": [
"object",
"null"
],
"description": "Information about the Git author",
"properties": {
"name": {
"description": "Name of the commit's author",
"type": "string"
},
"email": {
"description": "Git email address of the commit's author",
"type": "string",
"format": "email"
}
},
"required": [
"name",
"email"
]
},
"committer": {
"type": [
"object",
"null"
],
"description": "Information about the Git committer",
"properties": {
"name": {
"description": "Name of the commit's committer",
"type": "string"
},
"email": {
"description": "Git email address of the commit's committer",
"type": "string",
"format": "email"
}
},
"required": [
"name",
"email"
]
}
},
"required": [
"id",
"tree_id",
"message",
"timestamp",
"author",
"committer"
]
},
"pull-request-minimal": {
"title": "Pull Request Minimal",
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"number": {
"type": "integer"
},
"url": {
"type": "string"
},
"head": {
"type": "object",
"properties": {
"ref": {
"type": "string"
},
"sha": {
"type": "string"
},
"repo": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"url": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"url",
"name"
]
}
},
"required": [
"ref",
"sha",
"repo"
]
},
"base": {
"type": "object",
"properties": {
"ref": {
"type": "string"
},
"sha": {
"type": "string"
},
"repo": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"url": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"url",
"name"
]
}
},
"required": [
"ref",
"sha",
"repo"
]
}
},
"required": [
"id",
"number",
"url",
"head",
"base"
]
},
"referenced-workflow": {
"title": "Referenced workflow",
"description": "A workflow referenced/reused by the initial caller workflow",
"type": "object",
"properties": {
"path": {
"type": "string"
},
"sha": {
"type": "string"
},
"ref": {
"type": "string"
}
},
"required": [
"path",
"sha"
]
},
"security-and-analysis": {
"type": [
"object",
"null"
],
"properties": {
"advanced_security": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"enabled",
"disabled"
]
}
}
},
"secret_scanning": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"enabled",
"disabled"
]
}
}
},
"secret_scanning_push_protection": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"enabled",
"disabled"
]
}
}
}
}
},
"simple-user": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"login": {
"type": "string"
},
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"avatar_url": {
"type": "string",
"format": "uri"
},
"gravatar_id": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string",
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"events_url": {
"type": "string"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string"
}
},
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
]
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/github-workflow-run"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.