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

> this endpoint is used to get tags from a module. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

this endpoint is used to get tags from a module.

<Info>
  Tool ID: `zoho_crm_tags_get_tags`
</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_tags_get_tags',
  {
    "module": "module_api_name"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_tags_get_tags --input '{
  "module": "module_api_name"
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "tags": [
      {
        "created_time": "2026-01-15T12:00:00Z",
        "modified_time": "2026-01-15T12:00:00Z",
        "name": "Example",
        "modified_by": {
          "name": "Example",
          "id": "id_123"
        },
        "id": "id_123",
        "created_by": {
          "name": "Example",
          "id": "id_123"
        },
        "color_code": "example"
      }
    ],
    "info": {
      "count": 123,
      "allowed_count": 123
    }
  }
}
```

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

## Input reference

to get tags from a module

| Name              | Type                                                          | Required | Default | Details                                                                                                                                                                                                 |
| ----------------- | ------------------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.module`  | `"module_api_name"`                                           | Yes      | —       | Module api name Allowed: `module_api_name`.                                                                                                                                                             |
| `payload.include` | `"type" \| "associated_record_count" \| "last_accessed_time"` | No       | —       | It defines whether the tag is associated to configurations, associated record counts and when the tag is last associated to a record. Allowed: `type`, `associated_record_count`, `last_accessed_time`. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "to get tags from a module",
    "properties": {
      "module": {
        "type": "string",
        "description": "Module api name",
        "enum": [
          "module_api_name"
        ]
      },
      "include": {
        "type": "string",
        "description": "It defines whether the tag is associated to configurations, associated record counts and when the tag is last associated to a record.",
        "enum": [
          "type",
          "associated_record_count",
          "last_accessed_time"
        ]
      }
    },
    "required": [
      "module"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                  | Type             | Required | Default | Details                                                         |
| ------------------------------------- | ---------------- | -------- | ------- | --------------------------------------------------------------- |
| `result.data`                         | `object`         | Yes      | —       | Success Response of Tags Get api                                |
| `result.data.tags`                    | `array`          | Yes      | —       | Field: tags Maximum items: 484.                                 |
| `result.data.tags[].created_time`     | `string`         | Yes      | —       | Field: created\_time Format: `date-time`. Maximum length: 255.  |
| `result.data.tags[].modified_time`    | `string`         | Yes      | —       | Field: modified\_time Format: `date-time`. Maximum length: 255. |
| `result.data.tags[].name`             | `string`         | Yes      | —       | Field: name Maximum length: 255.                                |
| `result.data.tags[].modified_by`      | `object`         | Yes      | —       | Nested schema for modified\_by                                  |
| `result.data.tags[].modified_by.name` | `string`         | Yes      | —       | Field: name Maximum length: 255.                                |
| `result.data.tags[].modified_by.id`   | `string`         | Yes      | —       | Field: id Maximum length: 255.                                  |
| `result.data.tags[].id`               | `string`         | Yes      | —       | Field: id Maximum length: 255.                                  |
| `result.data.tags[].created_by`       | `object`         | Yes      | —       | Nested schema for created\_by                                   |
| `result.data.tags[].created_by.name`  | `string`         | Yes      | —       | Field: name Maximum length: 255.                                |
| `result.data.tags[].created_by.id`    | `string`         | Yes      | —       | Field: id Maximum length: 255.                                  |
| `result.data.tags[].color_code`       | `string \| null` | Yes      | —       | Field: color\_code Maximum length: 255.                         |
| `result.data.info`                    | `object`         | Yes      | —       | Nested schema for info                                          |
| `result.data.info.record_limit`       | `integer`        | No       | —       | Field: record\_limit Format: `int32`.                           |
| `result.data.info.count`              | `integer`        | Yes      | —       | Field: count Format: `int32`.                                   |
| `result.data.info.allowed_count`      | `integer`        | Yes      | —       | Field: allowed\_count Format: `int32`.                          |
| `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": "Success Response of Tags Get api",
        "properties": {
          "tags": {
            "type": "array",
            "description": "Field: tags",
            "maxItems": 484,
            "items": {
              "type": "object",
              "description": "Nested schema for tags",
              "properties": {
                "created_time": {
                  "type": "string",
                  "description": "Field: created_time",
                  "maxLength": 255,
                  "format": "date-time"
                },
                "modified_time": {
                  "type": "string",
                  "description": "Field: modified_time",
                  "maxLength": 255,
                  "format": "date-time"
                },
                "name": {
                  "type": "string",
                  "description": "Field: name",
                  "maxLength": 255
                },
                "modified_by": {
                  "type": "object",
                  "description": "Nested schema for modified_by",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "additionalProperties": false
                },
                "id": {
                  "type": "string",
                  "description": "Field: id",
                  "maxLength": 255
                },
                "created_by": {
                  "type": "object",
                  "description": "Nested schema for created_by",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "additionalProperties": false
                },
                "color_code": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Field: color_code",
                  "maxLength": 255
                }
              },
              "required": [
                "color_code",
                "created_by",
                "created_time",
                "id",
                "modified_by",
                "modified_time",
                "name"
              ],
              "additionalProperties": false
            }
          },
          "info": {
            "type": "object",
            "description": "Nested schema for info",
            "properties": {
              "record_limit": {
                "type": "integer",
                "description": "Field: record_limit",
                "format": "int32"
              },
              "count": {
                "type": "integer",
                "description": "Field: count",
                "format": "int32"
              },
              "allowed_count": {
                "type": "integer",
                "description": "Field: allowed_count",
                "format": "int32"
              }
            },
            "required": [
              "allowed_count",
              "count"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "info",
          "tags"
        ],
        "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)