Organization

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/v1/organizations

Request

Base URL: https://api.clickhouse.cloud
URL: https://api.clickhouse.cloud/v1/organizations
Auth: HTTP basic

Query parameters

limitinteger

Maximum number of results to return.

cursorstring

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

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

limitinteger

Maximum number of results returned in this page.

nextCursorstring nullable

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

Example response

{
  "status": 200,
  "result": [
    {
      "byocConfig": [
        {
          "state": "infra-ready",
          "accountId": "123456789012"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.