> ## 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: Scoring Rules Get Scoring Rules

> List the scoring rules in your Zoho CRM account, filtered by module, layout or name. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List the scoring rules in your Zoho CRM account, filtered by module, layout or name.

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

## 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_scoring_rules_get_scoring_rules',
  {
    "module": "example",
    "layout_id": 123,
    "page": 123
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_scoring_rules_get_scoring_rules --input '{
  "module": "example",
  "layout_id": 123,
  "page": 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": {
    "scoring_rules": [
      {
        "module": {
          "api_name": "Example",
          "id": "id_123"
        },
        "name": "Example"
      }
    ],
    "info": {
      "per_page": 123,
      "count": 123,
      "page": 123
    }
  }
}
```

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

## Input reference

Returns the list of scoring rules configured. If params are passed, rules matched the param value will be returned.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.module` | `string` | No | — | api\_name of the module Maximum length: 100. |
| `payload.layout_id` | `number` | No | — | layout id |
| `payload.page` | `integer` | No | — | current batch of rules Format: `int32`. |
| `payload.per_page` | `integer` | No | — | no of rules per request Format: `int32`. |
| `payload.name` | `string` | No | — | Scoring rule name Maximum length: 25. |
| `payload.include_inner_details` | `"manual_scoring_rule.has_signal_rules" \| "zia_scoring_rule.type"` | No | — | Child rule details can be fetched using this param Allowed: `manual_scoring_rule.has_signal_rules`, `zia_scoring_rule.type`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns the list of scoring rules configured. If params are passed, rules matched the param value will be returned.",
    "properties": {
      "module": {
        "type": "string",
        "description": "api_name of the module",
        "maxLength": 100
      },
      "layout_id": {
        "type": "number",
        "description": "layout id"
      },
      "page": {
        "type": "integer",
        "description": "current batch of rules",
        "format": "int32"
      },
      "per_page": {
        "type": "integer",
        "description": "no of rules per request",
        "format": "int32"
      },
      "name": {
        "type": "string",
        "description": "Scoring rule name",
        "maxLength": 25
      },
      "include_inner_details": {
        "type": "string",
        "description": "Child rule details can be fetched using this param",
        "enum": [
          "manual_scoring_rule.has_signal_rules",
          "zia_scoring_rule.type"
        ]
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | list of configured scoring rules |
| `result.data.scoring_rules` | `array` | No | — | Field: scoring\_rules Maximum items: 300. |
| `result.data.scoring_rules[].created_time` | `string` | No | — | Field: created\_time Maximum length: 255. |
| `result.data.scoring_rules[].custom_fields` | `array \| null` | No | — | Custom fields can be configured for scoring rule. These fields will hold the referred scores. Maximum items: 6. |
| `result.data.scoring_rules[].custom_fields[].id` | `string` | No | — | Custom field id Maximum length: 25. |
| `result.data.scoring_rules[].custom_fields[].field_label` | `string` | No | — | Name of the custom field (Required for POST) Maximum length: 100. |
| `result.data.scoring_rules[].custom_fields[].api_name` | `string` | No | — | Api name of the custom field Maximum length: 100. |
| `result.data.scoring_rules[].custom_fields[].reference_field` | `object` | No | — | Contains the API name of the referenced score field used in scoring rules. |
| `result.data.scoring_rules[].custom_fields[].reference_field.api_name` | `"Positive_Score" \| "Negative_Score" \| "Touch_Point_Positive_Score" \| "Touch_Point_Negative_Score" \| "Touch_Point_Score" \| "Score"` | No | — | api name of the referenced score field (Required for POST) Allowed: `Positive_Score`, `Negative_Score`, `Touch_Point_Positive_Score`, `Touch_Point_Negative_Score`, `Touch_Point_Score`, `Score`. |
| `result.data.scoring_rules[].custom_fields[].reference_field.id` | `string` | No | — | Reference field id Maximum length: 25. |
| `result.data.scoring_rules[].module` | `object` | Yes | — | Provides details of a module, including API name and module ID. |
| `result.data.scoring_rules[].module.api_name` | `string` | No | — | Api name of the module Maximum length: 255. |
| `result.data.scoring_rules[].module.id` | `string` | No | — | Module id Maximum length: 25. |
| `result.data.scoring_rules[].description` | `string \| null` | No | — | Rule configuration info can be added here. Maximum length: 500. |
| `result.data.scoring_rules[].active` | `boolean` | No | — | It defined the status (active or inactive) of the rule. |
| `result.data.scoring_rules[].created_by` | `object` | No | — | Nested schema for created\_by |
| `result.data.scoring_rules[].created_by.name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.scoring_rules[].created_by.id` | `string` | No | — | Field: id Maximum length: 25. |
| `result.data.scoring_rules[].created_by.zuid` | `string` | No | — | Field: zuid Maximum length: 255. |
| `result.data.scoring_rules[].layout` | `object \| null` | No | — | Information about layout configuration, including display label, API name, and ID. |
| `result.data.scoring_rules[].layout.display_label` | `string` | No | — | layout display name Maximum length: 255. |
| `result.data.scoring_rules[].layout.api_name` | `string` | No | — | Layout api name Maximum length: 255. |
| `result.data.scoring_rules[].layout.id` | `string` | No | — | Layout id Maximum length: 25. |
| `result.data.scoring_rules[].modified_time` | `string \| null` | No | — | Field: modified\_time Maximum length: 255. |
| `result.data.scoring_rules[].name` | `string` | Yes | — | Scoring rule name (Required) (Unique) Maximum length: 25. |
| `result.data.scoring_rules[].modified_by` | `object \| null` | No | — | Nested schema for modified\_by |
| `result.data.scoring_rules[].modified_by.name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.scoring_rules[].modified_by.id` | `string` | No | — | Field: id Maximum length: 25. |
| `result.data.scoring_rules[].modified_by.zuid` | `string` | No | — | Field: zuid Maximum length: 255. |
| `result.data.scoring_rules[].id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.scoring_rules[].scoring_type` | `"manual_scoring" \| "zia_scoring"` | No | — | Type of the scoring rule Allowed: `manual_scoring`, `zia_scoring`. |
| `result.data.scoring_rules[].manual_scoring_rule` | `object \| null` | No | — | Few rule object has errors, others are updated successfully. |
| `result.data.scoring_rules[].manual_scoring_rule.has_signal_rules` | `boolean` | No | — | If TP rules are available in a rule, it will be true in sandbox case |
| `result.data.scoring_rules[].zia_scoring_rule` | `object \| null` | No | — | Few rule object has errors, others are updated successfully. |
| `result.data.scoring_rules[].zia_scoring_rule.type` | `"engagement_score" \| "field_attribute_score" \| "conversion_score" \| "health_score" \| "follow-up_score"` | No | — | type of zia scoring Allowed: `engagement_score`, `field_attribute_score`, `conversion_score`, `health_score`, `follow-up_score`. |
| `result.data.info` | `object` | No | — | Nested schema for info |
| `result.data.info.per_page` | `integer` | No | — | no of rules need to be fetched per\_page Format: `int32`. |
| `result.data.info.count` | `integer` | No | — | Field: count - no of rules present in the response Format: `int32`. |
| `result.data.info.page` | `integer` | No | — | Field: page Format: `int32`. |
| `result.data.info.more_records` | `boolean` | No | — | Field: more\_records |
| `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": "list of configured scoring rules",
        "properties": {
          "scoring_rules": {
            "type": "array",
            "description": "Field: scoring_rules",
            "maxItems": 300,
            "items": {
              "type": "object",
              "description": "Root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations.",
              "properties": {
                "created_time": {
                  "type": "string",
                  "description": "Field: created_time",
                  "maxLength": 255
                },
                "custom_fields": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "description": "Custom fields can be configured for scoring rule. These fields will hold the referred scores.",
                  "maxItems": 6,
                  "items": {
                    "type": "object",
                    "description": "Configuration for custom fields associated with scoring rules, including referred scores.",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Custom field id",
                        "maxLength": 25
                      },
                      "field_label": {
                        "type": "string",
                        "description": "Name of the custom field (Required for POST)",
                        "maxLength": 100
                      },
                      "api_name": {
                        "type": "string",
                        "description": "Api name of the custom field",
                        "maxLength": 100
                      },
                      "reference_field": {
                        "type": "object",
                        "description": "Contains the API name of the referenced score field used in scoring rules.",
                        "properties": {
                          "api_name": {
                            "type": "string",
                            "description": "api name of the referenced score field (Required for POST)",
                            "enum": [
                              "Positive_Score",
                              "Negative_Score",
                              "Touch_Point_Positive_Score",
                              "Touch_Point_Negative_Score",
                              "Touch_Point_Score",
                              "Score"
                            ]
                          },
                          "id": {
                            "type": "string",
                            "description": "Reference field id",
                            "maxLength": 25
                          }
                        },
                        "additionalProperties": true
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "module": {
                  "type": "object",
                  "description": "Provides details of a module, including API name and module ID.",
                  "properties": {
                    "api_name": {
                      "type": "string",
                      "description": "Api name of the module",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Module id",
                      "maxLength": 25
                    }
                  },
                  "additionalProperties": false
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Rule configuration info can be added here.",
                  "maxLength": 500
                },
                "active": {
                  "type": "boolean",
                  "description": "It defined the status (active or inactive) of the rule."
                },
                "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": 25
                    },
                    "zuid": {
                      "type": "string",
                      "description": "Field: zuid",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                },
                "layout": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Information about layout configuration, including display label, API name, and ID.",
                  "properties": {
                    "display_label": {
                      "type": "string",
                      "description": "layout display name",
                      "maxLength": 255
                    },
                    "api_name": {
                      "type": "string",
                      "description": "Layout api name",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Layout id",
                      "maxLength": 25
                    }
                  },
                  "additionalProperties": false
                },
                "modified_time": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Field: modified_time",
                  "maxLength": 255
                },
                "name": {
                  "type": "string",
                  "description": "Scoring rule name (Required) (Unique)",
                  "maxLength": 25
                },
                "modified_by": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Nested schema for modified_by",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 25
                    },
                    "zuid": {
                      "type": "string",
                      "description": "Field: zuid",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                },
                "id": {
                  "type": "string",
                  "description": "Field: id",
                  "maxLength": 255
                },
                "scoring_type": {
                  "type": "string",
                  "description": "Type of the scoring rule",
                  "enum": [
                    "manual_scoring",
                    "zia_scoring"
                  ]
                },
                "manual_scoring_rule": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Few rule object has errors, others are updated successfully.",
                  "properties": {
                    "has_signal_rules": {
                      "type": "boolean",
                      "description": "If TP rules are available in a rule, it will be true in sandbox case"
                    }
                  },
                  "additionalProperties": false
                },
                "zia_scoring_rule": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Few rule object has errors, others are updated successfully.",
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "type of zia scoring",
                      "enum": [
                        "engagement_score",
                        "field_attribute_score",
                        "conversion_score",
                        "health_score",
                        "follow-up_score"
                      ]
                    }
                  },
                  "additionalProperties": false
                }
              },
              "required": [
                "module",
                "name"
              ],
              "additionalProperties": false
            }
          },
          "info": {
            "type": "object",
            "description": "Nested schema for info",
            "properties": {
              "per_page": {
                "type": "integer",
                "description": "no of rules need to be fetched per_page",
                "format": "int32"
              },
              "count": {
                "type": "integer",
                "description": "Field: count - no of rules present in the response",
                "format": "int32"
              },
              "page": {
                "type": "integer",
                "description": "Field: page",
                "format": "int32"
              },
              "more_records": {
                "type": "boolean",
                "description": "Field: more_records"
              }
            },
            "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](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.