> ## 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 Quotas Get List

> List a ClickHouse Cloud organization's resource quotas with their current usage. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List a ClickHouse Cloud organization's resource quotas with their current usage.

> [!NOTE]
>
> Tool ID: `clickhouse_organization_quotas_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_quotas_get_list',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute clickhouse_organization_quotas_get_list --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000"
}' --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": [
      {
        "quotaCode": "services-per-organization",
        "name": "Example",
        "description": "Example description",
        "scope": "organization",
        "value": 123,
        "adjustable": true
      }
    ]
  }
}
```

Use `deepline describe clickhouse_organization_quotas_get_list --json` for the latest machine-readable contract.

## Input reference

**Disclaimer:** This beta endpoint is evolving. The API contract may change. Returns the resource quotas enforced for the organization together with their current usage where available. Quotas that do not apply to the organization are omitted. Quota values reflect the limits currently enforced, so they can be polled to detect changes, for example after a billing status change. The response contains one entry per quota code. quotas enforced per resource may additionally appear under resource-scoped endpoints in the future.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.organizationId` | `string` | Yes | — | ID of the requested organization. Format: `uuid`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "**Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the resource quotas enforced for the organization together with their current usage where available. Quotas that do not apply to the organization are omitted. Quota values reflect the limits currently enforced, so they can be polled to detect changes, for example after a billing status change. The response contains one entry per quota code; quotas enforced per resource may additionally appear under resource-scoped endpoints in the future.",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the requested organization.",
        "format": "uuid"
      }
    },
    "required": [
      "organizationId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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[].quotaCode` | `"services-per-organization" \| "postgres-services-per-organization" \| "replicas-per-warehouse"` | Yes | — | Stable identifier of the quota. Use it to request a single quota by code. Allowed: `services-per-organization`, `postgres-services-per-organization`, `replicas-per-warehouse`. |
| `result.data.result[].name` | `string` | Yes | — | Human-readable name of the quota. |
| `result.data.result[].description` | `string` | Yes | — | Explanation of the resource the quota limits and how the limit is applied. |
| `result.data.result[].scope` | `"organization" \| "warehouse"` | Yes | — | Granularity at which the limit is applied. For example, `replicas-per-warehouse` is an organization-wide setting that limits each warehouse individually. Allowed: `organization`, `warehouse`. |
| `result.data.result[].value` | `integer` | Yes | — | Limit currently applied to the organization, including any adjustments made for the organization. The value can change when the billing status of the organization changes. Minimum: 0. |
| `result.data.result[].usage` | `integer` | No | — | Current consumption of the quota. Omitted for quotas that do not report usage. Usage can exceed `value` when a limit was lowered after resources were created. existing resources are not affected. Minimum: 0. |
| `result.data.result[].adjustable` | `boolean` | Yes | — | Whether the limit can be raised for the organization by contacting ClickHouse support. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### 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": {
                "quotaCode": {
                  "type": "string",
                  "description": "Stable identifier of the quota. Use it to request a single quota by code.",
                  "enum": [
                    "services-per-organization",
                    "postgres-services-per-organization",
                    "replicas-per-warehouse"
                  ]
                },
                "name": {
                  "type": "string",
                  "description": "Human-readable name of the quota."
                },
                "description": {
                  "type": "string",
                  "description": "Explanation of the resource the quota limits and how the limit is applied."
                },
                "scope": {
                  "type": "string",
                  "description": "Granularity at which the limit is applied. For example, `replicas-per-warehouse` is an organization-wide setting that limits each warehouse individually.",
                  "enum": [
                    "organization",
                    "warehouse"
                  ]
                },
                "value": {
                  "type": "integer",
                  "description": "Limit currently applied to the organization, including any adjustments made for the organization. The value can change when the billing status of the organization changes.",
                  "minimum": 0
                },
                "usage": {
                  "type": "integer",
                  "description": "Current consumption of the quota. Omitted for quotas that do not report usage. Usage can exceed `value` when a limit was lowered after resources were created; existing resources are not affected.",
                  "minimum": 0
                },
                "adjustable": {
                  "type": "boolean",
                  "description": "Whether the limit can be raised for the organization by contacting ClickHouse support."
                }
              },
              "required": [
                "quotaCode",
                "name",
                "description",
                "scope",
                "value",
                "adjustable"
              ],
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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.