Auth API — List GitHub Repos and Installation Status

Reference for the BugViper auth endpoints that list accessible GitHub repositories and check whether the BugViper GitHub App is installed and linked.

In addition to the login and session endpoints covered in Authentication, BugViper provides endpoints to list your GitHub repositories and check your GitHub App installation status. Both endpoints require a valid Firebase ID Token and are typically called immediately after sign-in to determine which repositories are available and whether the GitHub App needs to be installed.

---

GET /api/v1/auth/github/repos

Returns the list of GitHub repositories accessible to the authenticated user. BugViper uses this list to let you select which repositories to connect and review.

Authentication required: Yes

curl https://your-domain.com/api/v1/auth/github/repos \
  -H "Authorization: Bearer <token>"

Response

Returns an array of repository objects.

name · string

Short repository name (e.g., my-project).

full_name · string

Full repository identifier in owner/repo format (e.g., alicesmith/my-project).

description · string | null

Repository description as set on GitHub.

language · string | null

Primary programming language detected by GitHub (e.g., Python, TypeScript, Go). null if GitHub has not detected a language.

stargazers_count · number

Number of GitHub stars.

private · boolean

Whether the repository is private (true) or public (false).

default_branch · string

Name of the repository’s default branch (e.g., main, master).

html_url · string

URL to the repository’s GitHub page.

Example response

[
  {
    "name": "my-project",
    "full_name": "alicesmith/my-project",
    "description": "A sample project",
    "language": "TypeScript",
    "stargazers_count": 42,
    "private": false,
    "default_branch": "main",
    "html_url": "https://github.com/alicesmith/my-project"
  }
]

This endpoint returns HTTP 400 if no GitHub access token is stored for the user. Make sure you have called POST /api/v1/auth/login at least once with a valid GitHub token before calling this endpoint.

---

GET /api/v1/auth/installation

Returns whether the BugViper GitHub App is installed and linked to the current user account. Call this endpoint after sign-in to decide whether to prompt the user to install the app before they can receive reviews.

Authentication required: Yes

curl https://your-domain.com/api/v1/auth/installation \
  -H "Authorization: Bearer <token>"

Response

linked · boolean

true if the GitHub App is installed and successfully linked to the authenticated user’s account, false otherwise.

installationId · number | null

The GitHub App installation ID associated with the user’s account, or null if the app is not yet installed.

githubUsername · string | null

The GitHub username associated with this account.

settingsUrl · string | null

A direct link to the GitHub App installation settings page. Present when linked is true; null otherwise.

Example response — linked

{
  "linked": true,
  "installationId": 12345678,
  "githubUsername": "alicesmith",
  "settingsUrl": "https://github.com/settings/installations/12345678"
}

Example response — not linked

{
  "linked": false,
  "installationId": null,
  "githubUsername": "alicesmith",
  "settingsUrl": null
}

If linked is false, direct the user to install the BugViper GitHub App from the dashboard’s Settings page. After installation, call this endpoint again to confirm the link was established successfully.