> ## Documentation Index
> Fetch the complete documentation index at: https://nango-wari-migrated-bigcommerce-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub

> Integrate your application with the GitHub API

## 🚀 Quickstart

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

<Steps>
  <Step title="Create the integration">
    In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *GitHub*.
  </Step>

  <Step title="Authorize GitHub">
    Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then log in to GitHub. Later, you'll let your users do the same directly from your app.
  </Step>

  <Step title="Call the GitHub API">
    Let's make your first request to the GitHub API. Replace the placeholders below with your [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

    <Tabs>
      <Tab title="cURL">
        ```bash theme={null}
        curl "https://api.nango.dev/proxy/repos" \
          -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
          -H "Provider-Config-Key: <INTEGRATION-ID>" \
          -H "Connection-Id: <CONNECTION-ID>"
        ```
      </Tab>

      <Tab title="Node">
        Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

        ```typescript theme={null}
        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);
        ```
      </Tab>
    </Tabs>

    Or fetch credentials with the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get).

    ✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
  </Step>

  <Step title="Implement Nango in your app">
    Follow our [Auth implementation guide](/guides/primitives/auth) to integrate Nango in your app.

    To obtain your own production credentials, follow the setup guide linked below.
  </Step>
</Steps>

## 📚 GitHub Integration Guides

Nango maintained guides for common use cases.

* [How to register your own GitHub OAuth app](/api-integrations/github/how-to-register-your-own-github-api-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](/api-integrations/github/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](https://docs.github.com/en/rest)

## 🧩 Pre-built syncs & actions for GitHub

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

### Files

| Function name | Description                                                  | Type                                           | Source code                                                                                                     |
| ------------- | ------------------------------------------------------------ | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `list-files`  | Lists all the files of a Github repo given a specific branch | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/syncs/list-files.ts) |

### Others

| Function name                | Description                                                                                                                                                                     | Type                                           | Source code                                                                                                                       |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `add-issue-comment`          | Create a new comment on an issue or pull request discussion thread                                                                                                              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/add-issue-comment.ts)          |
| `create-branch`              | Create a branch ref from an existing commit SHA                                                                                                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/create-branch.ts)              |
| `create-issue`               | Open a new GitHub issue in a repository.                                                                                                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/create-issue.ts)               |
| `create-label`               | Create a repository label with name, color, and description                                                                                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/create-label.ts)               |
| `create-or-update-file`      | Create a new file or update existing repository contents in a branch.                                                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/create-or-update-file.ts)      |
| `create-pull-request`        | Open a pull request from one branch into another.                                                                                                                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/create-pull-request.ts)        |
| `create-release`             | Publish a Git tag release for a repository.                                                                                                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/create-release.ts)             |
| `create-review-request`      | Request reviewers or teams on an open pull request                                                                                                                              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/create-review-request.ts)      |
| `create-tag-object`          | Create an annotated Git tag object for a commit or object SHA.                                                                                                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/create-tag-object.ts)          |
| `delete-file`                | Delete a file from a repository branch.                                                                                                                                         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/delete-file.ts)                |
| `delete-label`               | Delete a repository label by name                                                                                                                                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/delete-label.ts)               |
| `delete-release`             | Delete a release by release ID.                                                                                                                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/delete-release.ts)             |
| `get-branch`                 | Retrieve branch metadata and protection status.                                                                                                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/get-branch.ts)                 |
| `get-commit`                 | Retrieve a commit with changed files and stats                                                                                                                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/get-commit.ts)                 |
| `get-file-contents`          | Retrieve a file or directory entry from repository contents.                                                                                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/get-file-contents.ts)          |
| `get-issue`                  | Fetch a single issue or pull request issue record by number.                                                                                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/get-issue.ts)                  |
| `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](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/get-job-logs-download-url.ts)  |
| `get-label`                  | Retrieve a single repository label by name.                                                                                                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/get-label.ts)                  |
| `get-pull-request`           | Fetch a single pull request by number.                                                                                                                                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/get-pull-request.ts)           |
| `get-release`                | Retrieve a single release by release ID.                                                                                                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/get-release.ts)                |
| `get-repository`             | Retrieve repository metadata, visibility, default branch, and owner info.                                                                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/get-repository.ts)             |
| `get-review`                 | Retrieve a pull request review by review ID.                                                                                                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/get-review.ts)                 |
| `get-tag-ref`                | Retrieve a tag ref or branch-style Git reference                                                                                                                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/get-tag-ref.ts)                |
| `get-workflow-run`           | Retrieve a workflow run with status and conclusion details.                                                                                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/get-workflow-run.ts)           |
| `get-workflow`               | Retrieve metadata for a GitHub Actions workflow.                                                                                                                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/get-workflow.ts)               |
| `list-branches`              | List branches for a repository with optional pagination and protected filtering.                                                                                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/list-branches.ts)              |
| `list-commits`               | List commits for a repository or branch with common filters                                                                                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/list-commits.ts)               |
| `list-issue-comments`        | List comments attached to an issue or pull request thread                                                                                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/list-issue-comments.ts)        |
| `list-issues`                | List repository issues with state, assignee, label, and pagination filters.                                                                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/list-issues.ts)                |
| `list-labels`                | List repository labels with pagination                                                                                                                                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/list-labels.ts)                |
| `list-pull-request-files`    | List files changed by a pull request                                                                                                                                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/list-pull-request-files.ts)    |
| `list-pull-request-reviews`  | List reviews submitted on a pull request                                                                                                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/list-pull-request-reviews.ts)  |
| `list-pull-requests`         | List pull requests for a repository with state and branch filters                                                                                                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/list-pull-requests.ts)         |
| `list-release-assets`        | List assets uploaded to a repository release.                                                                                                                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/list-release-assets.ts)        |
| `list-releases`              | List published and draft releases for a repository.                                                                                                                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/list-releases.ts)              |
| `list-workflow-jobs`         | List jobs in a workflow run attempt                                                                                                                                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/list-workflow-jobs.ts)         |
| `list-workflow-runs`         | List workflow runs for a repository or a specific workflow                                                                                                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/list-workflow-runs.ts)         |
| `list-workflows`             | List GitHub Actions workflows configured in a repository.                                                                                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/list-workflows.ts)             |
| `merge-pull-request`         | Merge an open pull request using the selected merge method.                                                                                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/merge-pull-request.ts)         |
| `rerun-workflow-run`         | Rerun a completed or failed workflow run.                                                                                                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/rerun-workflow-run.ts)         |
| `submit-pull-request-review` | Create a pull request review with approval, comment, or change request.                                                                                                         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/submit-pull-request-review.ts) |
| `trigger-workflow-dispatch`  | Trigger a GitHub Actions workflow\_dispatch run for a workflow file or ID                                                                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/trigger-workflow-dispatch.ts)  |
| `update-issue`               | Edit an issue's title, body, state, assignees, labels, or milestone.                                                                                                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/update-issue.ts)               |
| `update-label`               | Update a repository label's name, color, or description.                                                                                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/update-label.ts)               |
| `update-pull-request`        | Edit a pull request's title, body, base branch, or state.                                                                                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/update-pull-request.ts)        |
| `update-release`             | Edit release metadata such as name, notes, or draft state.                                                                                                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/actions/update-release.ts)             |
| `commits`                    | Sync commits for repositories and branches in scope                                                                                                                             | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/syncs/commits.ts)                      |
| `issues`                     | Sync issues for one or more GitHub repositories with incremental updates based on issue activity                                                                                | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/syncs/issues.ts)                       |
| `pull-requests`              | Sync pull requests for one or more GitHub repositories, including status, branches, and merge state.                                                                            | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/syncs/pull-requests.ts)                |
| `releases`                   | Sync releases for one or more GitHub repositories.                                                                                                                              | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/syncs/releases.ts)                     |
| `repositories`               | Sync repositories visible to the authenticated GitHub user or installation.                                                                                                     | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/syncs/repositories.ts)                 |
| `repository-files`           | Sync file metadata for a specific repository branch using the Git trees API recursively                                                                                         | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/syncs/repository-files.ts)             |
| `workflow-runs`              | Sync GitHub Actions workflow runs for one or more repositories.                                                                                                                 | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/github/syncs/workflow-runs.ts)                |

***
