Zoho CRM: Assignment Rules Get Assignment Rule By ID

Get one Zoho CRM assignment rule by its ID, with the criteria and owners it assigns records to.

Tool ID: zoho_crm_assignment_rules_get_assignment_rule_by_id

Run this action

This action has conditional or dynamic inputs. A static example cannot describe these inputs reliably. Read the live contract before you execute this action:

deepline describe zoho_crm_assignment_rules_get_assignment_rule_by_id --json

Example response

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

Input reference

To get details of given assignment rule

Name	Type	Required	Default	Details
`payload.id`	`string`	Yes	—	Unique numeric identifier of assignment rule(long datatype) Minimum length: 1. Maximum length: 19. Pattern: `^[1-9][0-9]{0,18}$`.
`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`.
`payload.module`	`string`	Yes	—	API name of the module Maximum length: 100.

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: 1.
`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.data.assignment_rules[].rule_entries`	`array`	Yes	—	Defines the list of rules entries with record matching logic and assignment logic Maximum items: 200.
`result.data.assignment_rules[].rule_entries[].id`	`string`	Yes	—	ID of the resource Minimum length: 1. Maximum length: 19. Pattern: `^[1-9][0-9]{0,18}$`.
`result.data.assignment_rules[].rule_entries[].sequence_number`	`integer`	Yes	—	Field: sequence_number Format: `int32`.
`result.data.assignment_rules[].rule_entries[].criteria`	`object \| null`	Yes	—	Defines the record criteria based on which records will be filtered and assignment logic defined for current rule entry will be applied. If criteria is not provided or is null, all records entering current rule entry will be assigned based on current rule entry’s assignment logic.
`result.data.assignment_rules[].rule_entries[].assign_to`	`record`	Yes	—	Assign to response object schema
`result.data.assignment_rules[].rule_entries[].user_availability_based_on`	`array \| null`	Yes	—	Defines additional availability checks to be performed before choosing a user as owner. A user will be assigned as owner only if it satisfies the mentioned availability conditions. Maximum items: 2.
`result.data.assignment_rules[].rule_entries[].followup_actions`	`array \| null`	Yes	—	Defines the list of different actions to be executed after owner assignment Minimum items: 1. Maximum items: 1.
`result.data.assignment_rules[].rule_entries[].followup_actions[].type`	`"tasks"`	Yes	—	Type of the action (Required) Allowed: `tasks`.
`result.data.assignment_rules[].rule_entries[].followup_actions[].resources`	`array`	No	—	List of action details of the given type Minimum items: 1. Maximum items: 1.
`result.data.assignment_rules[].rule_entries[].followup_actions[].resources[].name`	`string`	Yes	—	Display name of the resource Maximum length: 255.
`result.data.assignment_rules[].rule_entries[].followup_actions[].resources[].id`	`string`	Yes	—	ID of the resource Minimum length: 1. Maximum length: 19. Pattern: `^[1-9][0-9]{0,18}$`.
`result.data.assignment_rules[].rule_entries[].followup_actions[].resources[]._details`	`null \| object`	No	—	_Details Schema
`result.data.assignment_rules[].rule_entries[].followup_actions[].resources[].api_name`	`string`	No	—	API name of the resource Maximum length: 255.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

This output schema is too large for an inline display. Read the complete live contract with deepline describe zoho_crm_assignment_rules_get_assignment_rule_by_id --json.

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

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

Example response

Input reference

Output reference

Deepline cost

Related documentation