GitHub REST API
GitHub REST API — The GitHub REST API allows developers to create integra…
GitHub REST API exposes the GitHub REST API allows developers to create integrations, retrieve data, and automate workflows on the GitHub platform. It provides access to various functionalities, enabling interaction with repositories, issues, pull requests, and user accounts among others. We verified a keyless GET endpoint returning JSON (Development). Check the provider docs for rate limits and terms before production use.
We probe a documented GET and expect 2xx JSON — full uptime and health score. Open provider docs ↗
On our probe schedule. Uptime charts appear after the first check lands.
GET https://docs.github.com/api/article?pathname=/en/rest
{
"meta": {
"title": "GitHub REST API documentation",
"intro": "Create integrations, retrieve data, and automate your workflows with the GitHub REST API.",
"product": "REST API",
"breadcrumbs": [
{
"href": "/en/rest",
"title": "REST API"
}
],
"documentType": "product"
},
"body": "# GitHub REST API documentation\n\nCreate integrations, retrieve data, and automate your workflows with the GitHub REST API.\n\n## Recommended\n\n* [Quickstart for GitHub REST API](/en/rest/quickstart)\n\n Learn how to get started with the GitHub REST API.\n\n* [Getting started with the REST API](/en/rest/using-the-rest-api/getting-started-with-the-rest-api)\n\n Learn how to use the GitHub REST API.\n\n* [Authenticating to the REST API](/en/rest/authentication/authenticating-to-the-rest-api)\n\n You can authenticate to the REST API to access more endpoints and have a higher rate limit.\n\n* [Best practices for using the REST API](/en/rest/using-the-rest-api/best-practices-for-using-the-rest-api)\n\n Follow these best practices when using GitHub's API.\n\n* [Rate limits for the REST API](/en/rest/using-the-rest-api/rate-limits-for-the-rest-api)\n\n Learn about REST API rate limits, how to avoid exceeding them, and what to do if you do exceed them.\n\n* [Keeping your API credentials secure](/en/rest/authentication/keeping-your-api-credentials-secure)\n\n Follow these best practices to keep your API credentials and tokens secure.\n\n* [Scripting with the REST API and JavaScript](/en/rest/guides/scripting-with-the-rest-api-and-javascript)\n\n Write a script using the Octokit.js SDK to interact with the REST API.\n\n* [Troubleshooting the REST API](/en/rest/using-the-rest-api/troubleshooting-the-rest-api)\n\n Learn how to diagnose and resolve common problems for the REST API.\n\n* [Using pagination in the REST API](/en/rest/using-the-rest-api/using-pagination-in-the-rest-api)\n\n Learn how to navigate through paginated responses from the REST API.\n\n## Links\n\n### Getting started\n\n* [About the REST API](/en/rest/about-the-rest-api/about-the-rest-api)\n\n Get oriented to the REST API documentation.\n\n* [Quickstart for GitHub REST API](/en/rest/quickstart)\n\n Learn how to get started with the GitHub REST API.\n\n## Articles\n\n* [Quickstart for GitHub REST API](/en/rest/quickstart)\n\n Learn how to get started with the GitHub REST API.\n\n* [About the REST API](/en/rest/about-the-rest-api/about-the-rest-api)\n\n Get oriented to the REST API documentation.\n\n* [Comparing GitHub's REST API and GraphQL API](/en/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api)\n\n Learn about GitHub's APIs to extend and customize your GitHub experience.\n\n* [API Versions](/en/rest/about-the-rest-api/api-versions)\n\n Learn how to specify which REST API version to use whenever you make a request to the REST API.\n\n* [Breaking changes](/en/rest/about-the-rest-api/breaking-changes)\n\n Learn about breaking changes that were introduced in each REST API version.\n\n* [About the OpenAPI description for the REST API](/en/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api)\n\n The GitHub REST API is fully described in an OpenAPI compliant document.\n\n* [Getting started with the REST API](/en/rest/using-the-rest-api/getting-started-with-the-rest-api)\n\n Learn how to use the GitHub REST API.\n\n* [Rate limits for the REST API](/en/rest/using-the-rest-api/rate-limits-for-the-rest-api)\n\n Learn about REST API rate limits, how to avoid exceeding them, and what to do if you do exceed them.\n\n* [Using pagination in the REST API](/en/rest/using-the-rest-api/using-pagination-in-the-rest-api)\n\n Learn how to navigate through paginated responses from the REST API.\n\n* [Libraries for the REST API](/en/rest/using-the-rest-api/libraries-for-the-rest-api)\n\n You can use the official Octokit libraries and other third-party libraries to extend and simplify how you use the GitHub API.\n\n* [Best practices for using the REST API](/en/rest/using-the-rest-api/best-practices-for-using-the-rest-api)\n\n Follow these best practices when using GitHub's API.\n\n* [Troubleshooting the REST API](/en/rest/using-the-rest-api/troubleshooting-the-rest-api)\n\n Learn how to diagnose and resolve common problems for the REST API.\n\n* [Timezones and the REST API](/en/rest/using-the-rest-api/timezones-and-the-rest-api)\n\n Some REST API endpoints allow you to specify timezone information with your request.\n\n* [Using CORS and JSONP to make cross-origin requests](/en/rest/using-the-rest-api/using-cors-and-jsonp-to-make-cross-origin-requests)\n\n You can make API requests across domains using cross-origin resource sharing (CORS) and JSONP callbacks.\n\n* [Issue event types](/en/rest/using-the-rest-api/issue-event-types)\n\n For the REST APIs for issue events and timeline events, learn about each event type, the triggering action on GitHub, and each event's unique properties.\n\n* [GitHub event types](/en/rest/using-the-rest-api/github-event-types)\n\n For the GitHub Events API, learn about each event type, the triggering action on GitHub, and each event's unique properties.\n\n* [Authenticating to the REST API](/en/rest/authentication/authenticating-to-the-rest-api)\n\n You can authenticate to the REST API to access more endpoints and have a higher rate limit.\n\n* [Keeping your API credentials secure](/en/rest/authentication/keeping-your-api-credentials-secure)\n\n Follow these best practices to keep your API credentials and tokens secure.\n\n* [Endpoints available for GitHub App installation access tokens](/en/rest/authentication/endpoints-available-for-github-app-installation-access-tokens)\n\n Your GitHub App can make requests to the following REST endpoints with an installation access token.\n\n* [Endpoints available for GitHub App user access tokens](/en/rest/authentication/endpoints-available-for-github-app-user-access-tokens)\n\n Your GitHub App can make requests to the following REST endpoints with a user access token.\n\n* [Endpoints available for fine-grained personal access tokens](/en/rest/authentication/endpoints-available-for-fine-grained-personal-access-tokens)\n\n Your fine-grained personal access token can make requests to the following REST endpoints.\n\n* [Permissions required for GitHub Apps](/en/rest/authentication/permissions-required-for-github-apps)\n\n For each permission granted to a GitHub App, these are the REST API endpoints that the app can use.\n\n* [Permissions required for fine-grained personal access tokens](/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens)\n\n For each permission granted to a fine-grained personal access token, these are the REST API endpoints that the app can use.\n\n* [Scripting with the REST API and JavaScript](/en/rest/guides/scripting-with-the-rest-api-and-javascript)\n\n Write a script using the Octokit.js SDK to interact with the REST API.\n\n* [Scripting with the REST API and Ruby](/en/rest/guides/scripting-with-the-rest-api-and-ruby)\n\n Learn how to write a script using the Octokit.rb SDK to interact with the REST API.\n\n* [Discovering resources for a user](/en/rest/guides/discovering-resources-for-a-user)\n\n Learn how to find the repositories and organizations that your app can access for a user in a reliable way for your authenticated requests to the REST API.\n\n* [Delivering deployments](/en/rest/guides/delivering-deployments)\n\n Using the Deployments REST API, you can build custom tooling that interacts with your server and a third-party app.\n\n* [Rendering data as graphs](/en/rest/guides/rendering-data-as-graphs)\n\n Learn how to visualize the programming languages from your repository using the D3.js library and Ruby Octokit.\n\n* [Working with comments](/en/rest/guides/working-with-comments)\n\n Using the REST API, you can access and manage comments in your pull requests, issues, or commits.\n\n* [Building a CI server](/en/rest/guides/building-a-ci-server)\n\n Build your own CI system using the Status API.\n\n* [Using the REST API to interact with your Git database](/en/rest/guides/using-the-rest-api-to-interact-with-your-git-database)\n\n Use the REST API to read and write raw Git objects to your Git database on GitHub and to list and update your references (branch heads and tags).\n\n* [Using the REST API to interact with checks](/en/rest/guides/using-the-rest-api-to-interact-with-checks)\n\n You can use the REST API to build GitHub Apps that run powerful checks against code changes in a repository. You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits.\n\n* [Encrypting secrets for the REST API](/en/rest/guides/encrypting-secrets-for-the-rest-api)\n\n In order to create or update a secret with the REST API, you must encrypt the value of the secret.\n\n* [REST API endpoints for GitHub Actions artifacts](/en/rest/actions/artifacts)\n\n Use the REST API to interact with artifacts in GitHub Actions.\n\n* [REST API endpoints for GitHub Actions cache](/en/rest/actions/cache)\n\n Use the REST API to interact with the cache for repositories in GitHub Actions.\n\n* [REST API endpoints for Actions concurrency groups](/en/rest/actions/concurrency-groups)\n\n Use the REST API to view and manage concurrency groups for GitHub Actions workflows.\n\n* [GitHub-hosted runners](/en/rest/actions/hosted-runners)\n\n Use the REST API to interact with GitHub-hosted runners in GitHub Actions.\n\n* [REST API endpoints for GitHub Actions OIDC](/en/rest/actions/oidc)\n\n Use the REST API to interact with JWTs for OIDC subject claims in GitHub Actions.\n\n* [REST API endpoints for GitHub Actions permissions](/en/rest/actions/permissions)\n\n Use the REST API to interact with permissions for GitHub Actions.\n\n* [REST API endpoints for GitHub Actions Secrets](/en/rest/actions/secrets)\n\n Use the REST API to interact with secrets in GitHub Actions.\n\n* [REST API endpoints for self-hosted runner groups](/en/rest/actions/self-hosted-runner-groups)\n\n Use the REST API to interact with self-hosted runner groups for GitHub Actions.\n\n* [REST API endpoints for self-hosted runners](/en/rest/actions/self-hosted-runners)\n\n Use the REST API to interact with self-hosted runners in GitHub Actions.\n\n* [REST API endpoints for GitHub Actions variables](/en/rest/actions/variables)\n\n Use the REST API to interact with variables in GitHub Actions.\n\n* [REST API endpoints for workflow jobs](/en/rest/actions/workflow-jobs)\n\n Use the REST API to interact with workflow jobs in GitHub Actions.\n\n* [REST API endpoints for workflow runs](/en/rest/actions/workflow-runs)\n\n Use the REST API to interact with workflow runs in GitHub Actions.\n\n* [REST API endpoints for workflows](/en/rest/actions/workflows)\n\n Use the REST API to interact with workflows in GitHub Actions.\n\n* [REST API endpoints for events](/en/rest/activity/events)\n\n Use the REST API to interact with GitHub events.\n\n* [REST API endpoints for feeds](/en/rest/activity/feeds)\n\n Use the REST API to interact with GitHub feeds.\n\n* [REST API endpoints for notifications](/en/rest/activity/notifications)\n\n Use the REST API to manage GitHub notifications.\n\n* [REST API endpoints for starring](/en/rest/activity/starring)\n\n Use the REST API to bookmark a repository.\n\n* [REST API endpoints for watching](/en/rest/activity/watching)\n\n Use the REST API to subscribe to notifications for activity in a repository.\n\n* [REST API endpoints for agent tasks](/en/rest/agent-tasks/agent-tasks)\n\n Use the REST API to start and manage Copilot cloud agent tasks\n\n* [REST API endpoints for agent secrets](/en/rest/agents/secrets)\n\n Use the REST API to manage secrets for agents.\n\n* [REST API endpoints for variables](/en/rest/agents/variables)\n\n Use the REST API to manage variables.\n\n* [REST API endpoints for announcement banners](/en/announcement-banners)\n\n The Announcement Banners API enables you to view, create, and remove an announcement banner for your enterprise or organization.\n\n* [REST API endpoints for GitHub Apps](/en/rest/apps/apps)\n\n Use the REST API to interact with GitHub Apps\n\n* [REST API endpoints for GitHub App installations](/en/rest/apps/installations)\n\n Use the REST API to get information about GitHub App installations and perform actions within those installations.\n\n* [REST API endpoints for GitHub Marketplace](/en/rest/apps/marketplace)\n\n Use the REST API to interact with GitHub Marketplace\n\n* [REST API endpoints for OAuth authorizations](/en/rest/apps/oauth-applications)\n\n Use the REST API to interact with OAuth apps and OAuth authorizations of GitHub Apps\n\n* [REST API endpoints for GitHub App webhooks](/en/rest/apps/webhooks)\n\n Use the REST API to interact with webhooks for OAuth apps\n\n* [REST API endpoints for billing](/en/billing)\n\n Use the REST API to get billing information.\n\n* [Budgets](/en/rest/billing/budgets)\n\n Use the REST API to get budget information.\n\n* [Cost centers](/en/cost-centers)\n\n Use the REST API to get cost center information.\n\n* [Billing usage](/en/rest/billing/usage)\n\n Use the REST API to get billing usage information.\n\n* [Usage reports](/en/usage-reports)\n\n Use the REST API to create and retrieve usage report exports for an enterprise.\n\n* [REST API endpoints for branches](/en/rest/branches/branches)\n\n Use the REST API to modify branches and their protection settings.\n\n* [REST API endpoints for protected branches](/en/rest/branches/branch-protection)\n\n Use the REST API to manage protected branches.\n\n* [REST API endpoints for security campaigns](/en/rest/campaigns/campaigns)\n\n Use the REST API to create and manage security campaigns for your organization.\n\n* [REST API endpoints for check runs](/en/rest/checks/runs)\n\n Use the REST API to manage check runs.\n\n* [REST API endpoints for check suites](/en/rest/checks/suites)\n\n Use the REST API to manage check suites.\n\n* [REST API endpoints for GitHub Classroom](/en/rest/classroom/classroom)\n\n Use the REST API to interact with GitHub Classroom.\n\n* [REST API endpoints for code quality](/en/rest/code-quality/code-quality)\n\n Use the REST API to manage a code quality configuration.\n\n* [REST API endpoints for code scanning alert dismissal requests](/en/alert-dismissal-requests)\n\n Use the REST API to interact with code scanning alert dismissal requests from a repository.\n\n* [REST API endpoints for code scanning](/en/rest/code-scanning/code-scanning)\n\n Use the REST API to retrieve and update code scanning alerts from a repository.\n\n* [Configurations](/en/rest/code-security/configurations)\n\n Use the REST API to create and manage security configurations for your organization.\n\n* [REST API endpoints for codes of conduct](/en/rest/codes-of-conduct/codes-of-conduct)\n\n Use the REST API to get information about codes of conduct.\n\n* [REST API endpoints for Codespaces](/en/rest/codespaces/codespaces)\n\n Use the REST API to manage GitHub Codespaces.\n\n* [REST API endpoints for Codespaces organizations](/en/rest/codespaces/organizations)\n\n Use the REST API to manage your organization members codespaces.\n\n* [REST API endpoints for Codespaces organization secrets](/en/rest/codespaces/organization-secrets)\n\n Use the REST API to manage your organization-level Codespaces secrets.\n\n* [REST API endpoints for Codespaces machines](/en/rest/codespaces/machines)\n\n Use the REST API to manage availability of machine types for a codespace.\n\n* [REST API endpoints for Codespaces repository secrets](/en/rest/codespaces/repository-secrets)\n\n Use the REST API to manage secrets for repositories that the user has access to in a codespace.\n\n* [REST API endpoints for Codespaces user secrets](/en/rest/codespaces/secrets)\n\n Use the REST API manage secrets that the user has access to in a codespace.\n\n* [REST API endpoints for collaborators](/en/rest/collaborators/collaborators)\n\n Use the REST API to manage collaborators for a repository.\n\n* [REST API endpoints for repository invitations](/en/rest/collaborators/invitations)\n\n Use the REST API to view and manage invitations to collaborate on a repository.\n\n* [REST API endpoints for commits](/en/rest/commits/commits)\n\n Use the REST API to interact with commits.\n\n* [REST API endpoints for commit comments](/en/rest/commits/comments)\n\n Use the REST API to interact with commit comments.\n\n* [REST API endpoints for commit statuses](/en/rest/commits/statuses)\n\n Use the REST API to interact with commit statuses.\n\n* [REST API endpoints for Copilot cloud agent repository management](/en/rest/copilot/copilot-cloud-agent-management)\n\n Use the REST API to manage repository-level settings for Copilot cloud agent.\n\n* [REST API endpoints for Copilot cloud agent management](/en/rest/copilot/copilot-coding-agent-management)\n\n Use the REST API to manage settings for Copilot cloud agent.\n\n* [REST API endpoints for Copilot content exclusion management](/en/rest/copilot/copilot-content-exclusion-management)\n\n Use the REST API to manage Copilot content exclusion rules.\n\n* [REST API endpoints for Copilot custom agents](/en/copilot-custom-agents)\n\n Use the REST API to manage Copilot custom agents for your enterprise.\n\n* [REST API endpoints for Copilot usage metrics](/en/rest/copilot/copilot-usage-metrics)\n\n Use the REST API to view Copilot usage metrics.\n\n* [REST API endpoints for Copilot user management](/en/rest/copilot/copilot-user-management)\n\n Use the REST API to manage the GitHub Copilot Business subscription for your organization.\n\n* [Copilot Spaces collaborators](/en/rest/copilot-spaces/collaborators)\n\n Use the REST API to manage collaborators for Copilot Spaces.\n\n* [REST API endpoints for Copilot Spaces](/en/rest/copilot-spaces/copilot-spaces)\n\n Use the REST API to manage Copilot Spaces and related resources.\n\n* [REST API endpoints for Copilot Spaces resources](/en/rest/copilot-spaces/resources)\n\n Use the REST API to interact with Copilot Spaces resources.\n\n* [Revocation](/en/rest/credentials/revoke)\n\n Use the REST API to revoke credentials that you have found exposed on GitHub or elsewhere.\n\n* [REST API endpoints for Dependabot alerts](/en/rest/dependabot/alerts)\n\n Use the REST API to interact with Dependabot alerts for a repository.\n\n* [REST API endpoints for Dependabot repository access](/en/rest/dependabot/repository-access)\n\n Use the REST API to manage which repositories Dependabot can access within an organization.\n\n* [REST API endpoints for Dependabot secrets](/en/rest/dependabot/secrets)\n\n Use the REST API to manage Dependabot secrets for an organization or repository.\n\n* [REST API endpoints for dependency review](/en/rest/dependency-graph/dependency-review)\n\n Use the REST API to interact with dependency changes.\n\n* [REST API endpoints for dependency submission](/en/rest/dependency-graph/dependency-submission)\n\n Use the REST API to submit dependencies.\n\n* [REST API endpoints for software bill of materials (SBOM)](/en/rest/dependency-graph/sboms)\n\n Use the REST API to export the software bill of materials (SBOM) for a repository.\n\n* [REST API endpoints for deploy keys](/en/rest/deploy-keys/deploy-keys)\n\n Use the REST API to create and manage deploy keys.\n\n* [REST API endpoints for deployment branch policies](/en/rest/deployments/branch-policies)\n\n Use the REST API to manage custom deployment branch policies.\n\n* [REST API endpoints for deployments](/en/rest/deployments/deployments)\n\n Use the REST API to create and delete deployments and deployment environments.\n\n* [REST API endpoints for deployment environments](/en/rest/deployments/environments)\n\n Use the REST API to create, configure, and delete deployment environments.\n\n* [REST API endpoints for protection rules](/en/rest/deployments/protection-rules)\n\n Use the REST API to create, configure, and delete deployment protection rules.\n\n* [REST API endpoints for deployment statuses](/en/rest/deployments/statuses)\n\n Use the REST API to manage deployment statuses.\n\n* [REST API endpoints for emojis](/en/rest/emojis/emojis)\n\n Use the REST API to list and view all the available emojis to use on GitHub.\n\n* [REST API endpoints for GitHub Enterprise administration](/en/enterprise-admin)\n\n Use the REST API to administer your enterprise.\n\n* [REST API endpoints for enterprise team memberships](/en/rest/enterprise-teams/enterprise-team-members)\n\n Use the REST API to create and manage membership of enterprise teams in your GitHub enterprise.\n\n* [REST API endpoints for enterprise team organizations](/en/rest/enterprise-teams/enterprise-team-organizations)\n\n Use the REST API to create and manage organization assignments for enterprise teams in your GitHub enterprise.\n\n* [REST API endpoints for enterprise teams](/en/rest/enterprise-teams/enterprise-teams)\n\n Use the REST API to create and manage enterprise teams in your GitHub enterprise.\n\n* [REST API endpoints for gists](/en/rest/gists/gists)\n\n Use the REST API to list, create, update and delete the public gists on GitHub.\n\n* [REST API endpoints for gist comments](/en/rest/gists/comments)\n\n Use the REST API to view and modify comments on a gist.\n\n* [REST API endpoints for Git blobs](/en/rest/git/blobs)\n\n Use the REST API to interact with a Git blob (binary large object), the object type used to store the contents of each file in a repository.\n\n* [REST API endpoints for Git commits](/en/rest/git/commits)\n\n Use the REST API to interact with commit objects in your Git database on GitHub.\n\n* [REST API endpoints for Git references](/en/rest/git/refs)\n\n Use the REST API to interact with references in your Git database on GitHub\n\n* [REST API endpoints for Git tags](/en/rest/git/tags)\n\n Use the REST API to interact with tag objects in your Git database on GitHub.\n\n* [REST API endpoints for Git trees](/en/rest/git/trees)\n\n Use the REST API to interact with tree objects in your Git database on GitHub.\n\n* [REST API endpoints for gitignore](/en/rest/gitignore/gitignore)\n\n Use the REST API to get `.gitignore` templates that can be used to ignore files and directories.\n\n* [REST API endpoints for organization interactions](/en/rest/interactions/orgs)\n\n Use the REST API to temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories.\n\n* [REST API endpoints for repository interactions](/en/rest/interactions/repos)\n\n Use the REST API to temporarily restrict which type of user can comment, open issues, or create pull requests in a public repository.\n\n* [REST API endpoints for user interactions](/en/rest/interactions/user)\n\n Use the REST API to temporarily restrict which type of user can comment, open issues, or create pull requests in your public repositories.\n\n* [REST API endpoints for issue assignees](/en/rest/issues/assignees)\n\n Use the REST API to manage assignees on issues and pull requests.\n\n* [REST API endpoints for issue comments](/en/rest/issues/comments)\n\n Use the REST API to manage comments on issues and pull requests.\n\n* [REST API endpoints for issue events](/en/rest/issues/events)\n\n Use the REST API to retrieve events triggered by activity in issues and pull requests.\n\n* [REST API endpoints for issue dependencies](/en/rest/issues/issue-dependencies)\n\n Use the REST API to view, add, and remove issue dependencies.\n\n* [REST API endpoints for issue field values](/en/rest/issues/issue-field-values)\n\n Use the REST API to view and manage issue field values for issues.\n\n* [REST API endpoints for issues](/en/rest/issues/issues)\n\n Use the REST API to manage issues and pull requests.\n\n* [REST API endpoints for labels](/en/rest/issues/labels)\n\n Use the REST API to manage labels for repositories, issues and pull requests.\n\n* [REST API endpoints for milestones](/en/rest/issues/milestones)\n\n Use the REST API to manage milestones.\n\n* [REST API endpoints for sub-issues](/en/rest/issues/sub-issues)\n\n Use the REST API to view, add, remove, and reprioritize sub-issues.\n\n* [REST API endpoints for timeline events](/en/rest/issues/timeline)\n\n Use the REST API to receive events triggered by timeline activity in issues and pull requests.\n\n* [REST API endpoints for licenses](/en/rest/licenses/licenses)\n\n Use the REST API to retrieve popular open source licenses and information about a particular project's license file.\n\n* [REST API endpoints for Markdown](/en/rest/markdown/markdown)\n\n Use the REST API to render a markdown document as an HTML page or as raw text.\n\n* [REST API endpoints for meta data](/en/rest/meta/meta)\n\n Use the REST API to get meta information about GitHub, including the IP addresses of GitHub services.\n\n* [REST API endpoints for community metrics](/en/rest/metrics/community)\n\n Use the REST API to retrieve information about your community profile.\n\n* [REST API endpoints for repository statistics](/en/rest/metrics/statistics)\n\n Use the REST API to fetch the data that GitHub uses for visualizing different types of repository activity.\n\n* [REST API endpoints for repository traffic](/en/rest/metrics/traffic)\n\n Use the REST API to retrieve information provided in your repository graph.\n\n* [REST API endpoints for organization migrations](/en/rest/migrations/orgs)\n\n Use the REST API to export one or more repositories so you can move them to GitHub Enterprise Server.\n\n* [REST API endpoints for source imports](/en/rest/migrations/source-imports)\n\n Use the REST API to start an import from a Git source repository.\n\n* [REST API endpoints for user migrations](/en/rest/migrations/users)\n\n Use the REST API to review, backup, or migrate your user data stored on GitHub.\n\n* [REST API endpoints for models catalog](/en/rest/models/catalog)\n\n Use the REST API to get a list of models available for use, including details like ID, supported input/output modalities, and rate limits.\n\n* [REST API endpoints for model embeddings](/en/rest/models/embeddings)\n\n Use the REST API to work with embedding requests for models.\n\n* [REST API endpoints for models inference](/en/rest/models/inference)\n\n Use the REST API to submit a chat completion request to a specified model, with or without organizational attribution.\n\n* [REST API endpoints for OAuth app authorizations](/en/oauth-authorizations)\n\n Use the REST API to manage the access OAuth apps have to your account.\n\n* [REST API endpoints for API Insights](/en/rest/orgs/api-insights)\n\n Use the REST API to view statistics for API usage in an organization.\n\n* [REST API endpoints for artifact metadata](/en/rest/orgs/artifact-metadata)\n\n Use these endpoints to retrieve and manage metadata for artifacts in your organization. Artifact metadata provides information about build artifacts, their provenance, and related details.\n\n* [REST API endpoints for artifact attestations](/en/rest/orgs/attestations)\n\n Use the REST API to interact with artifact attestations.\n\n* [REST API endpoints for blocking users](/en/rest/orgs/blocking)\n\n Use the REST API to block and unblock users in an organization.\n\n* [REST API endpoints for organization push rule bypass requests](/en/bypass-requests)\n\n Use the REST API to manage organization push rule bypass requests.\n\n* [REST API endpoints for custom properties](/en/rest/orgs/custom-properties)\n\n Use the REST API to create and manage custom properties for an organization.\n\n* [REST API endpoints for an organization's custom property values](/en/custom-properties-for-orgs)\n\n Use the REST API to manage custom property values for an organization\n\n* [REST API endpoints for custom repository roles](/en/custom-roles)\n\n Use the REST API to interact with custom repository roles.\n\n* [REST API endpoints for issue fields](/en/rest/orgs/issue-fields)\n\n Use the REST API to create and manage issue fields for an organization.\n\n* [REST API endpoints for issue types](/en/rest/orgs/issue-types)\n\n Use the REST API to interact with issue types in an organization.\n\n* [REST API endpoints for organization members](/en/rest/orgs/members)\n\n Use the REST API to manage memberships in your organization.\n\n* [REST API endpoints for network configurations](/en/rest/orgs/network-configurations)\n\n REST API endpoints for network configurations\n\n* [REST API endpoints for organization roles](/en/rest/orgs/organization-roles)\n\n Use the REST API to interact with organization roles.\n\n* [REST API endpoints for organizations](/en/rest/orgs/orgs)\n\n Use the REST API to interact with organizations.\n\n* [REST API endpoints for outside collaborators](/en/rest/orgs/outside-collaborators)\n\n Use the REST API to manage outside collaborators.\n\n* [REST API endpoints for personal access tokens](/en/rest/orgs/personal-access-tokens)\n\n Use the REST API to manage fine-grained personal access tokens.\n\n* [REST API endpoints for rule suites](/en/rest/orgs/rule-suites)\n\n Use the REST API to manage rule suites for organizations.\n\n* [REST API endpoints for rules](/en/rest/orgs/rules)\n\n Use the REST API to manage rulesets for organizations. Organization rulesets control how people can interact with selected branches and tags in repositories in an organization.\n\n* [REST API endpoints for security managers](/en/rest/orgs/security-managers)\n\n Use the REST API to manage security managers in an organization.\n\n* [REST API endpoints for organization webhooks](/en/rest/orgs/webhooks)\n\n Use the REST API to interact with webhooks in an organization.\n\n* [REST API endpoints for packages](/en/rest/packages/packages)\n\n Use the REST API to interact with GitHub Packages.\n\n* [REST API endpoints for GitHub Pages](/en/rest/pages/pages)\n\n Use the REST API to interact with GitHub Pages sites and builds.\n\n* [Organization configurations](/en/rest/private-registries/organization-configurations)\n\n Use the REST API to manage private registry configurations for organizations.\n\n* [REST API endpoints for draft Project items](/en/rest/projects/drafts)\n\n Use the REST API to manage draft items in Projects.\n\n* [REST API endpoints for Project fields](/en/rest/projects/fields)\n\n Use the REST API to manage Project fields\n\n* [REST API endpoints for Project items](/en/rest/projects/items)\n\n Use the REST API to manage Project items\n\n* [REST API endpoints for Projects](/en/rest/projects/projects)\n\n Use the REST API to manage Projects\n\n* [REST API endpoints for Project views](/en/rest/projects/views)\n\n Use the REST API to manage Project views\n\n* [REST API endpoints for pull requests](/en/rest/pulls/pulls)\n\n Use the REST API to interact with pull requests.\n\n* [REST API endpoints for pull request review comments](/en/rest/pulls/comments)\n\n Use the REST API to interact with pull request review comments.\n\n* [REST API endpoints for review requests](/en/rest/pulls/review-requests)\n\n Use the REST API to interact with review requests.\n\n* [REST API endpoints for pull request reviews](/en/rest/pulls/reviews)\n\n Use the REST API to interact with pull request reviews.\n\n* [REST API endpoints for rate limits](/en/rest/rate-limit/rate-limit)\n\n Use the REST API to check your current rate limit status.\n\n* [REST API endpoints for reactions](/en/rest/reactions/reactions)\n\n Use the REST API to interact with reactions on GitHub.\n\n* [REST API endpoints for releases](/en/rest/releases/releases)\n\n Use the REST API to create, modify, and delete releases.\n\n* [REST API endpoints for release assets](/en/rest/releases/assets)\n\n Use the REST API to manage release assets.\n\n* [REST API endpoints for repository attestations](/en/rest/repos/attestations)\n\n Use the REST API to manage repository attestations.\n\n* [REST API endpoints for repository autolinks](/en/rest/repos/autolinks)\n\n Use the REST API to add autolinks to external resources.\n\n* [REST API endpoints for repository contents](/en/rest/repos/contents)\n\n Use the REST API to create, modify, and delete Base64 encoded content in a repository.\n\n* [REST API endpoints for custom properties](/en/rest/repos/custom-properties)\n\n Use the REST API to list the custom properties assigned to a repository by the organization.\n\n* [REST API endpoints for forks](/en/rest/repos/forks)\n\n Use the REST API to manage repository forks.\n\n* [REST API endpoints for issue types](/en/rest/repos/issue-types)\n\n Use the REST API to manage issue types for a repository.\n\n* [REST API endpoints for Git LFS](/en/lfs)\n\n Use the REST API to enable or disable Git Large File Storage (LFS) for a repository.\n\n* [REST API endpoints for repositories](/en/rest/repos/repos)\n\n Use the REST API to manage repositories on GitHub.\n\n* [REST API endpoints for rule suites](/en/rest/repos/rule-suites)\n\n Use the REST API to manage rule suites for repositories.\n\n* [REST API endpoints for rules](/en/rest/repos/rules)\n\n Use the REST API to manage rulesets for repositories. Rulesets control how people can interact with selected branches and tags in a repository.\n\n* [REST API endpoints for repository tags](/en/tags)\n\n Use the REST API to manage tags for a repository.\n\n* [REST API endpoints for repository webhooks](/en/rest/repos/webhooks)\n\n Use the REST API to create and manage webhooks for your repositories.\n\n* [REST API endpoints for SCIM](/en/scim)\n\n Use the REST API to control and manage your GitHub organization members' access with SCIM.\n\n* [REST API endpoints for search](/en/rest/search/search)\n\n Use the REST API to search for specific items on GitHub.\n\n* [REST API endpoints for push protection bypass requests](/en/delegated-bypass)\n\n Use the REST API to manage push protection bypass requests for secret scanning.\n\n* [REST API endpoints for secret scanning push protection](/en/rest/secret-scanning/push-protection)\n\n Use the REST API to manage secret scanning push protection.\n\n* [REST API endpoints for secret scanning](/en/rest/secret-scanning/secret-scanning)\n\n Use the REST API to retrieve and update secret alerts from a repository.\n\n* [REST API endpoints for global security advisories](/en/rest/security-advisories/global-advisories)\n\n Use the REST API to view global security advisories.\n\n* [REST API endpoints for repository security advisories](/en/rest/security-advisories/repository-advisories)\n\n Use the REST API to view and manage repository security advisories.\n\n* [REST API endpoints for external groups](/en/external-groups)\n\n Use the REST API to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization.\n\n* [REST API endpoints for team members](/en/rest/teams/members)\n\n Use the REST API to create and manage membership of teams in your GitHub organization.\n\n* [REST API endpoints for team synchronization](/en/team-sync)\n\n Use the REST API to manage connections between GitHub teams and external identity provider (IdP) groups.\n\n* [REST API endpoints for teams](/en/rest/teams/teams)\n\n Use the REST API to create and manage teams in your GitHub organization.\n\n* [REST API endpoints for artifact attestations](/en/rest/users/attestations)\n\n Use the REST API to manage artifact attestations.\n\n* [REST API endpoints for blocking users](/en/rest/users/blocking)\n\n Use the REST API to manage blocked users.\n\n* [REST API endpoints for emails](/en/rest/users/emails)\n\n Use the REST API to manage email addresses of authenticated users.\n\n* [REST API endpoints for followers](/en/rest/users/followers)\n\n Use the REST API to get information about followers of authenticated users.\n\n* [REST API endpoints for GPG keys](/en/rest/users/gpg-keys)\n\n Use the REST API to manage GPG keys of authenticated users.\n\n* [REST API endpoints for Git SSH keys](/en/rest/users/keys)\n\n Use the REST API to manage Git SSH keys of authenticated users.\n\n* [REST API endpoints for social accounts](/en/rest/users/social-accounts)\n\n Use the REST API to manage social accounts of authenticated users.\n\n* [REST API endpoints for SSH signing keys](/en/rest/users/ssh-signing-keys)\n\n Use the REST API to manage SSH signing keys of authenticated users.\n\n* [REST API endpoints for users](/en/rest/users/users)\n\n Use the REST API to get public and private information about authenticated users."
}curl "https://docs.github.com/api/article?pathname=/en/rest"const res = await fetch("https://docs.github.com/api/article?pathname=/en/rest");
const data = await res.json();
console.log(data);import requests
res = requests.get("https://docs.github.com/api/article?pathname=/en/rest")
print(res.json())/api/article?pathname=/en/restPROBEDGitHub REST API — The GitHub REST API allows developers to create integra…
/apiApi — documented GET route.
/api/1Api details by ID (example: 1).
/api?limit=10Api — documented GET route.
/api/search?q=testSearch by query parameters.
/api/article?limit=5Article — documented GET route.
We probe a documented GET and expect 2xx JSON — full uptime and health score. Export includes every documented route below.
Not tracked yet. Shape-change history starts once this API joins our probe schedule.
GitHub REST API: common questions
Is GitHub REST API free to use?
Yes — GitHub REST API is a free developer tools API. Free tier: Free — limits not published. Whether the free tier allows commercial use is unclear — check the provider docs.
Does GitHub REST API need an API key?
No — GitHub REST API needs no API key or signup. You can call it straight away; rate limits still apply (Unpublished).
Can I call GitHub REST API from the browser?
Yes — GitHub REST API returns CORS headers over HTTPS, so front-end code can fetch it directly with no backend proxy. Use the fetch snippet on this page, or hit "Run live" to try it now.
Is GitHub REST API up right now?
GitHub REST API is catalogued but not yet on our probe schedule, so we don't publish a live status for it. Check the provider's own status page or docs for its current state.