> ## 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/automation/assignment_rules. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

GET /settings/automation/assignment\_rules.

<Info>
  Tool ID: `zoho_crm_assignment_rules_get_assignment_rules`
</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_assignment_rules_get_assignment_rules',
  {
    "module": "example",
    "include_inner_details": "created_by.zuid"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_assignment_rules_get_assignment_rules --input '{
  "module": "example",
  "include_inner_details": "created_by.zuid"
}' --json
```

## Example response

The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get zoho_crm_assignment_rules_get_assignment_rules --json` for the complete live contract.

## Input reference

To get all assignment rules

| Name                            | Type                                      | Required | Default | Details                                                                                               |
| ------------------------------- | ----------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- |
| `payload.module`                | `string`                                  | No       | —       | API name of the module Maximum length: 100.                                                           |
| `payload.include_inner_details` | `"created_by.zuid" \| "modified_by.zuid"` | No       | —       | To include the fields or keys of the another resource Allowed: `created_by.zuid`, `modified_by.zuid`. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "To get all assignment rules",
    "properties": {
      "module": {
        "type": "string",
        "description": "API name of the module",
        "maxLength": 100
      },
      "include_inner_details": {
        "type": "string",
        "description": "To include the fields or keys of the another resource",
        "enum": [
          "created_by.zuid",
          "modified_by.zuid"
        ]
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                                       | Type             | Required | Default | Details                                                                                                              |
| ---------------------------------------------------------- | ---------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
| `result.data`                                              | `object`         | Yes      | —       | Get all assignment rules success response                                                                            |
| `result.data.assignment_rules`                             | `array`          | No       | —       | List of all assignment rules Minimum items: 1. Maximum items: 200.                                                   |
| `result.data.assignment_rules[].id`                        | `string`         | Yes      | —       | ID of the resource Minimum length: 1. Maximum length: 19. Pattern: `^[1-9][0-9]&#123;0,18&#125;$`.                   |
| `result.data.assignment_rules[].name`                      | `string`         | Yes      | —       | Name to be displayed for the assignment rule (Required) (Unique) Minimum length: 1. Maximum length: 100.             |
| `result.data.assignment_rules[].api_name`                  | `string`         | Yes      | —       | API name of the rule (Unique) Minimum length: 1. Maximum length: 100.                                                |
| `result.data.assignment_rules[].module`                    | `object`         | No       | —       | Resource details                                                                                                     |
| `result.data.assignment_rules[].module.name`               | `string`         | Yes      | —       | Display name of the resource Maximum length: 255.                                                                    |
| `result.data.assignment_rules[].module.id`                 | `string`         | Yes      | —       | ID of the resource Minimum length: 1. Maximum length: 19. Pattern: `^[1-9][0-9]&#123;0,18&#125;$`.                   |
| `result.data.assignment_rules[].module._details`           | `null \| object` | No       | —       | \_Details Schema                                                                                                     |
| `result.data.assignment_rules[].module.api_name`           | `string`         | No       | —       | API name of the resource Maximum length: 255.                                                                        |
| `result.data.assignment_rules[].description`               | `string`         | Yes      | —       | Explains of the purpose of the assignment rule Maximum length: 250.                                                  |
| `result.data.assignment_rules[].created_by`                | `object`         | Yes      | —       | Resource details                                                                                                     |
| `result.data.assignment_rules[].created_by.name`           | `string`         | Yes      | —       | Display name of the resource Maximum length: 255.                                                                    |
| `result.data.assignment_rules[].created_by.id`             | `string`         | Yes      | —       | ID of the resource Minimum length: 1. Maximum length: 19. Pattern: `^[1-9][0-9]&#123;0,18&#125;$`.                   |
| `result.data.assignment_rules[].created_by._details`       | `null \| object` | No       | —       | \_Details Schema                                                                                                     |
| `result.data.assignment_rules[].created_by.api_name`       | `string`         | No       | —       | API name of the resource Maximum length: 255.                                                                        |
| `result.data.assignment_rules[].created_time`              | `string`         | Yes      | —       | Date and time of assignment rule creation Format: `date-time`. Maximum length: 255.                                  |
| `result.data.assignment_rules[].modified_by`               | `object`         | Yes      | —       | Resource details                                                                                                     |
| `result.data.assignment_rules[].modified_by.name`          | `string`         | Yes      | —       | Display name of the resource Maximum length: 255.                                                                    |
| `result.data.assignment_rules[].modified_by.id`            | `string`         | Yes      | —       | ID of the resource Minimum length: 1. Maximum length: 19. Pattern: `^[1-9][0-9]&#123;0,18&#125;$`.                   |
| `result.data.assignment_rules[].modified_by._details`      | `null \| object` | No       | —       | \_Details Schema                                                                                                     |
| `result.data.assignment_rules[].modified_by.api_name`      | `string`         | No       | —       | API name of the resource Maximum length: 255.                                                                        |
| `result.data.assignment_rules[].modified_time`             | `string`         | Yes      | —       | Date and time of assignment rule recent modification Format: `date-time`. Maximum length: 255.                       |
| `result.data.assignment_rules[].default_assignee`          | `object`         | Yes      | —       | Details of the fallback user for record assignment in cases where the owner cannot be assigned through rule entries. |
| `result.data.assignment_rules[].default_assignee.name`     | `string`         | No       | —       | Display name of the default assignee. Will be deprecated Maximum length: 255.                                        |
| `result.data.assignment_rules[].default_assignee.id`       | `record`         | No       | —       | Id of the default assignee. Will be deprecated                                                                       |
| `result.data.assignment_rules[].default_assignee.type`     | `"user"`         | No       | —       | Defines the type of the default assignee Allowed: `user`.                                                            |
| `result.data.assignment_rules[].default_assignee.resource` | `record`         | No       | —       | —                                                                                                                    |
| `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": "Get all assignment rules success response",
        "properties": {
          "assignment_rules": {
            "type": "array",
            "description": "List of all assignment rules",
            "minItems": 1,
            "maxItems": 200,
            "items": {
              "type": "object",
              "description": "Details of the assignment rule",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "ID of the resource",
                  "minLength": 1,
                  "maxLength": 19,
                  "pattern": "^[1-9][0-9]{0,18}$"
                },
                "name": {
                  "type": "string",
                  "description": "Name to be displayed for the assignment rule (Required) (Unique)",
                  "minLength": 1,
                  "maxLength": 100
                },
                "api_name": {
                  "type": "string",
                  "description": "API name of the rule (Unique)",
                  "minLength": 1,
                  "maxLength": 100
                },
                "module": {
                  "type": "object",
                  "description": "Resource details",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Display name of the resource",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "ID of the resource",
                      "minLength": 1,
                      "maxLength": 19,
                      "pattern": "^[1-9][0-9]{0,18}$"
                    },
                    "_details": {
                      "type": [
                        "null",
                        "object"
                      ],
                      "description": "_Details Schema",
                      "additionalProperties": true
                    },
                    "api_name": {
                      "type": "string",
                      "description": "API name of the resource",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "additionalProperties": true
                },
                "description": {
                  "type": "string",
                  "description": "Explains of the purpose of the assignment rule",
                  "maxLength": 250
                },
                "created_by": {
                  "type": "object",
                  "description": "Resource details",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Display name of the resource",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "ID of the resource",
                      "minLength": 1,
                      "maxLength": 19,
                      "pattern": "^[1-9][0-9]{0,18}$"
                    },
                    "_details": {
                      "type": [
                        "null",
                        "object"
                      ],
                      "description": "_Details Schema",
                      "additionalProperties": true
                    },
                    "api_name": {
                      "type": "string",
                      "description": "API name of the resource",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "additionalProperties": true
                },
                "created_time": {
                  "type": "string",
                  "description": "Date and time of assignment rule creation",
                  "maxLength": 255,
                  "format": "date-time"
                },
                "modified_by": {
                  "type": "object",
                  "description": "Resource details",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Display name of the resource",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "ID of the resource",
                      "minLength": 1,
                      "maxLength": 19,
                      "pattern": "^[1-9][0-9]{0,18}$"
                    },
                    "_details": {
                      "type": [
                        "null",
                        "object"
                      ],
                      "description": "_Details Schema",
                      "additionalProperties": true
                    },
                    "api_name": {
                      "type": "string",
                      "description": "API name of the resource",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "additionalProperties": true
                },
                "modified_time": {
                  "type": "string",
                  "description": "Date and time of assignment rule recent modification",
                  "maxLength": 255,
                  "format": "date-time"
                },
                "default_assignee": {
                  "type": "object",
                  "description": "Details of the fallback user for record assignment in cases where the owner cannot be assigned through rule entries.",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Display name of the default assignee. Will be deprecated",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "object",
                      "description": "Id of the default assignee. Will be deprecated",
                      "additionalProperties": true
                    },
                    "type": {
                      "type": "string",
                      "description": "Defines the type of the default assignee",
                      "enum": [
                        "user"
                      ]
                    },
                    "resource": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  },
                  "additionalProperties": false
                }
              },
              "required": [
                "id",
                "name",
                "api_name",
                "description",
                "created_by",
                "created_time",
                "modified_by",
                "modified_time",
                "default_assignee"
              ],
              "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

* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)
