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"
}

GitHub

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, if it has one.

Calling this re-checks the connection against GitHub and tries to repair a broken one, so what it reports can change between two calls even when nobody has touched the app.

An app that never connected and one whose repository was disconnected look the same here, so this response can’t tell you which happened.

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"
}

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

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

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.

Show child attributes

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"

Base44 APIs

Apps API (Beta)

Monitoring API

Audit Logs API

Get GitHub connection

Authorizations

Path Parameters

Response