Skip to main content
GET
/
console
/
organizations
List Organizations
curl --request GET \
  --url https://api.example.com/console/organizations
import requests

url = "https://api.example.com/console/organizations"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/console/organizations', 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://api.example.com/console/organizations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.example.com/console/organizations"

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

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/console/organizations")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/console/organizations")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
[
  {
    "organization_id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "status": "bootstrapping",
    "bootstrap_error": "<string>"
  }
]

Response

200 - application/json

Successful Response

​
organization_id
string
required
​
name
string
required
​
slug
string
required
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
status
enum<string>
default:bootstrapping

Lifecycle status of an organization.

Bootstrap states: BOOTSTRAPPING: Organization row exists, bootstrap worker has not yet finished provisioning tenant namespace resources. READY: Organization is fully provisioned and usable. BOOTSTRAP_FAILED: Bootstrap worker exhausted its retry budget. Recovery is manual during private beta: operators contact support or clear the failure via direct SurrealDB intervention.

Teardown states: DEACTIVATING: Cleanup worker is tearing down tenant resources. DELETED: Organization fully cleaned up.

Available options:
bootstrapping,
ready,
bootstrap_failed,
deactivating,
deleted
​
bootstrap_error
string | null