Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

Get list of available organizations

GET/v1/organizations
API playground

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.

Authorizations

Query parameters

  • limitoptionalinteger

    Maximum number of results to return.

    minimum: 1
    Default: 250
  • cursoroptionalstring

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

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalarray ofobject
    7 properties
    • idoptionalstring

      Unique organization ID.

      format: uuid
    • createdAtoptionalstring

      The timestamp the organization was created. ISO-8601.

      format: date-time
    • nameoptionalstring

      Name of the organization.

    • privateEndpointsoptionalarray ofobject

      List of private endpoints for organization

      4 properties
      • idoptionalstring

        Private endpoint identifier

      • descriptionoptionalstring

        Description of private endpoint

      • cloudProvideroptionalgcporawsorazure

        Cloud provider in which the private endpoint is lcoated

      • regionoptionalap-northeast-1orap-northeast-2orap-south-1orap-southeast-1orap-southeast-2orca-central-1+18 more

        Region in which the private endpoint is located

    • byocConfigoptionalarray ofobject

      BYOC configuration for the organization

      7 properties
      • idoptionalstring

        Unique identifier of the BYOC configuration

      • stateoptionalinfra-provisioningorinfra-terminatedorinfra-terminatingorinfra-readyorinfra-degradedorinfra-upgrading

        State of the infrastructure

        Example: "infra-ready"
      • accountIdoptionalstring

        Cloud account ID the BYOC infrastructure is bound to: AWS account ID, GCP project ID, or Azure subscription ID

        Example: "123456789012"
      • accountNamedeprecatedstring

        DEPRECATED. Use accountId instead. Cloud account ID the BYOC infrastructure is bound to

      • regionIdoptionalap-northeast-1orap-northeast-2orap-south-1orap-southeast-1orap-southeast-2orca-central-1+18 more

        Region for which the BYOC has been configured and where it is possible to create services

      • cloudProvideroptionalgcporawsorazure

        Cloud provider of the region

      • displayNameoptionalstring

        Human readable name for infrastructure

    • enableCoreDumpsoptionalboolean

      Whether crash reports (core dumps) collection is enabled for services in the organization. When disabled at the organization level, individual services cannot enable crash reports.

    • capabilitiesoptionalobject
      1 properties
      • snapshotsoptionalboolean

        Whether the organization is eligible to enable snapshots on its primary services.

  • limitoptionalinteger

    Maximum number of results returned in this page.

  • nextCursoroptionalstring | null

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

Report an issue
Navigation