Get list of available organizations

Returns the organizations available to the caller, oldest first. An API key resolves to the single organization it belongs to; a user token returns every organization the user is a member of. Results are capped at limit (default 250) per page; the server may return fewer and caps the value at its own maximum. Every response carries limit and nextCursor; pass nextCursor as the cursor query parameter to fetch the next page, repeating until it is null.

GET

organizations

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.clickhouse.cloud/v1/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.clickhouse.cloud/v1/organizations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$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.clickhouse.cloud/v1/organizations"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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://api.clickhouse.cloud/v1/organizations")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "privateEndpoints": [
        {
          "id": "<string>",
          "description": "<string>",
          "cloudProvider": "gcp",
          "region": "ap-northeast-1"
        }
      ],
      "byocConfig": [
        {
          "id": "<string>",
          "state": "infra-ready",
          "accountId": "123456789012",
          "accountName": "<string>",
          "regionId": "ap-northeast-1",
          "cloudProvider": "gcp",
          "displayName": "<string>"
        }
      ],
      "enableCoreDumps": true,
      "capabilities": {
        "snapshots": true
      }
    }
  ],
  "limit": 123,
  "nextCursor": "<string>"
}

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Autorizações

Authorization

string

header

obrigatório

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Parâmetros de consulta

limit

integer

padrão:250

Maximum number of results to return.

Intervalo obrigatório: x >= 1

cursor

string

Opaque cursor from a previous response's nextCursor, marking where to resume the list.

Resposta

Successful response

status

number

HTTP status code.

Exemplo:

200

requestId

string<uuid>

Unique id assigned to every request. UUIDv4

result

object[]

Show child attributes

limit

integer

Maximum number of results returned in this page.

nextCursor

string | null

Cursor for the next page, to be sent as the cursor query parameter. Null on the last page.

Última modificação em 12 de outubro de 2026

Get list of available organizations

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.clickhouse.cloud/v1/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.clickhouse.cloud/v1/organizations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$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.clickhouse.cloud/v1/organizations"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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://api.clickhouse.cloud/v1/organizations")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "privateEndpoints": [
        {
          "id": "<string>",
          "description": "<string>",
          "cloudProvider": "gcp",
          "region": "ap-northeast-1"
        }
      ],
      "byocConfig": [
        {
          "id": "<string>",
          "state": "infra-ready",
          "accountId": "123456789012",
          "accountName": "<string>",
          "regionId": "ap-northeast-1",
          "cloudProvider": "gcp",
          "displayName": "<string>"
        }
      ],
      "enableCoreDumps": true,
      "capabilities": {
        "snapshots": true
      }
    }
  ],
  "limit": 123,
  "nextCursor": "<string>"
}

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Primeiros passos

Serviços e infraestrutura

Bring Your Own Cloud

Dados e integrações

Conectar e consultar

Gerenciamento de acesso

Segurança e conformidade

Monitoramento e backups

Ferramentas e agentes de IA

API do Cloud

Faturamento

Suporte

ClickHouse Private

Get list of available organizations

Autorizações

Parâmetros de consulta

Resposta