[metadata]
description: Create integrations, retrieve data, and automate your workflows with the GitHub REST API.
google-site-verification: c1kuD-K2HIVF635lypcsWPoD4kilo5-jA_wBFyT4uMY
og:image: https://docs.github.com/assets/cb-345/images/social-cards/rest.png
og:site_name: GitHub Docs
og:title: GitHub REST API documentation - GitHub Docs
og:type: article
og:url: https://docs-internal.github.com/en/rest
page-document-type: product
path-article: rest
path-language: en
path-product: rest
path-version: free-pro-team@latest
status: 200
twitter:card: summary
twitter:description: Create integrations, retrieve data, and automate your workflows with the GitHub REST API.
twitter:domain: docs-internal.github.com
twitter:image: https://docs.github.com/assets/cb-345/images/social-cards/rest.png
twitter:title: GitHub REST API documentation - GitHub Docs
twitter:url: https://docs-internal.github.com/en/rest
viewport: width=device-width, initial-scale=1

[document-links]
API Insights: /en/rest/orgs/api-insights
API Versions: /en/rest/about-the-rest-api/api-versions
About API versioning: /rest/overview/api-versions
About the OpenAPI description for the REST API: /en/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api
About the REST API: /en/rest/about-the-rest-api/about-the-rest-api
Actions concurrency groups: /en/rest/actions/concurrency-groups
Agent tasks: /en/rest/agent-tasks/agent-tasks
Alerts: /en/rest/dependabot/alerts
Artifact attestations: /en/rest/orgs/attestations
Artifact metadata: /en/rest/orgs/artifact-metadata
Artifacts: /en/rest/actions/artifacts
Ask the GitHub community: https://github.com/orgs/community/discussions
Assignees: /en/rest/issues/assignees
Attestations: /en/rest/repos/attestations
Attestations: /en/rest/users/attestations
Authenticating to the REST API: /en/free-pro-team@latest/rest/authentication/authenticating-to-the-rest-api
Authenticating to the REST API: /en/rest/authentication/authenticating-to-the-rest-api
Authenticating: /en/rest/authentication/authenticating-to-the-rest-api
Autolinks: /en/rest/repos/autolinks
Best practices for using the REST API: /en/rest/using-the-rest-api/best-practices-for-using-the-rest-api
Best practices: /en/rest/using-the-rest-api/best-practices-for-using-the-rest-api
Billing usage: /en/rest/billing/usage
Blobs: /en/rest/git/blobs
Blocking users: /en/rest/orgs/blocking
Blocking users: /en/rest/users/blocking
Blog: https://github.blog
Branches: /en/rest/branches/branches
Breaking changes: /en/rest/about-the-rest-api/breaking-changes
Budgets: /en/rest/billing/budgets
Building a CI server: /en/rest/guides/building-a-ci-server
CORS and JSONP: /en/rest/using-the-rest-api/using-cors-and-jsonp-to-make-cross-origin-requests
Cache: /en/rest/actions/cache
Check runs: /en/rest/checks/runs
Check suites: /en/rest/checks/suites
Classroom: /en/rest/classroom/classroom
Cloud agent repository management: /en/rest/copilot/copilot-cloud-agent-management
Code quality: /en/rest/code-quality/code-quality
Code scanning: /en/rest/code-scanning/code-scanning
Codes of conduct: /en/rest/codes-of-conduct/codes-of-conduct
Codespaces: /en/rest/codespaces/codespaces
Collaborators: /en/rest/collaborators/collaborators
Collaborators: /en/rest/copilot-spaces/collaborators
Comments: /en/rest/gists/comments
Comments: /en/rest/issues/comments
Commit comments: /en/rest/commits/comments
Commit statuses: /en/rest/commits/statuses
Commits: /en/rest/commits/commits
Commits: /en/rest/git/commits
Community: /en/rest/metrics/community
Comparing GitHub's APIs: /en/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api
Configurations: /en/rest/code-security/configurations
Contact support: https://support.github.com
Contents: /en/rest/repos/contents
Copilot Spaces: /en/rest/copilot-spaces/copilot-spaces
Copilot cloud agent management: /en/rest/copilot/copilot-coding-agent-management
Copilot content exclusion management: /en/rest/copilot/copilot-content-exclusion-management
Copilot usage metrics: /en/rest/copilot/copilot-usage-metrics
Copilot user management: /en/rest/copilot/copilot-user-management
Custom patterns: /en/rest/secret-scanning/custom-patterns
Custom properties: /en/rest/orgs/custom-properties
Custom properties: /en/rest/repos/custom-properties
Delivering deployments: /en/rest/guides/delivering-deployments
Dependency review: /en/rest/dependency-graph/dependency-review
Dependency submission: /en/rest/dependency-graph/dependency-submission
Deploy keys: /en/rest/deploy-keys/deploy-keys
Deployment branch policies: /en/rest/deployments/branch-policies
Deployment statuses: /en/rest/deployments/statuses
Deployments: /en/rest/deployments/deployments
Discover resources for a user: /en/rest/guides/discovering-resources-for-a-user
Draft Project items: /en/rest/projects/drafts
Emails: /en/rest/users/emails
Emojis: /en/rest/emojis/emojis
Encrypt secrets: /en/rest/guides/encrypting-secrets-for-the-rest-api
Endpoints for GitHub App installation tokens: /en/rest/authentication/endpoints-available-for-github-app-installation-access-tokens
Endpoints for GitHub App user tokens: /en/rest/authentication/endpoints-available-for-github-app-user-access-tokens
Endpoints for fine-grained PATs: /en/rest/authentication/endpoints-available-for-fine-grained-personal-access-tokens
Enterprise team members: /en/rest/enterprise-teams/enterprise-team-members
Enterprise team organizations: /en/rest/enterprise-teams/enterprise-team-organizations
Enterprise teams: /en/rest/enterprise-teams/enterprise-teams
Environments: /en/rest/deployments/environments
Events: /en/rest/activity/events
Events: /en/rest/issues/events
Expert services: https://services.github.com
Feeds: /en/rest/activity/feeds
Followers: /en/rest/users/followers
Forks: /en/rest/repos/forks
GPG keys: /en/rest/users/gpg-keys
Get started - Checks: /en/rest/guides/using-the-rest-api-to-interact-with-checks
Get started - Git database: /en/rest/guides/using-the-rest-api-to-interact-with-your-git-database
Getting started with the REST API: /en/free-pro-team@latest/rest/using-the-rest-api/getting-started-with-the-rest-api
Getting started: /en/rest/using-the-rest-api/getting-started-with-the-rest-api
Gists: /en/rest/gists/gists
Git SSH keys: /en/rest/users/keys
GitHub Apps: /en/rest/apps/apps
GitHub Docs: /en
GitHub event types: /en/rest/using-the-rest-api/github-event-types
GitHub-hosted runners: /en/rest/actions/hosted-runners
Gitignore: /en/rest/gitignore/gitignore
Global security advisories: /en/rest/security-advisories/global-advisories
Home: /en
Installations: /en/rest/apps/installations
Invitations: /en/rest/collaborators/invitations
Issue dependencies: /en/rest/issues/issue-dependencies
Issue event types: /en/rest/using-the-rest-api/issue-event-types
Issue field values: /en/rest/issues/issue-field-values
Issue fields: /en/rest/orgs/issue-fields
Issue types: /en/rest/orgs/issue-types
Issue types: /en/rest/repos/issue-types
Issues: /en/rest/issues/issues
Keeping API credentials secure: /en/rest/authentication/keeping-your-api-credentials-secure
Labels: /en/rest/issues/labels
Learn how to contribute: /contributing
Libraries: /en/rest/using-the-rest-api/libraries-for-the-rest-api
Licenses: /en/rest/licenses/licenses
Machines: /en/rest/codespaces/machines
Make a contribution: https://github.com/github/docs/blob/main/content/rest/index.md
Markdown: /en/rest/markdown/markdown
Marketplace: /en/rest/apps/marketplace
Members: /en/rest/orgs/members
Members: /en/rest/teams/members
Meta: /en/rest/meta/meta
Milestones: /en/rest/issues/milestones
Network configurations: /en/rest/orgs/network-configurations
Notifications: /en/rest/activity/notifications
OAuth authorizations: /en/rest/apps/oauth-applications
OIDC: /en/rest/actions/oidc
OpenAPI description: /en/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api
Organization configurations: /en/rest/private-registries/organization-configurations
Organization roles: /en/rest/orgs/organization-roles
Organization secrets: /en/rest/codespaces/organization-secrets
Organization: /en/rest/interactions/orgs
Organizations: /en/rest/codespaces/organizations
Organizations: /en/rest/migrations/orgs
Organizations: /en/rest/orgs/orgs
Outside collaborators: /en/rest/orgs/outside-collaborators
Overview: /rest/about-the-rest-api/about-the-rest-api
Packages: /en/rest/packages/packages
Pages: /en/rest/pages/pages
Pagination: /en/rest/using-the-rest-api/using-pagination-in-the-rest-api
Permissions for GitHub Apps: /en/rest/authentication/permissions-required-for-github-apps
Permissions for fine-grained PATs: /en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens
Permissions: /en/rest/actions/permissions
Personal access tokens: /en/rest/orgs/personal-access-tokens
Pricing: https://github.com/pricing
Privacy policy: /en/site-policy/privacy-policies/github-privacy-statement
Privacy: /en/site-policy/privacy-policies/github-privacy-statement
Project fields: /en/rest/projects/fields
Project items: /en/rest/projects/items
Project views: /en/rest/projects/views
Projects: /en/rest/projects/projects
Protected branches: /en/rest/branches/branch-protection
Protection rules: /en/rest/deployments/protection-rules
Pull requests: /en/rest/pulls/pulls
Push protection: /en/rest/secret-scanning/push-protection
Quickstart for GitHub REST API: /en/free-pro-team@latest/rest/quickstart
Quickstart: /en/rest/quickstart
Quickstart: /rest/quickstart
REST API: /en/rest
Rate limit: /en/rest/rate-limit/rate-limit
Rate limits: /en/rest/using-the-rest-api/rate-limits-for-the-rest-api
Reactions: /en/rest/reactions/reactions
References: /en/rest/git/refs
Release assets: /en/rest/releases/assets
Releases: /en/rest/releases/releases
Rendering data as graphs: /en/rest/guides/rendering-data-as-graphs
Repositories: /en/rest/repos/repos
Repository access: /en/rest/dependabot/repository-access
Repository secrets: /en/rest/codespaces/repository-secrets
Repository security advisories: /en/rest/security-advisories/repository-advisories
Repository: /en/rest/interactions/repos
Resources: /en/rest/copilot-spaces/resources
Review comments: /en/rest/pulls/comments
Review requests: /en/rest/pulls/review-requests
Reviews: /en/rest/pulls/reviews
Revocation: /en/rest/credentials/revoke
Rule suites: /en/rest/orgs/rule-suites
Rule suites: /en/rest/repos/rule-suites
Rules: /en/rest/orgs/rules
Rules: /en/rest/repos/rules
SSH signing keys: /en/rest/users/ssh-signing-keys
Script with JavaScript: /en/rest/guides/scripting-with-the-rest-api-and-javascript
Script with Ruby: /en/rest/guides/scripting-with-the-rest-api-and-ruby
Search: /en/rest/search/search
Secret scanning: /en/rest/secret-scanning/secret-scanning
Secrets: /en/rest/actions/secrets
Secrets: /en/rest/agents/secrets
Secrets: /en/rest/dependabot/secrets
Security campaigns: /en/rest/campaigns/campaigns
Security managers: /en/rest/orgs/security-managers
Self-hosted runner groups: /en/rest/actions/self-hosted-runner-groups
Self-hosted runners: /en/rest/actions/self-hosted-runners
Social accounts: /en/rest/users/social-accounts
Software bill of materials (SBOM): /en/rest/dependency-graph/sboms
Source endpoints: /en/rest/migrations/source-imports
Stacked pull requests: /en/rest/pulls/stacks
Starring: /en/rest/activity/starring
Statistics: /en/rest/metrics/statistics
Status: https://www.githubstatus.com/
Sub-issues: /en/rest/issues/sub-issues
Tags: /en/rest/git/tags
Teams: /en/rest/teams/teams
Terms: /en/site-policy/github-terms/github-terms-of-service
Timeline: /en/rest/issues/timeline
Timezones: /en/rest/using-the-rest-api/timezones-and-the-rest-api
Traffic: /en/rest/metrics/traffic
Trees: /en/rest/git/trees
Troubleshooting: /en/rest/using-the-rest-api/troubleshooting-the-rest-api
User secrets: /en/rest/codespaces/secrets
User: /en/rest/interactions/user
Users: /en/rest/migrations/users
Users: /en/rest/users/users
Variables: /en/rest/actions/variables
Variables: /en/rest/agents/variables
Watching: /en/rest/activity/watching
Webhooks: /en/rest/apps/webhooks
Webhooks: /en/rest/orgs/webhooks
Webhooks: /en/rest/repos/webhooks
Workflow jobs: /en/rest/actions/workflow-jobs
Workflow runs: /en/rest/actions/workflow-runs
Workflows: /en/rest/actions/workflows
Working with comments: /en/rest/guides/working-with-comments

[content]
GitHub REST API documentation - GitHub Docs
Skip to main content
GitHub Docs
Version:
Free, Pro, & Team
Search or ask Copilot
Search or ask
Copilot
Select language: current language is English
Search or ask Copilot
Search or ask
Copilot
Open menu
Collapse sidebar
Expand sidebar
Scroll breadcrumbs left
Home
REST API
Scroll breadcrumbs right
REST API
API Version:
2026-03-10 (latest)
Quickstart
About the REST API
About the REST API
Comparing GitHub's APIs
API Versions
Breaking changes
OpenAPI description
Using the REST API
Getting started
Rate limits
Pagination
Libraries
Best practices
Troubleshooting
Timezones
CORS and JSONP
Issue event types
GitHub event types
Authentication
Authenticating
Keeping API credentials secure
Endpoints for GitHub App installation tokens
Endpoints for GitHub App user tokens
Endpoints for fine-grained PATs
Permissions for GitHub Apps
Permissions for fine-grained PATs
Guides
Script with JavaScript
Script with Ruby
Discover resources for a user
Delivering deployments
Rendering data as graphs
Working with comments
Building a CI server
Get started - Git database
Get started - Checks
Encrypt secrets
Actions
Artifacts
Cache
Actions concurrency groups
GitHub-hosted runners
OIDC
Permissions
Secrets
Self-hosted runner groups
Self-hosted runners
Variables
Workflow jobs
Workflow runs
Workflows
Activity
Events
Feeds
Notifications
Starring
Watching
Agent tasks
Agent tasks
Agents
Secrets
Variables
Apps
GitHub Apps
Installations
Marketplace
OAuth authorizations
Webhooks
Billing
Budgets
Billing usage
Branches
Branches
Protected branches
Campaigns
Security campaigns
Checks
Check runs
Check suites
Classroom
Classroom
Code quality
Code quality
Code scanning
Code scanning
Code security settings
Configurations
Codes of conduct
Codes of conduct
Codespaces
Codespaces
Organizations
Organization secrets
Machines
Repository secrets
User secrets
Collaborators
Collaborators
Invitations
Commits
Commits
Commit comments
Commit statuses
Copilot
Cloud agent repository management
Copilot cloud agent management
Copilot content exclusion management
Copilot usage metrics
Copilot user management
Copilot Spaces
Collaborators
Copilot Spaces
Resources
Credentials
Revocation
Dependabot
Alerts
Repository access
Secrets
Dependency graph
Dependency review
Dependency submission
Software bill of materials (SBOM)
Deploy keys
Deploy keys
Deployments
Deployment branch policies
Deployments
Environments
Protection rules
Deployment statuses
Emojis
Emojis
Enterprise teams
Enterprise team members
Enterprise team organizations
Enterprise teams
Gists
Gists
Comments
Git database
Blobs
Commits
References
Tags
Trees
Gitignore
Gitignore
Interactions
Organization
Repository
User
Issues
Assignees
Comments
Events
Issue dependencies
Issue field values
Issues
Labels
Milestones
Sub-issues
Timeline
Licenses
Licenses
Markdown
Markdown
Meta
Meta
Metrics
Community
Statistics
Traffic
Migrations
Organizations
Source endpoints
Users
Organizations
API Insights
Artifact metadata
Artifact attestations
Blocking users
Custom properties
Issue fields
Issue types
Members
Network configurations
Organization roles
Organizations
Outside collaborators
Personal access tokens
Rule suites
Rules
Security managers
Webhooks
Packages
Packages
Pages
Pages
Private registries
Organization configurations
Projects
Draft Project items
Project fields
Project items
Projects
Project views
Pull requests
Review comments
Pull requests
Review requests
Reviews
Stacked pull requests
Rate limit
Rate limit
Reactions
Reactions
Releases
Releases
Release assets
Repositories
Attestations
Autolinks
Contents
Custom properties
Forks
Issue types
Repositories
Rule suites
Rules
Webhooks
Search
Search
Secret scanning
Custom patterns
Push protection
Secret scanning
Security advisories
Global security advisories
Repository security advisories
Teams
Members
Teams
Users
Attestations
Blocking users
Emails
Followers
GPG keys
Git SSH keys
Social accounts
SSH signing keys
Users
The REST API is now versioned.
For more information, see "
About API versioning
."
GitHub REST API documentation
Create integrations, retrieve data, and automate your workflows with the GitHub REST API.
Overview
Quickstart
Recommended
Quickstart for GitHub REST API
Learn how to get started with the GitHub REST API.
Getting started with the REST API
Learn how to use the GitHub REST API.
Authenticating to the REST API
You can authenticate to the REST API to access more endpoints and have a higher rate limit.
Articles
Category
:
All categories
Learn about the REST API
About the OpenAPI description for the REST API
The GitHub REST API is fully described in an OpenAPI compliant document.
Learn about the REST API
About the REST API
Get oriented to the REST API documentation.
Learn about the REST API
API Versions
Learn how to specify which REST API version to use whenever you make a request to the REST API.
Authenticate API requests
Authenticating to the REST API
You can authenticate to the REST API to access more endpoints and have a higher rate limit.
Learn about the REST API
Best practices for using the REST API
Follow these best practices when using GitHub's API.
Administer enterprises and billing
Billing usage
Use the REST API to get billing usage information.
Learn about the REST API
Breaking changes
Learn about breaking changes that were introduced in each REST API version.
Administer enterprises and billing
Budgets
Use the REST API to get budget information.
Build apps and integrations
Building a CI server
Build your own CI system using the Status API.
Showing 1-9 of 198
Previous
1
2
3
4
5
6
…
22
Next
Help and support
Did you find what you needed?
Yes
No
Privacy policy
Help us make these docs great!
All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.
Make a contribution
Learn how to contribute
Still need help?
Ask the GitHub community
Contact support
Legal
©
2026
GitHub, Inc.
Terms
Privacy
Status
Pricing
Expert services
Blog
