---
title: "Diagnose GitHub App installation access for an account-scoped token."
method: GET
path: "/api/v1/github/app-access/diagnostics"
tags: ["GitHub"]
---

# Diagnose GitHub App installation access for an account-scoped token.

`GET /api/v1/github/app-access/diagnostics`

## Request

- Base URL: `https://commentary.dev`
- URL: `https://commentary.dev/api/v1/github/app-access/diagnostics`
- Auth: HTTP bearer

Returns the same installation status and setup links used by the Commentary workspace. This endpoint is read-only and never installs or modifies GitHub Apps.

## Query parameters

- `owner` string
- `repo` string
- `target` string
- `redirectTo` string
- `installStatus` string

## Headers

- `X-Commentary-Workspace-Id` string
- `X-Correlation-Id` string

## Response `200`

Successful response.

- object
  - `ok` unknown
  - `diagnostic` GitHubInstallationDiagnostic
    - `ok` boolean
    - `status` string
    - `statusLabel` string
    - `title` string
    - `description` string
    - `target` object, nullable
    - `details` string[]
    - `nextSteps` string[]
    - `installUrl` string, uri, nullable
    - `manageUrl` string, uri, nullable
    - `workspaceAccessUrl` string, uri
    - `reviewUrl` string, uri, nullable
    - `installations` object[]

## Other responses

- `400`: The request was invalid.
- `401`: Authentication is required.
- `403`: The token or session does not have permission for this resource.
- `404`: The resource was not found.
- `429`: The request was rate limited.

---

[API](https://skmtc.dev/commentary/apis/commentary-public-api.md) · [All operations](https://skmtc.dev/commentary/apis/commentary-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/commentary/apis/commentary-public-api/revisions/7aaafc198c52?raw)
