GitHub

🚀 Quickstart
📚 GitHub Integration Guides
🧩 Pre-built syncs & actions for GitHub
Actions
Branches
Commits
Files
Git
Issues
Labels
Pull Requests
Pull requests
Releases
Repositories
Workflow Jobs
Others

🚀 Quickstart

Connect to GitHub with Nango and see data flow in 2 minutes.

Create the integration

In Nango (free signup), go to Integrations -> Configure New Integration -> GitHub.

Authorize GitHub

Go to Connections -> Add Test Connection -> Authorize, then log in to GitHub. Later, you’ll let your users do the same directly from your app.

Call the GitHub API

Let’s make your first request to the GitHub API. Replace the placeholders below with your secret key, integration ID, and connection ID:

cURL
Node

curl "https://api.nango.dev/proxy/repos" \
  -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
  -H "Provider-Config-Key: <INTEGRATION-ID>" \
  -H "Connection-Id: <CONNECTION-ID>"

Install Nango’s backend SDK with npm i @nangohq/node. Then run:

import { Nango } from '@nangohq/node';

const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

const res = await nango.get({
    endpoint: '/repos',
    providerConfigKey: '<INTEGRATION-ID>',
    connectionId: '<CONNECTION-ID>'
});

console.log(res.data);

Or fetch credentials with the Node SDK or API.✅ You’re connected! Check the Logs tab in Nango to inspect requests.

Implement Nango in your app

Follow our Auth implementation guide to integrate Nango in your app.To obtain your own production credentials, follow the setup guide linked below.

📚 GitHub Integration Guides

Nango maintained guides for common use cases.

How to register your own GitHub OAuth app
Register an OAuth app with GitHub and obtain credentials to connect it to Nango
How to set up a GitHub App with Nango
Learn the differences between GitHub Apps and OAuth Apps, and how to configure a GitHub App in Nango

Official docs: GitHub REST API Documentation

🧩 Pre-built syncs & actions for GitHub

Enable them in your dashboard. Extend and customize to fit your needs.

Actions

Function name	Description	Type	Source code
`get-job-logs-download-url`	Get the API endpoint URL for a workflow job log download. Due to Nango proxy limitations with 302 redirects, this returns the API endpoint rather than the actual download URL.	Action	🔗 Github
`get-workflow`	Retrieve metadata for a GitHub Actions workflow.	Action	🔗 Github
`list-workflow-runs`	List workflow runs for a repository or a specific workflow	Action	🔗 Github
`rerun-workflow-run`	Rerun a completed or failed workflow run.	Action	🔗 Github
`trigger-workflow-dispatch`	Trigger a GitHub Actions workflow_dispatch run for a workflow file or ID	Action	🔗 Github

Branches

Function name	Description	Type	Source code
`get-branch`	Retrieve branch metadata and protection status.	Action	🔗 Github
`list-branches`	List branches for a repository with optional pagination and protected filtering.	Action	🔗 Github

Commits

Function name	Description	Type	Source code
`get-commit`	Retrieve a commit with changed files and stats	Action	🔗 Github
`list-commits`	List commits for a repository or branch with common filters	Action	🔗 Github

Files

Function name	Description	Type	Source code
`list-files`	Lists all the files of a Github repo given a specific branch	Sync	🔗 Github

Git

Function name	Description	Type	Source code
`create-branch`	Create a branch ref from an existing commit SHA	Action	🔗 Github
`create-tag-object`	Create an annotated Git tag object for a commit or object SHA.	Action	🔗 Github
`get-tag-ref`	Retrieve a tag ref or branch-style Git reference	Action	🔗 Github

Issues

Function name	Description	Type	Source code
`add-issue-comment`	Create a new comment on an issue or pull request discussion thread	Action	🔗 Github
`create-issue`	Open a new GitHub issue in a repository.	Action	🔗 Github
`get-issue`	Fetch a single issue or pull request issue record by number.	Action	🔗 Github
`list-issue-comments`	List comments attached to an issue or pull request thread	Action	🔗 Github
`list-issues`	List repository issues with state, assignee, label, and pagination filters.	Action	🔗 Github
`list-labels`	List repository labels with pagination	Action	🔗 Github
`update-issue`	Edit an issue’s title, body, state, assignees, labels, or milestone.	Action	🔗 Github

Labels

Function name	Description	Type	Source code
`create-label`	Create a repository label with name, color, and description	Action	🔗 Github
`delete-label`	Delete a repository label by name	Action	🔗 Github
`get-label`	Retrieve a single repository label by name.	Action	🔗 Github
`update-label`	Update a repository label’s name, color, or description.	Action	🔗 Github

Pull Requests

Function name	Description	Type	Source code
`create-pull-request`	Open a pull request from one branch into another.	Action	🔗 Github
`create-review-request`	Request reviewers or teams on an open pull request	Action	🔗 Github
`get-review`	Retrieve a pull request review by review ID.	Action	🔗 Github
`list-pull-request-files`	List files changed by a pull request	Action	🔗 Github
`list-pull-request-reviews`	List reviews submitted on a pull request	Action	🔗 Github
`list-pull-requests`	List pull requests for a repository with state and branch filters	Action	🔗 Github
`merge-pull-request`	Merge an open pull request using the selected merge method.	Action	🔗 Github
`submit-pull-request-review`	Create a pull request review with approval, comment, or change request.	Action	🔗 Github
`update-pull-request`	Edit a pull request’s title, body, base branch, or state.	Action	🔗 Github

Pull requests

Function name	Description	Type	Source code
`get-pull-request`	Fetch a single pull request by number.	Action	🔗 Github

Releases

Function name	Description	Type	Source code
`create-release`	Publish a Git tag release for a repository.	Action	🔗 Github
`delete-release`	Delete a release by release ID.	Action	🔗 Github
`get-release`	Retrieve a single release by release ID.	Action	🔗 Github
`list-release-assets`	List assets uploaded to a repository release.	Action	🔗 Github
`list-releases`	List published and draft releases for a repository.	Action	🔗 Github
`update-release`	Edit release metadata such as name, notes, or draft state.	Action	🔗 Github

Repositories

Function name	Description	Type	Source code
`create-or-update-file`	Create a new file or update existing repository contents in a branch.	Action	🔗 Github
`delete-file`	Delete a file from a repository branch.	Action	🔗 Github
`get-file-contents`	Retrieve a file or directory entry from repository contents.	Action	🔗 Github
`get-repository`	Retrieve repository metadata, visibility, default branch, and owner info.	Action	🔗 Github

Workflow Jobs

Function name	Description	Type	Source code
`list-workflow-jobs`	List jobs in a workflow run attempt	Action	🔗 Github

Others

Function name	Description	Type	Source code
`get-workflow-run`	Retrieve a workflow run with status and conclusion details.	Action	🔗 Github
`list-workflows`	List GitHub Actions workflows configured in a repository.	Action	🔗 Github
`commits`	Sync commits for repositories and branches in scope	Sync	🔗 Github
`issues`	Sync issues for one or more GitHub repositories with incremental updates based on issue activity	Sync	🔗 Github
`pull-requests`	Sync pull requests for one or more GitHub repositories, including status, branches, and merge state.	Sync	🔗 Github
`releases`	Sync releases for one or more GitHub repositories.	Sync	🔗 Github
`repositories`	Sync repositories visible to the authenticated GitHub user or installation.	Sync	🔗 Github
`repository-files`	Sync file metadata for a specific repository branch using the Git trees API recursively	Sync	🔗 Github
`workflow-runs`	Sync GitHub Actions workflow runs for one or more repositories.	Sync	🔗 Github

Ghost Content GitHub App

⌘I

Overview

700+ APIs & Integrations

🚀 Quickstart

📚 GitHub Integration Guides

🧩 Pre-built syncs & actions for GitHub

Actions

Branches

Commits

Files

Git

Issues

Labels

Pull Requests

Pull requests

Releases

Repositories

Workflow Jobs

Others

Overview

700+ APIs & Integrations

Documentation Index

​🚀 Quickstart

​📚 GitHub Integration Guides

​🧩 Pre-built syncs & actions for GitHub

​Actions

​Branches

​Commits

​Files

​Git

​Issues

​Labels

​Pull Requests

​Pull requests

​Releases

​Repositories

​Workflow Jobs

​Others

🚀 Quickstart

📚 GitHub Integration Guides

🧩 Pre-built syncs & actions for GitHub

Actions

Branches

Commits

Files

Git

Issues

Labels

Pull Requests

Pull requests

Releases

Repositories

Workflow Jobs

Others