---
title: "Get GitHub connection status"
method: GET
path: "/api/v1/github/status"
tags: ["github"]
---

# Get GitHub connection status

`GET /api/v1/github/status`

Returns the current GitHub connection status for the client.

## Response `200`

Successful Response

- ConnectionStatusResponse — Response for connection status.
  - `connected` boolean, required
  - `default_branch` string, nullable
  - `last_sync_at` string, nullable
  - `last_used_at` string, nullable
  - `owner` string, nullable
  - `repository` string, nullable
  - `scaffolding_pr_author` string, nullable
  - `scaffolding_pr_created_at` string, nullable
  - `scaffolding_pr_state` string, nullable
  - `scaffolding_pr_title` string, nullable
  - `scaffolding_pr_url` string, nullable
  - `scaffolding_status` string, nullable
  - `status` string, nullable

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

## Changes

- **2026-02-08** `91ea1d9f6c07` — 4 info
  - added the optional property `scaffolding_pr_author` to the response with the `200` status
  - added the optional property `scaffolding_pr_created_at` to the response with the `200` status
  - added the optional property `scaffolding_pr_state` to the response with the `200` status
  - added the optional property `scaffolding_pr_title` to the response with the `200` status

[Change history](https://skmtc.dev/kater-ai/apis/kater-api/changes/api/v1/github/status/get.md)

---

[API](https://skmtc.dev/kater-ai/apis/kater-api.md) · [All operations](https://skmtc.dev/kater-ai/apis/kater-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kater-ai/kater-api/revisions/91ea1d9f6c07/schema)