> ## 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: README

> GET /settings/variables/1234567890. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

GET /settings/variables/1234567890.

<Info>
  Tool ID: `zoho_crm_variables_get_variable_by_id`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_variables_get_variable_by_id',
  {
    "id": "id_123"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_variables_get_variable_by_id --input '{
  "id": "id_123"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "variables": [
      {
        "api_name": "Example",
        "name": "Example",
        "description": "Example description",
        "id": "id_123",
        "source": "example",
        "type": "example",
        "variable_group": {
          "api_name": "Example",
          "id": "id_123"
        },
        "value": "example"
      }
    ]
  }
}
```

Use `deepline tools get zoho_crm_variables_get_variable_by_id --json` for the latest machine-readable contract.

## Input reference

Get Variables by ID

| Name                | Type     | Required | Default | Details                                            |
| ------------------- | -------- | -------- | ------- | -------------------------------------------------- |
| `payload.id`        | `string` | Yes      | —       | variables id in url path Maximum length: 255.      |
| `payload.group`     | `string` | No       | —       | Field to filter variables from variable groups id  |
| `payload.group_rid` | `string` | No       | —       | Field to filter variables from variable groups rid |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Get Variables by ID",
    "properties": {
      "id": {
        "type": "string",
        "description": "variables id in url path",
        "maxLength": 255
      },
      "group": {
        "type": "string",
        "description": "Field to filter variables from variable groups id"
      },
      "group_rid": {
        "type": "string",
        "description": "Field to filter variables from variable groups rid"
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                              | Type             | Required | Default | Details                                                                                 |
| ------------------------------------------------- | ---------------- | -------- | ------- | --------------------------------------------------------------------------------------- |
| `result.data`                                     | `object`         | Yes      | —       | Collection wrapper returning variables associated with the specified group identifier.  |
| `result.data.variables`                           | `array`          | Yes      | —       | Field: variables Maximum items: 1.                                                      |
| `result.data.variables[].read_only`               | `boolean`        | No       | —       | Field: read\_only                                                                       |
| `result.data.variables[].api_name`                | `string`         | Yes      | —       | Field: api\_name Maximum length: 255.                                                   |
| `result.data.variables[].name`                    | `string`         | Yes      | —       | Field: name Maximum length: 255.                                                        |
| `result.data.variables[].description`             | `string \| null` | Yes      | —       | Field: description Maximum length: 255.                                                 |
| `result.data.variables[].id`                      | `string`         | Yes      | —       | Field: id Maximum length: 255.                                                          |
| `result.data.variables[].source`                  | `string`         | Yes      | —       | Field: source Maximum length: 255.                                                      |
| `result.data.variables[].type`                    | `string`         | Yes      | —       | Field: type Maximum length: 255.                                                        |
| `result.data.variables[].variable_group`          | `object`         | Yes      | —       | Compact representation of a variable group in read responses, including id and apiName. |
| `result.data.variables[].variable_group.api_name` | `string`         | Yes      | —       | Field: api\_name Maximum length: 255.                                                   |
| `result.data.variables[].variable_group.id`       | `string`         | Yes      | —       | Field: id Maximum length: 255.                                                          |
| `result.data.variables[].value`                   | `string`         | Yes      | —       | Field: value Maximum length: 255.                                                       |
| `result.meta`                                     | `object`         | No       | —       | Additional response metadata (status, paging).                                          |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Collection wrapper returning variables associated with the specified group identifier.",
        "properties": {
          "variables": {
            "type": "array",
            "description": "Field: variables",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Full read model for a variable, including apiName, name, description, id, source, type, value, and its variable group summary.",
              "properties": {
                "read_only": {
                  "type": "boolean",
                  "description": "Field: read_only"
                },
                "api_name": {
                  "type": "string",
                  "description": "Field: api_name",
                  "maxLength": 255
                },
                "name": {
                  "type": "string",
                  "description": "Field: name",
                  "maxLength": 255
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Field: description",
                  "maxLength": 255
                },
                "id": {
                  "type": "string",
                  "description": "Field: id",
                  "maxLength": 255
                },
                "source": {
                  "type": "string",
                  "description": "Field: source",
                  "maxLength": 255
                },
                "type": {
                  "type": "string",
                  "description": "Field: type",
                  "maxLength": 255
                },
                "variable_group": {
                  "type": "object",
                  "description": "Compact representation of a variable group in read responses, including id and apiName.",
                  "properties": {
                    "api_name": {
                      "type": "string",
                      "description": "Field: api_name",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "api_name",
                    "id"
                  ],
                  "additionalProperties": false
                },
                "value": {
                  "type": "string",
                  "description": "Field: value",
                  "maxLength": 255
                }
              },
              "required": [
                "api_name",
                "description",
                "id",
                "name",
                "source",
                "type",
                "value",
                "variable_group"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "variables"
        ],
        "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](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)