Skip to main content
GET
Get GitHub connection

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app whose GitHub connection to use.

Response

The app's GitHub connection.

Current connection status for an app.

connected
boolean
required

Whether the app still has its repository connection, including one whose status is error or revoked. The value is false only when the app never connected and when its repository was disconnected.

Example:

true

connection_mode
enum<string> | null

Workspace GitHub write model; null when not connected.

Available options:
shared,
per_user
user_github_connected
boolean | null

Whether the current user has a linked GitHub account; computed only in per_user mode.

can_push
boolean
default:false

Whether the connection permits a push attempt under the workspace mode. Failed user permission lookups allow an attempt; GitHub enforces access.

repo_full_name
string | null

Full repository name, as owner/repo, or null when connected is false.

Example:

"base44/lead-tracker"

repo_url
string | null

URL of the repository on GitHub, or null when connected is false.

Example:

"https://github.com/base44/lead-tracker"

clone_urls
CloneUrls · object | null

URLs and CLI command for cloning the repository, or null when connected is false.

org_name
string | null

GitHub username or organization that owns the repository, or null when connected is false.

Example:

"base44"

status
enum<string> | null

Health of the connection, or null when connected is false. A value of active works normally, error hit a technical failure, and revoked means the GitHub App access was withdrawn. The last two still report connected: true, so this is the field that tells you the connection needs repair.

Available options:
active,
disconnected,
error,
revoked
Example:

"active"

installation_id
string | null

ID of the Base44 GitHub App installation backing this connection, or null when connected is false and on a connection stored without one.

Example:

"58231904"

webhook_active
boolean
default:false

Whether the repository has the Base44 webhook that triggers automatic pulls. While this is false on a connected app, GitHub isn't telling Base44 about pushes, so nothing arrives until you pull.

Example:

true

connected_by_user_id
string | null

ID of the Base44 user who connected the repository, or null when connected is false.

Example:

"6820f3a4e7b91d003c45a1f0"

previous_repository
PreviousRepository · object | null

The repository a user disconnected the app from, which Reconnect a GitHub repository can bring back, or null when the app is connected, never connected, or lost its repository some other way.