---
title: "Complete a GitHub authorization callback"
method: GET
path: "/api/github/callback"
tags: ["GitHub"]
---

# Complete a GitHub authorization callback

`GET /api/github/callback`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/github/callback`
- Auth: one of:
  - API key in cookie `gc-github-signup`
  - API key in cookie `gc-session`

Completes either signup migration using the gc-github-signup binding cookie or account relinking using a current browser session. GitCafe does not treat the GitHub callback as OAuth authentication to the API. Requires authenticated authority and enforces current resource policy.

## Query parameters

- `state` string, required
- `code` string, required
- `iss` 'https://github.com/login/oauth'

## Response `200`

Response for status 200

- union
  - object
    - `connected` true, required
    - `providerId` integer, required
    - `login` string, required
    - `renewals` union[], required
      - union
        - object
          - `repoId` string, required
          - `state` 'renewed', required
          - `version` integer, required
        - object
          - `repoId` string, required
          - `state` 'blocked', required
          - `code` string, required
  - object
    - `ready` true, required

## Other responses

- `303`: Response for status 303
- `400`: The request is invalid.
- `401`: Authentication is required, or the supplied credential is invalid.
- `403`: The credential does not permit this operation. A `code`, when present, names the refusal.
- `404`: The resource does not exist or is not visible to the caller.
- `409`: The request conflicts with the current state. A `code`, when present, names the refusal; `retryable` says whether the same request can succeed later, and `operationId` names the operation in the way.
- `429`: A rate limit is exhausted. Wait Retry-After seconds; the value is a hint, so back off on a repeat 429.
- `503`: A required service is temporarily unavailable; retry later.

---

[API](https://skmtc.dev/gitcafe/apis/git-cafe-api.md) - [All operations](https://skmtc.dev/gitcafe/apis/git-cafe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gitcafe/apis/git-cafe-api/revisions/9fa233d2986d?raw)