How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
GitHub

GitHub Workflows API

The Workflows API from GitHub — 24 operation(s) for workflows.

Documentation Provider Profile APIs.io OpenAPI GitHub

GitHub Workflows API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 30 operations across 24 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against 2 base URLs: {protocol}://{hostname}/api/v3, {protocol}://{hostname}.

30 operations 24 paths 27 schemas 2 DELETE17 GET6 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

GitHub Workflows API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 30

Across 24 paths, the API surfaces 30 operations — 2 DELETE, 17 GET, 6 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Workflows 30
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/approvals
GitHub Get the Review History Forworkflow Run
getTheReviewHistoryForworkflowRun 3 params → 200
GET
/orgs/{org}/actions/permissions/workflow
GitHub Get Default Workflow Permissions for an Organization
getDefaultWorkflowPermissionsForAnOrganization 1 param → 200
PUT
/orgs/{org}/actions/permissions/workflow
GitHub Set Default Workflow Permissions for an Organization
setDefaultWorkflowPermissionsForAnOrganization 1 param body → 204409
GET
/repos/{owner}/{repo}/actions/jobs/{job_id}/logs
GitHub Download Job Logs for Workflow Run
downloadJobLogsForWorkflowRun 6 params → 302
POST
/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun
GitHub Re-run Job from Workflow Run
rerunJobFromWorkflowRun 6 params body → 201403
GET
/repos/{owner}/{repo}/actions/permissions/access
GitHub Get the Level of Access for Workflows Outside of the Repository
getTheLevelOfAccessForWorkflowsOutsideOfTheRepository 5 params → 200
PUT
/repos/{owner}/{repo}/actions/permissions/access
GitHub Set the Level of Access for Workflows Outside of the Repository
setTheLevelOfAccessForWorkflowsOutsideOfTheRepository 5 params body → 204
GET
/repos/{owner}/{repo}/actions/permissions/workflow
GitHub Get Default Workflow Permissions for Repository
getDefaultWorkflowPermissionsForRepository 5 params → 200
PUT
/repos/{owner}/{repo}/actions/permissions/workflow
GitHub Set Default Workflow Permissions for Repository
setDefaultWorkflowPermissionsForRepository 5 params body → 204409
GET
/repos/{owner}/{repo}/actions/runs
GitHub List Workflow Runs for Repository
listWorkflowRunsForRepository 15 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}
GitHub Get Workflow Run
getWorkflowRun 7 params → 200
DELETE
/repos/{owner}/{repo}/actions/runs/{run_id}
GitHub Delete Workflow Run
deleteWorkflowRun 6 params → 204
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts
GitHub List Workflow Run Artifacts
listWorkflowRunArtifacts 9 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}
GitHub Get Workflow Run Attempt
getWorkflowRunAttempt 8 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs
GitHub List Jobs for Workflow Run Attempt
listJobsForWorkflowRunAttempt 9 params → 200404
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs
GitHub Download Workflow Run Attempt Logs
downloadWorkflowRunAttemptLogs 7 params → 302
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/cancel
GitHub Cancel Workflow Run
cancelWorkflowRun 6 params → 202409
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/jobs
GitHub List Jobs for Workflow Run
listJobsForWorkflowRun 9 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/logs
GitHub Download Workflow Run Logs
downloadWorkflowRunLogs 6 params → 302
DELETE
/repos/{owner}/{repo}/actions/runs/{run_id}/logs
GitHub Delete Workflow Run Logs
deleteWorkflowRunLogs 6 params → 204403500
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
GitHub Get Pending Deployments for Workflow Run
getPendingDeploymentsForWorkflowRun 6 params → 200
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
GitHub Review Pending Deployments for Workflow Run
reviewPendingDeploymentsForWorkflowRun 6 params body → 200
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/rerun
GitHub Re-run Workflow
rerunWorkflow 6 params body → 201
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs
GitHub Re-run Failed Jobs from Workflow Run
rerunFailedJobsFromWorkflowRun 6 params body → 201
GET
/repos/{owner}/{repo}/actions/workflows
GitHub List Repository Workflows
listRepositoryWorkflows 7 params → 200
GET
/repos/{owner}/{repo}/actions/workflows/{workflow_id}
GitHub Get Workflow
getWorkflow 6 params → 200
PUT
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable
GitHub Disable Workflow
disableWorkflow 6 params → 204
POST
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches
GitHub Create Workflow Dispatch Event
createWorkflowDispatchEvent 6 params body → 204
PUT
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable
GitHub Enable Workflow
enableWorkflow 6 params → 204
GET
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs
GitHub List Workflow Runs for Workflow
listWorkflowRunsForWorkflow 16 params → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are minimal-repository (87 properties), workflow-run (36 properties), job (23 properties), simple-user (21 properties). Each schema is shown below with its type and property counts.

simple-user
object
A GitHub user.
21 properties 18 required
environment-approvals
object
An entry in the reviews log for environment deployments
4 properties 4 required
actions-get-default-workflow-permissions
object
2 properties 2 required
actions-can-approve-pull-request-reviews
boolean
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
actions-default-workflow-permissions
string
The default workflow permissions granted to the GITHUBTOKEN when running workflows.
actions-set-default-workflow-permissions
object
2 properties
pending-deployment
object
Details of a deployment that is waiting for protection rules to pass
5 properties 5 required
code-of-conduct
object
Code Of Conduct
5 properties 4 required
minimal-repository
object
Minimal Repository
87 properties 46 required
workflow-run
object
An invocation of a workflow
36 properties 26 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
security-and-analysis
object
3 properties
simple-user_2
object
GitHub user.
21 properties 18 required
nullable-integration
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties 11 required
deployment-reviewer-type
string
The type of reviewer.
basic-error
object
Basic Error
4 properties
referenced-workflow
object
workflow referenced/reused by the initial caller workflow
3 properties 2 required
actions-workflow-access-to-repository
object
1 property 1 required
pull-request-minimal
object
5 properties 5 required
workflow
object
GitHub Actions workflow
11 properties 10 required
nullable-team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
empty-object
object
An object without any properties.
job
object
Information of a job execution in a workflow run
23 properties 21 required
artifact
object
An artifact
11 properties 10 required
deployment
object
request for a specific ref(branch,sha,tag) to be deployed
18 properties 14 required
nullable-simple-commit
object
commit.
6 properties 6 required
nullable-simple-user
object
GitHub user.
21 properties 18 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-workflows-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
AE Profile APIs.io
GitHub Feeds API
AE Profile APIs.io
GitHub Gists API
AE Profile APIs.io
GitHub Issues API
AE Profile APIs.io
GitHub Licenses API
AE Profile APIs.io
GitHub Markdown API
AE Profile APIs.io
GitHub Meta API
AE Profile APIs.io
GitHub Notifications API
AE Profile APIs.io
GitHub Octocat API
AE Profile APIs.io
GitHub Projects API
AE Profile APIs.io
GitHub Repos API
AE Profile APIs.io
GitHub Search API
AE Profile APIs.io
#Workflows
← Back to G APIs
API Details
ID
github:github-workflows-api
Base URL
https://api.github.com
Docs
https://docs.github.com/en/rest/apps?apiVersion=2022-11-28
Provider
GitHub
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=github-workflows-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/github-workflows-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of GitHub Workflows API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.