Zoho CRM: Assignment Rules Get Assignment Rules

List the record assignment rules in your Zoho CRM account, optionally for one module.

Tool ID: zoho_crm_assignment_rules_get_assignment_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.

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

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 lacks the details for a reliable example. Use deepline describe 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`.

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]{0,18}$`.
`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]{0,18}$`.
`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]{0,18}$`.
`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]{0,18}$`.
`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).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation