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

# Get GitHub signup status

`GET /api/github/signup`

## Request

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

Returns migration readiness after the callback has bound provider identity to the pending flow. Requires authenticated authority and enforces current resource policy.

## Response `200`

Response for status 200

- object
  - `profile` object, required
    - `login` string, required
    - `handle` string, required
    - `email` string, nullable, required
    - `displayName` string, required
    - `emailVerified` boolean, required
    - `avatarUrl` string, nullable, required
  - `expiresAt` string, date-time, required

## Other responses

- `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`: Response for status 409
- `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)