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

GitHub Get API

The Get API from GitHub — 181 operation(s) for get.

GitHub Get 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.

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

This API exposes 167 operations across 167 paths, and defines 287 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}.

167 operations 167 paths 287 schemas 165 GET2 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
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 167

Across 167 paths, the API surfaces 167 operations — 165 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Get 167
GET
/app
GitHub Get the Authenticated App
getTheAuthenticatedApp → 200
GET
/app/hook/config
GitHub Getwebhook Configuration for an App
getwebhookConfigurationForAnApp → 200
GET
/app/hook/deliveries/{delivery_id}
GitHub Getdelivery for an App Webhook
getdeliveryForAnAppWebhook 1 param → 200400422
GET
/app/installations/{installation_id}
GitHub Get an Installation for the Authenticated App
getAnInstallationForTheAuthenticatedApp 1 param → 200404
GET
/applications/grants/{grant_id}deprecated
GitHub Getsingle Grant
getsingleGrant 1 param → 200304401403
GET
/apps/{app_slug}
GitHub Get an App
getAnApp 1 param → 200403404
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/approvals
GitHub Get the Review History Forworkflow Run
getTheReviewHistoryForworkflowRun 3 params → 200
GET
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps
GitHub Get Apps with Access to the Protected Branch
getAppsWithAccessToTheProtectedBranch 3 params → 200404
PUT
/authorizations/clients/{client_id}deprecated
GitHub Get or Create an Authorization Forspecific App
getOrCreateAnAuthorizationForspecificApp 1 param body → 200201304401403422
PUT
/authorizations/clients/{client_id}/{fingerprint}deprecated
GitHub Get or Create an Authorization Forspecific App and Fingerprint
getOrCreateAnAuthorizationForspecificAppAndFingerprint 2 params body → 200201422
GET
/authorizations/{authorization_id}deprecated
GitHub Getsingle Authorization
getsingleAuthorization 1 param → 200304401403
GET
/codes_of_conduct
GitHub Get All Codes of Conduct
getAllCodesOfConduct → 200304
GET
/codes_of_conduct/{key}
GitHub Get Code of Conduct
getCodeOfConduct 1 param → 200304404
GET
/emojis
GitHub Get Emojis
getEmojis → 200304
GET
/feeds
GitHub Get Feeds
getFeeds → 200
GET
/gists/{gist_id}
GitHub Getgist
getgist 1 param → 200304403404
GET
/gists/{gist_id}/comments/{comment_id}
GitHub Getgist Comment
getgistComment 2 params → 200304403404
GET
/gists/{gist_id}/{sha}
GitHub Getgist Revision
getgistRevision 2 params → 200403404422
GET
/gitignore/templates/{name}
GitHub Get Gitignore Template
getGitignoreTemplate 1 param → 200304
GET
/orgs/{org}/installation
GitHub Get an Organization Installation for the Authenticated App
getAnOrganizationInstallationForTheAuthenticatedApp 1 param → 200
GET
/repos/{owner}/{repo}/installation
GitHub Get Repository Installation for the Authenticated App
getrepositoryInstallationForTheAuthenticatedApp 2 params → 200301404
GET
/users/{username}/installation
GitHub Get User Installation for the Authenticated App
getuserInstallationForTheAuthenticatedApp 1 param → 200
GET
/licenses/{license}
GitHub Get License
getlicense 1 param → 200304403404
GET
/manage/v1/config/nodes
GitHub Get Ghes Node Metadata for All Nodes
getGhesNodeMetadataForAllNodes 2 params → 200401500
GET
/manage/v1/replication/status
GitHub Get the Status of Services Running on All Replica Nodes
getTheStatusOfServicesRunningOnAllReplicaNodes 2 params → 200401500
GET
/manage/v1/version
GitHub Get All Ghes Release Versions for All Nodes
getAllGhesReleaseVersionsForAllNodes 2 params → 200401500
GET
/meta
GitHub Get Github Enterprise Server Meta Information
getGithubEnterpriseServerMetaInformation → 200304
GET
/notifications/threads/{thread_id}
GitHub Get Thread
getThread 1 param → 200304401403
GET
/notifications/threads/{thread_id}/subscription
GitHub Get Thread Subscription for the Authenticated User
getThreadSubscriptionForTheAuthenticatedUser 1 param → 200304401403
GET
/octocat
GitHub Get Octocat
getOctocat 1 param → 200
GET
/orgs/{org}
GitHub Get an Organization
getAnOrganization 1 param → 200404
GET
/orgs/{org}/actions/cache/usage
GitHub Get Github Actions Cache Usage for an Organization
getGithubActionsCacheUsageForAnOrganization 1 param → 200
GET
/orgs/{org}/actions/oidc/customization/sub
GitHub Get the Customization Template for an Oidc Subject Claim for an Organization
getTheCustomizationTemplateForAnOidcSubjectClaimForAnOrganization 1 param → 200
GET
/orgs/{org}/actions/permissions
GitHub Get Github Actions Permissions for an Organization
getGithubActionsPermissionsForAnOrganization 1 param → 200
GET
/orgs/{org}/actions/permissions/selected-actions
GitHub Get Allowed Actions for an Organization
getAllowedActionsForAnOrganization 1 param → 200
GET
/orgs/{org}/actions/permissions/workflow
GitHub Get Default Workflow Permissions for an Organization
getDefaultWorkflowPermissionsForAnOrganization 1 param → 200
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}
GitHub Get Self-hosted Runner Group for an Organization
getSelfhostedRunnerGroupForAnOrganization 2 params → 200
GET
/orgs/{org}/actions/runners/{runner_id}
GitHub Get Self-hosted Runner for an Organization
getSelfhostedRunnerForAnOrganization 2 params → 200
GET
/orgs/{org}/actions/secrets/public-key
GitHub Get an Organization Public Key
getAnOrganizationPublicKey 1 param → 200
GET
/orgs/{org}/actions/secrets/{secret_name}
GitHub Get an Organization Secret
getAnOrganizationSecret 2 params → 200
GET
/orgs/{org}/actions/variables/{name}
GitHub Get an Organization Variable
getAnOrganizationVariable 2 params → 200
GET
/orgs/{org}/announcement
GitHub Get Announcement Banner for Organization
getAnnouncementBannerForOrganization 1 param → 200
GET
/orgs/{org}/audit-log
GitHub Get the Audit Log for an Organization
getTheAuditLogForAnOrganization 8 params → 200
GET
/orgs/{org}/custom-repository-roles/{role_id}
GitHub Get Custom Repository Role
getCustomRepositoryRole 2 params → 200404
GET
/orgs/{org}/dependabot/secrets/public-key
GitHub Get an Organization Public Key
getAnOrganizationPublicKey 1 param → 200
GET
/orgs/{org}/dependabot/secrets/{secret_name}
GitHub Get an Organization Secret
getAnOrganizationSecret 2 params → 200
GET
/orgs/{org}/docker/conflicts
GitHub Get List of Conflicting Packages During Docker Migration for Organization
getListOfConflictingPackagesDuringDockerMigrationForOrganization 1 param → 200401403
GET
/orgs/{org}/external-group/{group_id}
GitHub Get an External Group
getAnExternalGroup 2 params → 200
GET
/orgs/{org}/hooks/{hook_id}
GitHub Get an Organization Webhook
getAnOrganizationWebhook 2 params → 200404
GET
/orgs/{org}/hooks/{hook_id}/config
GitHub Get Webhook Configuration for an Organization
getWebhookConfigurationForAnOrganization 2 params → 200
GET
/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}
GitHub Get Webhook Delivery for an Organization Webhook
getWebhookDeliveryForAnOrganizationWebhook 3 params → 200400422
GET
/orgs/{org}/memberships/{username}
GitHub Get Organization Membership for User
getOrganizationMembershipForUser 2 params → 200403404
GET
/orgs/{org}/migrations/{migration_id}
GitHub Get an Organization Migration Status
getAnOrganizationMigrationStatus 3 params → 200404
GET
/orgs/{org}/packages/{package_type}/{package_name}
GitHub Get Package for an Organization
getPackageForAnOrganization 3 params → 200
GET
/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}
GitHub Get Package Version for an Organization
getPackageVersionForAnOrganization 4 params → 200
GET
/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
GitHub Get Pre-receive Hook for an Organization
getPrereceiveHookForAnOrganization 2 params → 200
GET
/orgs/{org}/settings/billing/advanced-security
GitHub Get Github Advanced Security Active Committers for an Organization
getGithubAdvancedSecurityActiveCommittersForAnOrganization 3 params → 200403
GET
/orgs/{org}/teams/{team_slug}
GitHub Get Team by Name
getTeamByName 2 params → 200404
GET
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}
GitHub Get Discussion
getDiscussion 3 params → 200
GET
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}
GitHub Get Discussion Comment
getDiscussionComment 4 params → 200
GET
/orgs/{org}/teams/{team_slug}/memberships/{username}
GitHub Get Team Membership for User
getTeamMembershipForUser 3 params → 200404
GET
/projects/columns/cards/{card_id}
GitHub Get Project Card
getProjectCard 1 param → 200304401403404
GET
/projects/columns/{column_id}
GitHub Get Project Column
getProjectColumn 1 param → 200304401403404
GET
/projects/{project_id}
GitHub Get Project
getProject 1 param → 200304401403
GET
/projects/{project_id}/collaborators/{username}/permission
GitHub Get Project Permission for User
getProjectPermissionForUser 2 params → 200304401403404422
GET
/rate_limit
GitHub Get Rate Limit
getRateLimit → 200304404
GET
/repos/{owner}/{repo}/actions/artifacts/{artifact_id}
GitHub Get an Artifact
getAnArtifact 6 params → 200
GET
/repos/{owner}/{repo}/actions/cache/usage
GitHub Get Github Actions Cache Usage for Repository
getGithubActionsCacheUsageForRepository 5 params → 200
GET
/repos/{owner}/{repo}/actions/cache/usage-policy
GitHub Get Github Actions Cache Usage Policy for Repository
getGithubActionsCacheUsagePolicyForRepository 5 params → 200
GET
/repos/{owner}/{repo}/actions/jobs/{job_id}
GitHub Get Job for Workflow Run
getJobForWorkflowRun 6 params → 200
GET
/repos/{owner}/{repo}/actions/oidc/customization/sub
GitHub Get the Customization Template for an Oidc Subject Claim for Repository
getTheCustomizationTemplateForAnOidcSubjectClaimForRepository 5 params → 200400404
GET
/repos/{owner}/{repo}/actions/permissions
GitHub Get Github Actions Permissions for Repository
getGithubActionsPermissionsForRepository 5 params → 200
GET
/repos/{owner}/{repo}/actions/permissions/access
GitHub Get the Level of Access for Workflows Outside of the Repository
getTheLevelOfAccessForWorkflowsOutsideOfTheRepository 5 params → 200
GET
/repos/{owner}/{repo}/actions/permissions/selected-actions
GitHub Get Allowed Actions for Repository
getAllowedActionsForRepository 5 params → 200
GET
/repos/{owner}/{repo}/actions/permissions/workflow
GitHub Get Default Workflow Permissions for Repository
getDefaultWorkflowPermissionsForRepository 5 params → 200
GET
/repos/{owner}/{repo}/actions/runners/{runner_id}
GitHub Get Self-hosted Runner for Repository
getSelfhostedRunnerForRepository 6 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}
GitHub Get Workflow Run
getWorkflowRun 7 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}/pending_deployments
GitHub Get Pending Deployments for Workflow Run
getPendingDeploymentsForWorkflowRun 6 params → 200
GET
/repos/{owner}/{repo}/actions/secrets/public-key
GitHub Get Repository Public Key
getRepositoryPublicKey 5 params → 200
GET
/repos/{owner}/{repo}/actions/secrets/{secret_name}
GitHub Get Repository Secret
getRepositorySecret 6 params → 200
GET
/repos/{owner}/{repo}/actions/variables/{name}
GitHub Get Repository Variable
getRepositoryVariable 6 params → 200
GET
/repos/{owner}/{repo}/actions/workflows/{workflow_id}
GitHub Get Workflow
getWorkflow 6 params → 200
GET
/repos/{owner}/{repo}/autolinks
GitHub Get All Autolinks of Repository
getAllAutolinksOfRepository 5 params → 200
GET
/repos/{owner}/{repo}/autolinks/{autolink_id}
GitHub Get an Autolink Reference of Repository
getAnAutolinkReferenceOfRepository 6 params → 200404
GET
/repos/{owner}/{repo}/branches/{branch}
GitHub Get Branch
getBranch 6 params → 200301404
GET
/repos/{owner}/{repo}/branches/{branch}/protection
GitHub Get Branch Protection
getBranchProtection 6 params → 200404
GET
/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins
GitHub Get Admin Branch Protection
getAdminBranchProtection 6 params → 200
GET
/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews
GitHub Get Pull Request Review Protection
getPullRequestReviewProtection 6 params → 200
GET
/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures
GitHub Get Commit Signature Protection
getCommitSignatureProtection 6 params → 200404
GET
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks
GitHub Get Status Checks Protection
getStatusChecksProtection 6 params → 200404
GET
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
GitHub Get All Status Check Contexts
getAllStatusCheckContexts 6 params → 200404
GET
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions
GitHub Get Access Restrictions
getAccessRestrictions 6 params → 200404
GET
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
GitHub Get Teams with Access to the Protected Branch
getTeamsWithAccessToTheProtectedBranch 6 params → 200404
GET
/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users
GitHub Get Users with Access to the Protected Branch
getUsersWithAccessToTheProtectedBranch 6 params → 200404
GET
/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}
GitHub Get Code Scanning Alert
getCodeScanningAlert 6 params → 200304403404503
GET
/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}
GitHub Get Code Scanning Analysis for Repository
getCodeScanningAnalysisForRepository 6 params → 200403404503
GET
/repos/{owner}/{repo}/code-scanning/default-setup
GitHub Get Code Scanning Default Setup Configuration
getCodeScanningDefaultSetupConfiguration 5 params → 200403404503
GET
/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}
GitHub Get Information About Sarif Upload
getInformationAboutSarifUpload 6 params → 200403404503
GET
/repos/{owner}/{repo}/collaborators/{username}/permission
GitHub Get Repository Permissions for User
getRepositoryPermissionsForUser 6 params → 200404
GET
/repos/{owner}/{repo}/dependabot/alerts/{alert_number}
GitHub Get Dependabot Alert
getDependabotAlert 6 params → 200304403404
GET
/repos/{owner}/{repo}/dependabot/secrets/public-key
GitHub Get Repository Public Key
getRepositoryDependabotSecretsPublicKey 5 params → 200
GET
/repos/{owner}/{repo}/dependabot/secrets/{secret_name}
GitHub Get Repository Secret
getRepositoryDependabotSecret 6 params → 200
GET
/repos/{owner}/{repo}/hooks/{hook_id}
GitHub Get Repository Webhook
getRepositoryWebhook 6 params → 200404
GET
/repos/{owner}/{repo}/hooks/{hook_id}/config
GitHub Get Webhook Configuration for Repository
getWebhookConfigurationForRepository 6 params → 200
GET
/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}
GitHub Get Delivery for Repository Webhook
getDeliveryForRepositoryWebhook 7 params → 200400422
GET
/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}
GitHub Get Pre-receive Hook for Repository
getPrereceiveHookForRepository 6 params → 200
GET
/repos/{owner}/{repo}/issues/comments/{comment_id}
GitHub Get an Issue Comment
getAnIssueComment 6 params → 200404
GET
/repos/{owner}/{repo}/issues/events/{event_id}
GitHub Get an Issue Event
getAnIssueEvent 6 params → 200403404410
GET
/repos/{owner}/{repo}/issues/{issue_number}
GitHub Get an Issue
getAnIssue 6 params → 200301304404410
GET
/repos/{owner}/{repo}/pulls/comments/{comment_id}
GitHub Get Review Comment for Pull Request
getReviewCommentForPullRequest 6 params → 200404
GET
/repos/{owner}/{repo}/pulls/{pull_number}
GitHub Get Pull Request
getPullRequest 6 params → 200304404500503
GET
/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
GitHub Get All Requested Reviewers for Pull Request
getAllRequestedReviewersForPullRequest 6 params → 200
GET
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}
GitHub Get Review for Pull Request
getReviewForPullRequest 7 params → 200404
GET
/repos/{owner}/{repo}/subscription
GitHub Get Repository Subscription
getRepositorySubscription 5 params → 200403404
GET
/repos/{owner}/{repo}
GitHub Get Repository
getRepository 5 params → 200301403404
GET
/repos/{owner}/{repo}/check-runs/{check_run_id}
GitHub Get Check Run
getCheckRun 6 params → 200
GET
/repos/{owner}/{repo}/check-suites/{check_suite_id}
GitHub Get Check Suite
getCheckSuite 6 params → 200
GET
/repos/{owner}/{repo}/comments/{comment_id}
GitHub Get Commit Comment
getCommitComment 6 params → 200404
GET
/repos/{owner}/{repo}/commits/{ref}
GitHub Get Commit
getCommit 8 params → 200404422500503
GET
/repos/{owner}/{repo}/commits/{ref}/status
GitHub Get the Combined Status for Specific Reference
getTheCombinedStatusForSpecificReference 8 params → 200404
GET
/repos/{owner}/{repo}/contents/{path}
GitHub Get Repository Content
getRepositoryContent 7 params → 200302403404
GET
/repos/{owner}/{repo}/dependency-graph/compare/{basehead}
GitHub Get Diff of the Dependencies Between Commits
getDiffOfTheDependenciesBetweenCommits 7 params → 200403404
GET
/repos/{owner}/{repo}/deployments/{deployment_id}
GitHub Get Deployment
getDeployment 6 params → 200404
GET
/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}
GitHub Get Deployment Status
getDeploymentStatus 7 params → 200404
GET
/repos/{owner}/{repo}/environments/{environment_name}
GitHub Get an Environment
getAnEnvironment 6 params → 200
GET
/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}
GitHub Get Deployment Branch Policy
getDeploymentBranchPolicy 7 params → 200
GET
/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key
GitHub Get an Environment Public Key
getAnEnvironmentPublicKey 6 params → 200
GET
/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}
GitHub Get an Environment Secret
getAnEnvironmentSecret 7 params → 200
GET
/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}
GitHub Get an Environment Variable
getAnEnvironmentVariable 7 params → 200
GET
/repos/{owner}/{repo}/git/blobs/{file_sha}
GitHub Get Blob
getBlob 6 params → 200403404422
GET
/repos/{owner}/{repo}/git/commits/{commit_sha}
GitHub Get Commit Object
getCommitObject 6 params → 200404
GET
/repos/{owner}/{repo}/git/ref/{ref}
GitHub Get Reference
getReference 6 params → 200404
GET
/repos/{owner}/{repo}/git/tags/{tag_sha}
GitHub Get Tag
getTag 6 params → 200404
GET
/repos/{owner}/{repo}/git/trees/{tree_sha}
GitHub Get Tree
getTree 7 params → 200404422
GET
/repos/{owner}/{repo}/keys/{key_id}
GitHub Get Deploy Key
getDeployKey 6 params → 200404
GET
/repos/{owner}/{repo}/labels/{name}
GitHub Get Label
getLabel 6 params → 200404
GET
/repos/{owner}/{repo}/license
GitHub Get the License for Repository
getTheLicenseForRepository 5 params → 200404
GET
/repos/{owner}/{repo}/milestones/{milestone_number}
GitHub Get Milestone
getMilestone 6 params → 200404
GET
/repos/{owner}/{repo}/pages
GitHub Get Github Enterprise Server Pages Site
getGithubEnterpriseServerPagesSite 5 params → 200404
GET
/repos/{owner}/{repo}/pages/builds/latest
GitHub Get Latest Pages Build
getLatestPagesBuild 5 params → 200
GET
/repos/{owner}/{repo}/pages/builds/{build_id}
GitHub Get Github Enterprise Server Pages Build
getGithubEnterpriseServerPagesBuild 6 params → 200
GET
/repos/{owner}/{repo}/readme
GitHub Get Repository Readme
getRepositoryReadme 6 params → 200404422
GET
/repos/{owner}/{repo}/readme/{dir}
GitHub Get Repository Readme for Directory
getRepositoryReadmeForDirectory 7 params → 200404422
GET
/repos/{owner}/{repo}/releases/assets/{asset_id}
GitHub Get Release Asset
getReleaseAsset 6 params → 200302404
GET
/repos/{owner}/{repo}/releases/latest
GitHub Get the Latest Release
getTheLatestRelease 5 params → 200
GET
/repos/{owner}/{repo}/releases/tags/{tag}
GitHub Get Release by Tag Name
getReleaseByTagName 6 params → 200404
GET
/repos/{owner}/{repo}/releases/{release_id}
GitHub Get Release
getRelease 6 params → 200401
GET
/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}
GitHub Get Secret Scanning Alert
getSecretScanningAlert 6 params → 200304404503
GET
/repos/{owner}/{repo}/stats/code_frequency
GitHub Get the Weekly Commit Activity
getTheWeeklyCommitActivity 5 params → 200202204
GET
/repos/{owner}/{repo}/stats/commit_activity
GitHub Get the Last Year of Commit Activity
getTheLastYearOfCommitActivity 5 params → 200202204
GET
/repos/{owner}/{repo}/stats/contributors
GitHub Get All Contributor Commit Activity
getAllContributorCommitActivity 5 params → 200202204
GET
/repos/{owner}/{repo}/stats/participation
GitHub Get the Weekly Commit Count
getTheWeeklyCommitCount 5 params → 200404
GET
/repos/{owner}/{repo}/stats/punch_card
GitHub Get the Hourly Commit Count for Each Day
getTheHourlyCommitCountForEachDay 5 params → 200204
GET
/repos/{owner}/{repo}/topics
GitHub Get All Repository Topics
getAllRepositoryTopics 7 params → 200404
GET
/scim/v2/Groups/{scim_group_id}
GitHub Get Scim Provisioning Information for an Enterprise Group
getScimProvisioningInformationForAnEnterpriseGroup 2 params → 200400401403404429500
GET
/scim/v2/Users/{scim_user_id}
GitHub Get Scim Provisioning Information for an Enterprise User
getScimProvisioningInformationForAnEnterpriseUser 1 param → 200400401403404429500
GET
/setup/api/configcheck
GitHub Get the Configuration Status
getTheConfigurationStatus → 200401
GET
/setup/api/maintenance
GitHub Get the Maintenance Status
getTheMaintenanceStatus → 200401
GET
/setup/api/settings
GitHub Get Settings
getSettings → 200401
GET
/setup/api/settings/authorized-keys
GitHub Get All Authorized Ssh Keys
getAllAuthorizedSshKeys → 200401
GET
/teams/{team_id}deprecated
GitHub Get Team (legacy)
getTeamLegacy 1 param → 200404
GET
/teams/{team_id}/discussions/{discussion_number}deprecated
GitHub Get Discussion (legacy)
getDiscussionLegacy 2 params → 200
GET
/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}deprecated
GitHub Get Discussion Comment (legacy)
getDiscussionCommentLegacy 3 params → 200
GET
/teams/{team_id}/members/{username}deprecated
GitHub Get Team Member (legacy)
getTeamMemberLegacy 2 params → 204404
GET
/teams/{team_id}/memberships/{username}deprecated
GitHub Get Team Membership for User (legacy)
getTeamMembershipForUserLegacy 2 params → 200404
GET
/zen
GitHub Get the Zen of Github
getTheZenOfGithub → 200

Schemas 287

The contract defines 287 schemas that model the data the API accepts and returns. The most detailed are full-repository (102 properties), repository (95 properties), repository_3 (95 properties), nullable-repository (95 properties). Each schema is shown below with its type and property counts.

installation
object
Installation
20 properties 17 required
scim-error
object
Scim Error
6 properties
webhook-config-content-type
string
The media type used to serialize the payloads. Supported values include json and form. The default is form.
simple-user
object
A GitHub user.
21 properties 18 required
validation-error
object
Validation Error
3 properties 2 required
webhook-config-secret
string
If provided, the secret will be used as the key to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-serve…
basic-error
object
Basic Error
4 properties
webhook-config-url
string
The URL to which the payloads will be delivered.
webhook-config-insecure-ssl
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
environment-approvals
object
An entry in the reviews log for environment deployments
4 properties 4 required
app-permissions
object
The permissions granted to the user access token.
45 properties
application-grant
object
The authorization associated with an OAuth Access.
7 properties 6 required
hook-delivery
object
Delivery made by a webhook.
14 properties 13 required
enterprise
object
An enterprise on GitHub.
10 properties 8 required
nullable-simple-user
objectnull
A GitHub user.
21 properties 18 required
webhook-config
object
Configuration object of the webhook
4 properties
nullable-scoped-installation
objectnull
7 properties 5 required
authorization
object
The authorization for an OAuth app, GitHub App, or a Personal Access Token.
15 properties 13 required
code-of-conduct
object
Code Of Conduct
5 properties 4 required
link-with-type
object
Hypermedia Link with Type
2 properties 2 required
feed
object
Feed
11 properties 3 required
gist-comment
object
A comment made to a gist.
8 properties 8 required
gist-simple
object
Gist Simple
21 properties
author-association
string
How the author is associated with the repository.
public-user
object
Public User
39 properties 31 required
gist-history
object
Gist History
5 properties
gitignore-template
object
Gitignore Template
2 properties 2 required
license
object
License
13 properties 13 required
ghes-replication-status-indicator
string
ghes-version
array
ghes-replication-status
object
2 properties
ghes-config-nodes
object
2 properties
ghes-cluster-topology
string
api-overview
object
Api Overview
5 properties 1 required
thread
object
Thread
9 properties 9 required
minimal-repository
object
Minimal Repository
87 properties 46 required
security-and-analysis
objectnull
3 properties
thread-subscription
object
Thread Subscription
7 properties 5 required
team-organization
object
Team Organization
48 properties 23 required
dependabot-public-key
object
The public key used for setting Dependabot Secrets.
2 properties 2 required
package
object
A software package
11 properties 9 required
allowed-actions
string
The permissions policy that controls the actions that are allowed to run.
actions-organization-permissions
object
4 properties 1 required
selected-actions
object
2 properties 2 required
runner
object
A self hosted runner
7 properties 6 required
runner-label
object
A label for a self hosted runner
3 properties 1 required
audit-log-event
object
43 properties
org-pre-receive-hook
object
5 properties
team-discussion-comment
object
A reply to a discussion within a team.
13 properties 12 required
organization-custom-repository-role
object
Custom repository roles created by organization owners
8 properties 7 required
org-hook
object
Org Hook
11 properties 10 required
announcement-message
stringnull
The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs…
team-full
object
Groups of organization members that gives permissions on specified repositories.
18 properties 15 required
runner-groups-org
object
12 properties 7 required
package-version
object
A version of a software package
11 properties 6 required
actions-can-approve-pull-request-reviews
boolean
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
organization-actions-variable
object
Organization variable for GitHub Actions.
6 properties 5 required
team-discussion
object
A team discussion is a persistent record of a free-form conversation within a team.
18 properties 17 required
nullable-team-simple
objectnull
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
organization-dependabot-secret
object
Secrets for GitHub Dependabot for an organization.
5 properties 4 required
nullable-license-simple
objectnull
License Simple
6 properties 5 required
actions-public-key
object
The public key used for setting Actions Secrets.
6 properties 2 required
actions-get-default-workflow-permissions
object
2 properties 2 required
announcement-banner
object
Announcement at either the repository, organization, or enterprise level
3 properties 3 required
announcement-expiration
stringnull
The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format: YYYY-MM-DDTHH:MM:SSZ. To set an an…
actions-default-workflow-permissions
string
The default workflow permissions granted to the GITHUBTOKEN when running workflows.
organization-simple
object
A GitHub organization.
12 properties 12 required
enabled-repositories
string
The policy that controls the repositories in the organization that are allowed to run GitHub Actions.
team-membership
object
Team Membership
3 properties 3 required
reaction-rollup
object
10 properties 10 required
actions-cache-usage-org-enterprise
object
2 properties 2 required
advanced-security-active-committers-user
object
2 properties 2 required
organization-actions-secret
object
Secrets for GitHub Actions for an organization.
5 properties 4 required
nullable-minimal-repository
objectnull
Minimal Repository
87 properties 46 required
announcement-user-dismissible
booleannull
Whether an announcement can be dismissed by the user.
advanced-security-active-committers
object
3 properties 1 required
repository
object
A repository on GitHub.
95 properties 73 required
external-group
object
Information about an external group's usage and its members
5 properties 4 required
selected-actions-url
string
The API URL to use to get or set the actions that are allowed to run, when allowedactions is set to selected.
organization-full
object
Organization Full
56 properties 23 required
oidc-custom-sub
object
Actions OIDC Subject customization
1 property 1 required
migration
object
A migration.
18 properties 16 required
org-membership
object
Org Membership
7 properties 6 required
advanced-security-active-committers-repository
object
3 properties 3 required
project-card
object
Project cards represent a scope of work.
13 properties 9 required
project-column
object
Project columns contain cards of work.
8 properties 8 required
project-collaborator-permission
object
Project Collaborator Permission
2 properties 2 required
project
object
Projects are a way to organize columns and cards of work.
15 properties 13 required
rate-limit
object
4 properties 4 required
rate-limit-overview
object
Rate Limit Overview
2 properties 2 required
pending-deployment
object
Details of a deployment that is waiting for protection rules to pass
5 properties 5 required
oidc-custom-sub-repo
object
Actions OIDC subject customization for a repository
2 properties 1 required
code-of-conduct_2
object
Code Of Conduct
5 properties 4 required
minimal-repository_2
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
actions-enabled
boolean
Whether GitHub Actions is enabled on the repository.
security-and-analysis_2
object
3 properties
scim-error_2
object
Scim Error
6 properties
simple-user_2
object
GitHub user.
21 properties 18 required
deployment-reviewer-type
string
The type of reviewer.
actions-secret
object
Set secrets for GitHub Actions.
3 properties 3 required
runner_2
object
self hosted runner
7 properties 6 required
referenced-workflow
object
workflow referenced/reused by the initial caller workflow
3 properties 2 required
runner-label_2
object
label for a self hosted runner
3 properties 1 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
actions-variable
object
4 properties 4 required
actions-repository-permissions
object
3 properties 1 required
nullable-team-simple_2
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
job
object
Information of a job execution in a workflow run
23 properties 21 required
artifact
object
An artifact
11 properties 10 required
actions-cache-usage-policy-for-repository
object
GitHub Actions cache usage policy for repository.
1 property 1 required
nullable-simple-commit
object
commit.
6 properties 6 required
actions-cache-usage-by-repository
object
GitHub Actions Cache Usage by repository.
3 properties 3 required
autolink
object
An autolink reference.
4 properties 4 required
status-check-policy
object
Status Check Policy
5 properties 5 required
branch-with-protection
object
Branch With Protection
8 properties 6 required
protected-branch-required-status-check
object
Protected Branch Required Status Check
6 properties 2 required
team_2
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
branch-restriction-policy
object
Branch Restriction Policy
7 properties 7 required
diff-entry
object
Diff Entry
11 properties 9 required
commit
object
Commit
11 properties 9 required
nullable-git-user
object
Metaproperties for Git author/committer information.
3 properties
simple-user_3
object
GitHub user.
21 properties 18 required
protected-branch-pull-request-review
object
Protected Branch Pull Request Review
7 properties 2 required
verification
object
4 properties 4 required
branch-protection
object
Branch Protection
16 properties
protected-branch-admin-enforced
object
Protected Branch Admin Enforced
2 properties 2 required
integration_2
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
nullable-team-simple_3
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
empty-object
object
An object without any properties.
nullable-simple-user_2
object
GitHub user.
21 properties 18 required
code-scanning-analysis-analysis-key
string
Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
code-scanning-ref
string
The Git reference, formatted as refs/pull/ /merge, refs/pull/ /head, refs/heads/ or simply .
code-scanning-alert-state
string
State of a code scanning alert.
alert-created-at
string
The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-default-setup
object
Configuration for code scanning default setup.
4 properties
code-scanning-alert-instance
object
10 properties
alert-html-url
string
The GitHub URL of the alert resource.
code-scanning-analysis-environment
string
Identifies the variable values associated with the environment in which this analysis was performed.
alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-alert
object
15 properties 12 required
code-scanning-alert-rule
object
9 properties
code-scanning-analysis-tool-guid
string
The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.
code-scanning-analysis-tool-name
string
The name of the tool used to generate the code scanning analysis.
code-scanning-analysis-category
string
Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed o…
alert-instances-url
string
The REST API URL for fetching the list of instances for an alert.
code-scanning-analysis-commit-sha
string
The SHA of the commit to which the analysis you are uploading relates.
alert-number
integer
The security alert number.
code-scanning-analysis-created-at
string
The time that the analysis was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
alert-fixed-at
string
The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
alert-dismissed-at
string
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-analysis-tool-version
string
The version of the tool used to generate the code scanning analysis.
nullable-simple-user_3
object
GitHub user.
21 properties 18 required
code-scanning-analysis-sarif-id
string
An identifier for the upload.
code-scanning-analysis
object
15 properties 14 required
code-scanning-alert-location
object
Describe a region within a file for the alert.
5 properties
code-scanning-sarifs-status
object
3 properties
code-scanning-analysis-url
string
The REST API URL of the analysis resource.
code-scanning-analysis-tool
object
3 properties
code-scanning-alert-dismissed-comment
string
The dismissal comment associated with the dismissal of the alert.
code-scanning-alert-dismissed-reason
string
Required when the state is dismissed. The reason for dismissing or closing the alert.
alert-url
string
The REST API URL of the alert resource.
code-scanning-alert-classification
string
classification of the file. For example to identify it as generated.
code-scanning-alert-environment
string
Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language tha…
nullable-collaborator
object
Collaborator
22 properties 18 required
repository-collaborator-permission
object
Repository Collaborator Permission
3 properties 3 required
dependabot-alert-package
object
Details for the vulnerable package.
2 properties 2 required
alert-auto-dismissed-at
string
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
dependabot-secret
object
Set secrets for Dependabot.
3 properties 3 required
dependabot-alert-security-vulnerability
object
Details pertaining to one vulnerable version range for the advisory.
4 properties 4 required
dependabot-alert-security-advisory
object
Details for the GitHub Security Advisory.
13 properties 13 required
dependabot-alert
object
Dependabot alert.
15 properties 14 required
nullable-simple-user_4
object
GitHub user.
21 properties 18 required
repository-pre-receive-hook
object
4 properties
scim-error_3
object
Scim Error
6 properties
hook-response
object
3 properties 3 required
validation-error_2
object
Validation Error
3 properties 2 required
hook
object
Webhooks for repositories.
13 properties 12 required
hook-delivery_2
object
Delivery made by a webhook.
15 properties 13 required
team_3
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
issue-comment
object
Comments provide a way for people to collaborate on an issue.
14 properties 9 required
issue-event-rename
object
Issue Event Rename
2 properties 2 required
nullable-issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties 21 required
simple-user_4
object
GitHub user.
21 properties 18 required
issue-event-milestone
object
Issue Event Milestone
1 property 1 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
issue-event-label
object
Issue Event Label
2 properties 2 required
repository_2
object
repository on GitHub.
95 properties 73 required
nullable-license-simple_2
object
License Simple
6 properties 5 required
issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties 21 required
nullable-team-simple_4
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
issue-event-project-card
object
Issue Event Project Card
6 properties 5 required
issue-event
object
Issue Event
22 properties 8 required
nullable-simple-user_5
object
GitHub user.
21 properties 18 required
nullable-milestone
object
collection of related issues and pull requests.
16 properties 16 required
issue-event-dismissed-review
object
4 properties 3 required
pull-request-review-request
object
Pull Request Review Request
2 properties 2 required
link
object
Hypermedia Link
1 property 1 required
team_4
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
pull-request
object
Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of…
48 properties 42 required
simple-user_5
object
GitHub user.
21 properties 18 required
team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
nullable-team-simple_5
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
auto-merge
object
The status of auto merging a pull request.
4 properties 4 required
pull-request-review-comment
object
Pull Request Review Comments are comments on a portion of the Pull Request's diff.
29 properties 16 required
pull-request-review
object
Pull Request Reviews are reviews on pull requests.
13 properties 10 required
nullable-simple-user_6
object
GitHub user.
21 properties 18 required
nullable-milestone_2
object
collection of related issues and pull requests.
16 properties 16 required
nullable-license-simple_3
object
License Simple
6 properties 5 required
repository-subscription
object
Repository invitations let you manage who you collaborate with.
6 properties 6 required
git-tree
object
The hierarchy between files in a Git repository.
4 properties 4 required
participation-stats
object
2 properties 2 required
check-suite
object
suite of checks performed on the code of a given code change
19 properties 17 required
wait-timer
integer
The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
code-frequency-stat
array
Code Frequency Stat
deployment-simple
object
deployment created as the result of an Actions check run from a workflow that references an environment
14 properties 10 required
simple-commit
object
commit.
6 properties 6 required
pages-https-certificate
object
4 properties 3 required
content-file
object
Content File
14 properties 12 required
content-submodule
object
An object describing a submodule
11 properties 11 required
commit-activity
object
Commit Activity
3 properties 3 required
combined-commit-status
object
Combined Commit Status
7 properties 7 required
release
object
release.
22 properties 17 required
blob
object
Blob
7 properties 6 required
check-run
object
check performed on the code of a given code change
17 properties 16 required
content-tree
object
Content Tree
11 properties 12 required
nullable-simple-user_7
object
GitHub user.
21 properties 18 required
secret-scanning-alert-resolution
string
Required when the state is resolved. The reason for resolving the alert.
secret-scanning-alert-state
string
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
team_5
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
commit_2
object
Commit
11 properties 9 required
git-commit
object
Low-level Git commit operations within a repository
10 properties 10 required
validation-error_3
object
Validation Error
3 properties 2 required
release-asset
object
Data related to a release.
13 properties 13 required
page-build
object
Page Build
8 properties 8 required
nullable-team-simple_6
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
deployment-branch-policy
object
Details of a deployment branch policy.
3 properties
nullable-license-simple_4
object
License Simple
6 properties 5 required
nullable-repository
object
repository on GitHub.
95 properties 73 required
content-directory
array
list of directory items
code-of-conduct_3
object
Code Of Conduct
5 properties 4 required
minimal-repository_3
object
Minimal Repository
87 properties 46 required
security-and-analysis_3
object
3 properties
label
object
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
7 properties 7 required
milestone
object
collection of related issues and pull requests.
16 properties 16 required
nullable-alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
dependency-graph-diff
array
diff of the dependencies between two commits.
deployment
object
request for a specific ref(branch,sha,tag) to be deployed
18 properties 14 required
environment
object
Details of a deployment environment
9 properties 7 required
topic
object
topic aggregates entities that are related to a subject.
1 property 1 required
installation_2
object
Installation
20 properties 17 required
git-ref
object
Git references within a repository
4 properties 4 required
git-tag
object
Metadata for a Git tag
8 properties 7 required
pages-source-hash
object
2 properties 2 required
simple-user_6
object
GitHub user.
21 properties 18 required
simple-commit-status
object
11 properties 10 required
nullable-integration_2
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
repository_3
object
repository on GitHub.
95 properties 73 required
page
object
The configuration for GitHub Pages for a repository.
12 properties 5 required
deploy-key
object
An SSH key granting access to a single repository.
9 properties 7 required
commit-comment
object
Commit Comment
14 properties 13 required
contributor-activity
object
Contributor Activity
3 properties 3 required
code-of-conduct-simple
object
Code of Conduct Simple
4 properties 4 required
license-content
object
License Content
13 properties 13 required
content-symlink
object
An object describing a symlink
11 properties 11 required
full-repository
object
Full Repository
102 properties 75 required
secret-scanning-alert
object
17 properties
enterprise_2
object
An enterprise on GitHub.
10 properties 8 required
deployment-status
object
The status of a deployment.
15 properties 11 required
deployment-branch-policy-settings
object
The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.
2 properties 2 required
user-emails-response
array
The emails for the user.
user-role
array
The roles assigned to the user.
user-response
object
8 properties 3 required
scim-enterprise-user-response
scim-enterprise-group-response
user-name-response
object
4 properties
group-response
object
4 properties 1 required
meta
object
The metadata associated with the creation/updates to the user.
4 properties 1 required
maintenance-status
object
3 properties
ssh-key
object
2 properties
configuration-status
object
2 properties
enterprise-settings
object
2 properties
team_6
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-get-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Get 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.