> ## 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 Click Stack Get Role

> Get one ClickStack team role by its ID, with its permissions. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get one ClickStack team role by its ID, with its permissions.

> [!NOTE]
>
> Tool ID: `clickhouse_click_stack_get_role`

## 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_click_stack_get_role',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "serviceId": "123e4567-e89b-42d3-a456-426614174000",
    "clickStackRoleId": "click_stack_role_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute clickhouse_click_stack_get_role --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000",
  "clickStackRoleId": "click_stack_role_123"
}' --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": "id_123",
      "name": "Example",
      "permissions": [
        {
          "action": "example",
          "subject": "Introduction"
        }
      ],
      "isPredefined": true
    }
  }
}
```

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

## Input reference

**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific role by ID.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.organizationId` | `string` | Yes | — | ID of the organization that owns the service. Format: `uuid`. |
| `payload.serviceId` | `string` | Yes | — | ID of the ClickStack service. Format: `uuid`. |
| `payload.clickStackRoleId` | `string` | Yes | — | id parameter |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific role by ID.",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the organization that owns the service.",
        "format": "uuid"
      },
      "serviceId": {
        "type": "string",
        "description": "ID of the ClickStack service.",
        "format": "uuid"
      },
      "clickStackRoleId": {
        "type": "string",
        "description": "id parameter"
      }
    },
    "required": [
      "organizationId",
      "serviceId",
      "clickStackRoleId"
    ],
    "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` | `object` | No | — | — |
| `result.data.result.id` | `string` | Yes | — | Role ID. |
| `result.data.result.name` | `string` | Yes | — | Role name. |
| `result.data.result.description` | `string` | No | — | Human-readable role description. |
| `result.data.result.permissions` | `array` | Yes | — | The CASL permissions granted by this role. |
| `result.data.result.permissions[].action` | `string` | Yes | — | The action this permission grants or denies. |
| `result.data.result.permissions[].subject` | `string` | Yes | — | The resource the action applies to. |
| `result.data.result.permissions[].inverted` | `boolean` | No | — | When true, the rule denies rather than grants the action. |
| `result.data.result.permissions[].integration` | `string` | No | — | The integration the permission is scoped to. |
| `result.data.result.permissions[].conditions` | `record` | No | — | — |
| `result.data.result.isPredefined` | `boolean` | Yes | — | Whether this is an immutable predefined/system role. |
| `result.data.result.createdAt` | `string` | No | — | Creation timestamp. Format: `date-time`. |
| `result.data.result.updatedAt` | `string` | No | — | Last update timestamp. Format: `date-time`. |
| `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": {
            "properties": {
              "id": {
                "type": "string",
                "description": "Role ID."
              },
              "name": {
                "type": "string",
                "description": "Role name."
              },
              "description": {
                "type": "string",
                "description": "Human-readable role description."
              },
              "permissions": {
                "type": "array",
                "description": "The CASL permissions granted by this role.",
                "items": {
                  "properties": {
                    "action": {
                      "type": "string",
                      "description": "The action this permission grants or denies."
                    },
                    "subject": {
                      "type": "string",
                      "description": "The resource the action applies to."
                    },
                    "inverted": {
                      "type": "boolean",
                      "description": "When true, the rule denies rather than grants the action."
                    },
                    "integration": {
                      "type": "string",
                      "description": "The integration the permission is scoped to."
                    },
                    "conditions": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  },
                  "required": [
                    "action",
                    "subject"
                  ],
                  "additionalProperties": false
                }
              },
              "isPredefined": {
                "type": "boolean",
                "description": "Whether this is an immutable predefined/system role."
              },
              "createdAt": {
                "type": "string",
                "description": "Creation timestamp.",
                "format": "date-time"
              },
              "updatedAt": {
                "type": "string",
                "description": "Last update timestamp.",
                "format": "date-time"
              }
            },
            "required": [
              "id",
              "name",
              "permissions",
              "isPredefined"
            ],
            "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.