> ## 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: Bulk Read Create Bulk Read Job

> Start a bulk export of Zoho CRM records from a module to a CSV or ICS file, with optional filters. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Start a bulk export of Zoho CRM records from a module to a CSV or ICS file, with optional filters.

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

## 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_bulk_read_create_bulk_read_job',
  {
    "query": {
      "module": {
        "api_name": "Example"
      }
    }
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_bulk_read_create_bulk_read_job --input '{
  "query": {
    "module": {
      "api_name": "Example"
    }
  }
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe zoho_crm_bulk_read_create_bulk_read_job --json` for the complete live contract.

## Input reference

The request body

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.callback` | `object` | No | — | The callback |
| `payload.query` | `object` | Yes | — | The query |
| `payload.file_type` | `"csv" \| "ics"` | No | — | The file type Allowed: `csv`, `ics`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "The request body",
    "properties": {
      "callback": {
        "type": "object",
        "description": "The callback",
        "properties": {
          "url": {
            "type": "string",
            "description": "The url",
            "enum": [
              "https://www.example.com/callback"
            ]
          },
          "method": {
            "type": "string",
            "description": "The method",
            "enum": [
              "post"
            ]
          }
        },
        "required": [
          "url",
          "method"
        ],
        "additionalProperties": false
      },
      "query": {
        "type": "object",
        "description": "The query",
        "properties": {
          "module": {
            "type": "object",
            "description": "The module",
            "properties": {
              "api_name": {
                "type": "string",
                "description": "The api name",
                "maxLength": 255
              }
            },
            "required": [
              "api_name"
            ],
            "additionalProperties": false
          },
          "cvid": {
            "type": [
              "string",
              "null"
            ],
            "description": "The cvid",
            "maxLength": 100
          },
          "fields": {
            "type": "array",
            "description": "The fields",
            "maxItems": 1000,
            "items": {
              "type": "string",
              "description": "The fields item",
              "maxLength": 500
            }
          },
          "page": {
            "type": [
              "integer",
              "null"
            ],
            "description": "The page",
            "format": "int32"
          },
          "criteria": {
            "type": "object",
            "description": "The criteria",
            "properties": {
              "group_operator": {
                "type": "string",
                "description": "The group operator",
                "enum": [
                  "or",
                  "and"
                ]
              },
              "group": {
                "type": "array",
                "description": "The group",
                "maxItems": 1000,
                "items": {
                  "type": "object",
                  "description": "The group item",
                  "properties": {
                    "field": {
                      "type": "object",
                      "description": "The field",
                      "properties": {
                        "api_name": {
                          "type": "string",
                          "description": "The api name",
                          "maxLength": 255
                        }
                      },
                      "required": [
                        "api_name"
                      ],
                      "additionalProperties": false
                    },
                    "value": {
                      "type": "string",
                      "description": "The value",
                      "maxLength": 500
                    },
                    "type": {
                      "type": "string",
                      "description": "The type",
                      "enum": [
                        "value"
                      ]
                    },
                    "comparator": {
                      "type": "string",
                      "description": "The comparator",
                      "enum": [
                        "equal",
                        "contains",
                        "ends_with",
                        "not_contains",
                        "not_equal",
                        "starts_with"
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "value",
                    "comparator"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "required": [
              "group_operator",
              "group"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "module"
        ],
        "additionalProperties": false
      },
      "file_type": {
        "type": "string",
        "description": "The file type",
        "enum": [
          "csv",
          "ics"
        ]
      }
    },
    "required": [
      "query"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | The response |
| `result.data.data` | `array` | Yes | — | The data Maximum items: 1000. |
| `result.data.data[].status` | `"success"` | Yes | — | The status Allowed: `success`. |
| `result.data.data[].code` | `"ADDED_SUCCESSFULLY"` | Yes | — | The code Allowed: `ADDED_SUCCESSFULLY`. |
| `result.data.data[].message` | `"Added successfully."` | Yes | — | The message Allowed: `Added successfully.`. |
| `result.data.data[].details` | `object` | Yes | — | The details |
| `result.data.data[].details.id` | `string` | Yes | — | The id Maximum length: 100. |
| `result.data.data[].details.operation` | `"read"` | Yes | — | The operation Allowed: `read`. Maximum length: 500. |
| `result.data.data[].details.state` | `"COMPLETED" \| "ADDED" \| "IN PROGRESS" \| "FAILURE"` | Yes | — | The state Allowed: `COMPLETED`, `ADDED`, `IN PROGRESS`, `FAILURE`. |
| `result.data.data[].details.created_by` | `object` | Yes | — | The created by |
| `result.data.data[].details.created_by.id` | `string` | Yes | — | The id Maximum length: 100. |
| `result.data.data[].details.created_by.name` | `string` | No | — | The name Maximum length: 256. |
| `result.data.data[].details.created_time` | `string` | Yes | — | The created time Format: `date-time`. |
| `result.data.info` | `record` | Yes | — | The info |
| `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": "The response",
        "properties": {
          "data": {
            "type": "array",
            "description": "The data",
            "maxItems": 1000,
            "items": {
              "type": "object",
              "description": "The data item",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "The status",
                  "enum": [
                    "success"
                  ]
                },
                "code": {
                  "type": "string",
                  "description": "The code",
                  "enum": [
                    "ADDED_SUCCESSFULLY"
                  ]
                },
                "message": {
                  "type": "string",
                  "description": "The message",
                  "enum": [
                    "Added successfully."
                  ]
                },
                "details": {
                  "type": "object",
                  "description": "The details",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "The id",
                      "maxLength": 100
                    },
                    "operation": {
                      "type": "string",
                      "description": "The operation",
                      "maxLength": 500,
                      "enum": [
                        "read"
                      ]
                    },
                    "state": {
                      "type": "string",
                      "description": "The state",
                      "enum": [
                        "COMPLETED",
                        "ADDED",
                        "IN PROGRESS",
                        "FAILURE"
                      ]
                    },
                    "created_by": {
                      "type": "object",
                      "description": "The created by",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "The id",
                          "maxLength": 100
                        },
                        "name": {
                          "type": "string",
                          "description": "The name",
                          "maxLength": 256
                        }
                      },
                      "required": [
                        "id"
                      ],
                      "additionalProperties": false
                    },
                    "created_time": {
                      "type": "string",
                      "description": "The created time",
                      "format": "date-time"
                    }
                  },
                  "required": [
                    "id",
                    "operation",
                    "state",
                    "created_by",
                    "created_time"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "status",
                "code",
                "message",
                "details"
              ],
              "additionalProperties": false
            }
          },
          "info": {
            "type": "object",
            "description": "The info",
            "additionalProperties": false
          }
        },
        "required": [
          "data",
          "info"
        ],
        "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.