Get GitHub connection

curl --request GET \
  --url https://app.base44.com/api/apps/{app_id}/github/connection \
  --header 'api_key: <api-key>'

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://app.base44.com/api/apps/{app_id}/github/connection', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.base44.com/api/apps/{app_id}/github/connection",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/apps/{app_id}/github/connection"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/apps/{app_id}/github/connection")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "connected": true,
  "repo_full_name": "base44/lead-tracker",
  "repo_url": "https://github.com/base44/lead-tracker",
  "clone_urls": {
    "https": "https://github.com/base44/lead-tracker.git",
    "ssh": "git@github.com:base44/lead-tracker.git",
    "gh_cli": "gh repo clone base44/lead-tracker"
  },
  "org_name": "base44",
  "status": "active",
  "installation_id": "58231904",
  "webhook_active": true,
  "connected_by_user_id": "6820f3a4e7b91d003c45a1f0"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

API Reference

Get GitHub connection

This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.

Returns the app’s GitHub repository connection, or connected: false when it has none.

Reading this refreshes the connection’s health as a side effect: an active connection is re-checked against GitHub, and one in error or revoked is retried, so status can change between two calls with nobody touching the app.

connected is false for an app that never connected and for one whose repository was disconnected, and the rest of the fields are then null, so the two cases are indistinguishable here. A connection GitHub revoked, or one that hit an error, is still connected: true; status is what tells you it needs repair.

Read webhook_active here. While it is false on a connected app, GitHub isn’t telling Base44 about pushes, so nothing pulls automatically and you have to call Pull changes from GitHub yourself.

This endpoint accepts a personal API key. Workspace API keys are not authorized for it and are rejected with a 403.

GET

api

apps

{app_id}

github

connection

Get GitHub connection

curl --request GET \
  --url https://app.base44.com/api/apps/{app_id}/github/connection \
  --header 'api_key: <api-key>'

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://app.base44.com/api/apps/{app_id}/github/connection', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.base44.com/api/apps/{app_id}/github/connection",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/apps/{app_id}/github/connection"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/apps/{app_id}/github/connection")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "connected": true,
  "repo_full_name": "base44/lead-tracker",
  "repo_url": "https://github.com/base44/lead-tracker",
  "clone_urls": {
    "https": "https://github.com/base44/lead-tracker.git",
    "ssh": "git@github.com:base44/lead-tracker.git",
    "gh_cli": "gh repo clone base44/lead-tracker"
  },
  "org_name": "base44",
  "status": "active",
  "installation_id": "58231904",
  "webhook_active": true,
  "connected_by_user_id": "6820f3a4e7b91d003c45a1f0"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

api_key

string

header

required

Personal API key.

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

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

Example:

true

repo_full_name

string | null

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

Example:

"base44/lead-tracker"

repo_url

string | null

URL of the repository on GitHub. 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. null when connected is false.

Show child attributes

org_name

string | null

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

Example:

"base44"

status

enum<string> | null

Health of the connection. 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. null when connected is false.

Available options:

active,

disconnected,

error,

revoked

Example:

"active"

installation_id

string | null

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

Example:

"58231904"

webhook_active

boolean

default:false

true when 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. null when connected is false.

Example:

"6820f3a4e7b91d003c45a1f0"

⌘I

App Management API (Beta)

Entities API (Beta)

Virality API (Beta)

Workflows API (Beta)

Analytics API (Beta)

Google Ads API (Beta)

Monitoring API

Audit Logs API

Get GitHub connection

Authorizations

Path Parameters

Response