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

# Zoho CRM: Variable Groups Get Variable Group By ID

> Get one Zoho CRM variable group by its ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get one Zoho CRM variable group by its ID.

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

## 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(
  'zoho_crm_variable_groups_get_variable_group_by_id',
  {
    "id": "id_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_variable_groups_get_variable_group_by_id --input '{
  "id": "id_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": {
    "variable_groups": [
      {
        "display_label": "example",
        "api_name": "Example",
        "name": "Example",
        "description": null,
        "id": "id_123",
        "source": "example"
      }
    ]
  }
}
```

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

## Input reference

To get the particular variable group

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | variable groups id in url path Maximum length: 255. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "To get the particular variable group",
    "properties": {
      "id": {
        "type": "string",
        "description": "variable groups id in url path",
        "maxLength": 255
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Container for results of a targeted variable group retrieval, exposing a variable\_groups array of lookup summaries. |
| `result.data.variable_groups` | `array` | Yes | — | Field: variable\_groups Maximum items: 1. |
| `result.data.variable_groups[].display_label` | `string` | Yes | — | Field: display\_label Maximum length: 255. |
| `result.data.variable_groups[].api_name` | `string` | Yes | — | Field: api\_name Maximum length: 255. |
| `result.data.variable_groups[].name` | `string` | Yes | — | Field: name Maximum length: 255. |
| `result.data.variable_groups[].description` | `null` | Yes | — | Field: description |
| `result.data.variable_groups[].id` | `string` | Yes | — | Field: id Maximum length: 255. |
| `result.data.variable_groups[].rid` | `string` | No | — | Field: rid Maximum length: 255. |
| `result.data.variable_groups[].source` | `string` | Yes | — | Field: source Maximum length: 255. |
| `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": "Container for results of a targeted variable group retrieval, exposing a variable_groups array of lookup summaries.",
        "properties": {
          "variable_groups": {
            "type": "array",
            "description": "Field: variable_groups",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Variable group attributes returned when retrieving records by a specific identifier, including display label, API name, name, description, id, source, and rid.",
              "properties": {
                "display_label": {
                  "type": "string",
                  "description": "Field: display_label",
                  "maxLength": 255
                },
                "api_name": {
                  "type": "string",
                  "description": "Field: api_name",
                  "maxLength": 255
                },
                "name": {
                  "type": "string",
                  "description": "Field: name",
                  "maxLength": 255
                },
                "description": {
                  "type": "null",
                  "description": "Field: description"
                },
                "id": {
                  "type": "string",
                  "description": "Field: id",
                  "maxLength": 255
                },
                "rid": {
                  "type": "string",
                  "description": "Field: rid",
                  "maxLength": 255
                },
                "source": {
                  "type": "string",
                  "description": "Field: source",
                  "maxLength": 255
                }
              },
              "required": [
                "api_name",
                "description",
                "display_label",
                "id",
                "name",
                "source"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "variable_groups"
        ],
        "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

* [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.