> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# ClickHouse Cloud: Clickhouse Organization Get List
> Get the ClickHouse Cloud organization the connected API key belongs to. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
Get the ClickHouse Cloud organization the connected API key belongs to.
> [!NOTE]
>
> Tool ID: `clickhouse_organization_get_list`
## Run this action
Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.
```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'clickhouse_organization_get_list',
{},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute clickhouse_organization_get_list --input '{}' --json
```
## Example response
The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.
```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
"data": {
"status": 123,
"requestId": "123e4567-e89b-42d3-a456-426614174000",
"result": [
{
"id": "123e4567-e89b-42d3-a456-426614174000",
"createdAt": "2026-01-15T12:00:00Z",
"name": "Example"
}
]
}
}
```
Use `deepline describe clickhouse_organization_get_list --json` for the latest machine-readable contract.
## Input reference
Returns a list with a single organization associated with the API key in the request.
This action requires no input fields.
Show raw input schema
### Input JSON Schema
```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
"type": "object",
"description": "Returns a list with a single organization associated with the API key in the request.",
"properties": {},
"required": [],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.status` | `number` | No | — | HTTP status code. |
| `result.data.requestId` | `string` | No | — | Unique id assigned to every request. UUIDv4 Format: `uuid`. |
| `result.data.result` | `array` | No | — | — |
| `result.data.result[].id` | `string` | No | — | Unique organization ID. Format: `uuid`. |
| `result.data.result[].createdAt` | `string` | No | — | The timestamp the organization was created. ISO-8601. Format: `date-time`. |
| `result.data.result[].name` | `string` | No | — | Name of the organization. |
| `result.data.result[].privateEndpoints` | `array` | No | — | List of private endpoints for organization |
| `result.data.result[].privateEndpoints[].id` | `string` | No | — | Private endpoint identifier |
| `result.data.result[].privateEndpoints[].description` | `string` | No | — | Description of private endpoint |
| `result.data.result[].privateEndpoints[].cloudProvider` | `"gcp" \| "aws" \| "azure"` | No | — | Cloud provider in which the private endpoint is lcoated Allowed: `gcp`, `aws`, `azure`. |
| `result.data.result[].privateEndpoints[].region` | `"ap-northeast-1" \| "ap-northeast-2" \| "ap-south-1" \| "ap-southeast-1" \| "ap-southeast-2" \| "ca-central-1" \| "eu-central-1" \| "eu-west-1" \| "eu-west-2" \| "il-central-1" \| "us-east-1" \| "us-east-2" \| "us-west-2" \| "us-east1" \| "us-central1" \| "europe-west2" \| "europe-west4" \| "asia-southeast1" \| "asia-northeast1" \| "eastus" \| "eastus2" \| "westus3" \| "germanywestcentral" \| "centralus"` | No | — | Region in which the private endpoint is located Allowed: `ap-northeast-1`, `ap-northeast-2`, `ap-south-1`, `ap-southeast-1`, `ap-southeast-2`, `ca-central-1`, `eu-central-1`, `eu-west-1`, `eu-west-2`, `il-central-1`, `us-east-1`, `us-east-2`, `us-west-2`, `us-east1`, `us-central1`, `europe-west2`, `europe-west4`, `asia-southeast1`, `asia-northeast1`, `eastus`, `eastus2`, `westus3`, `germanywestcentral`, `centralus`. |
| `result.data.result[].byocConfig` | `array` | No | — | BYOC configuration for the organization |
| `result.data.result[].byocConfig[].id` | `string` | No | — | Unique identifier of the BYOC configuration |
| `result.data.result[].byocConfig[].state` | `"infra-ready" \| "infra-provisioning" \| "infra-terminated"` | No | — | State of the infrastructure Allowed: `infra-ready`, `infra-provisioning`, `infra-terminated`. |
| `result.data.result[].byocConfig[].accountName` | `string` | No | — | Name of the account |
| `result.data.result[].byocConfig[].regionId` | `"ap-northeast-1" \| "ap-northeast-2" \| "ap-south-1" \| "ap-southeast-1" \| "ap-southeast-2" \| "ca-central-1" \| "eu-central-1" \| "eu-west-1" \| "eu-west-2" \| "il-central-1" \| "us-east-1" \| "us-east-2" \| "us-west-2" \| "us-east1" \| "us-central1" \| "europe-west2" \| "europe-west4" \| "asia-southeast1" \| "asia-northeast1" \| "eastus" \| "eastus2" \| "westus3" \| "germanywestcentral" \| "centralus"` | No | — | Region for which the BYOC has been configured and where it is possible to create services Allowed: `ap-northeast-1`, `ap-northeast-2`, `ap-south-1`, `ap-southeast-1`, `ap-southeast-2`, `ca-central-1`, `eu-central-1`, `eu-west-1`, `eu-west-2`, `il-central-1`, `us-east-1`, `us-east-2`, `us-west-2`, `us-east1`, `us-central1`, `europe-west2`, `europe-west4`, `asia-southeast1`, `asia-northeast1`, `eastus`, `eastus2`, `westus3`, `germanywestcentral`, `centralus`. |
| `result.data.result[].byocConfig[].cloudProvider` | `"gcp" \| "aws" \| "azure"` | No | — | Cloud provider of the region Allowed: `gcp`, `aws`, `azure`. |
| `result.data.result[].byocConfig[].displayName` | `string` | No | — | Human readable name for infrastructure |
| `result.data.result[].enableCoreDumps` | `boolean` | No | — | 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. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"status": {
"type": "number",
"description": "HTTP status code."
},
"requestId": {
"type": "string",
"description": "Unique id assigned to every request. UUIDv4",
"format": "uuid"
},
"result": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"description": "Unique organization ID.",
"format": "uuid"
},
"createdAt": {
"type": "string",
"description": "The timestamp the organization was created. ISO-8601.",
"format": "date-time"
},
"name": {
"type": "string",
"description": "Name of the organization."
},
"privateEndpoints": {
"type": "array",
"description": "List of private endpoints for organization",
"items": {
"properties": {
"id": {
"type": "string",
"description": "Private endpoint identifier"
},
"description": {
"type": "string",
"description": "Description of private endpoint"
},
"cloudProvider": {
"type": "string",
"description": "Cloud provider in which the private endpoint is lcoated",
"enum": [
"gcp",
"aws",
"azure"
]
},
"region": {
"type": "string",
"description": "Region in which the private endpoint is located",
"enum": [
"ap-northeast-1",
"ap-northeast-2",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-west-1",
"eu-west-2",
"il-central-1",
"us-east-1",
"us-east-2",
"us-west-2",
"us-east1",
"us-central1",
"europe-west2",
"europe-west4",
"asia-southeast1",
"asia-northeast1",
"eastus",
"eastus2",
"westus3",
"germanywestcentral",
"centralus"
]
}
},
"additionalProperties": false
}
},
"byocConfig": {
"type": "array",
"description": "BYOC configuration for the organization",
"items": {
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the BYOC configuration"
},
"state": {
"type": "string",
"description": "State of the infrastructure",
"enum": [
"infra-ready",
"infra-provisioning",
"infra-terminated"
]
},
"accountName": {
"type": "string",
"description": "Name of the account"
},
"regionId": {
"type": "string",
"description": "Region for which the BYOC has been configured and where it is possible to create services",
"enum": [
"ap-northeast-1",
"ap-northeast-2",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-west-1",
"eu-west-2",
"il-central-1",
"us-east-1",
"us-east-2",
"us-west-2",
"us-east1",
"us-central1",
"europe-west2",
"europe-west4",
"asia-southeast1",
"asia-northeast1",
"eastus",
"eastus2",
"westus3",
"germanywestcentral",
"centralus"
]
},
"cloudProvider": {
"type": "string",
"description": "Cloud provider of the region",
"enum": [
"gcp",
"aws",
"azure"
]
},
"displayName": {
"type": "string",
"description": "Human readable name for infrastructure"
}
},
"additionalProperties": false
}
},
"enableCoreDumps": {
"type": "boolean",
"description": "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."
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [ClickHouse Cloud provider guide](https://deepline.com/docs/providers/clickhouse/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.