Manage the Related List Meta operations in Zoho CRM including retrieving, updating, and customizing related lists for different modules and layouts.
{
"openapi": "3.1.0",
"info": {
"title": "Related Lists",
"description": "Manage the Related List Meta operations in Zoho CRM including retrieving, updating, and customizing related lists for different modules and layouts.",
"version": "8"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"enum": [
"com",
"eu",
"in",
"cn",
"au"
],
"default": "com",
"description": "API Server URL TLD"
},
"version": {
"default": "v8",
"description": "API Version"
}
}
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.ALL"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.settings.related_lists.ALL"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.settings.related_lists.READ"
]
}
],
"paths": {
"/settings/related_lists": {
"get": {
"summary": "Retrieve related lists configuration",
"description": "Get the configuration of related lists for a specific module and layout",
"operationId": "getRelatedLists",
"parameters": [
{
"$ref": "#/components/parameters/Module"
},
{
"$ref": "#/components/parameters/LayoutId"
},
{
"$ref": "#/components/parameters/Status"
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.related_lists.READ"
]
}
],
"responses": {
"200": {
"description": "Configuration payload describing each related list's display metadata, available record actions, and layout-specific settings for the requested module.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Response containing related lists configuration for the specified module",
"additionalProperties": false,
"properties": {
"related_lists": {
"type": "array",
"description": "Array of related list configurations",
"items": {
"$ref": "#/components/schemas/RelatedList"
},
"minItems": 0,
"maxItems": 2147483647
}
},
"required": [
"related_lists"
]
}
}
}
},
"204": {
"description": "No related lists matched the requested module, layout, or visibility filter."
},
"400": {
"description": "Bad Request — The server could not process the request due to invalid syntax or missing/invalid parameters.",
"content": {
"application/json": {
"schema": {
"description": "Validation error schema for the 400 response of getRelatedLists.",
"oneOf": [
{
"type": "object",
"description": "Array-based error response",
"additionalProperties": false,
"properties": {
"related_lists": {
"type": "array",
"description": "Array of related lists operation errors",
"items": {
"type": "array",
"description": "Individual error items",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"maxItems": 100
},
"maxItems": 50
}
},
"required": [
"related_lists"
]
},
{
"$ref": "#/components/schemas/ValidationError"
},
{
"$ref": "#/components/schemas/InvalidModuleError"
}
]
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"RelatedListModule": {
"type": "object",
"description": "Metadata describing the module associated with the related list.",
"properties": {
"api_name": {
"type": "string",
"description": "API name of the module.",
"pattern": "^[A-Za-z0-9_]+$",
"minLength": 1,
"maxLength": 100
},
"id": {
"type": "string",
"description": "Unique identifier of the module.",
"pattern": "^[0-9]+$",
"minLength": 1,
"maxLength": 20
},
"plural_label": {
"type": "string",
"description": "Plural label of the module.",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": true
},
"RelatedListParentReference": {
"type": "object",
"description": "Parent related list reference required for contextual dependencies.",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"description": "API name of the parent related list.",
"pattern": "^[A-Za-z0-9_]+$",
"minLength": 1,
"maxLength": 100
},
"id": {
"type": "string",
"description": "Unique identifier of the parent related list.",
"pattern": "^[0-9]+$",
"minLength": 1,
"maxLength": 20
}
},
"required": [
"api_name",
"id"
]
},
"RelatedListRecordOperations": {
"type": "object",
"description": "Flags indicating the record operations allowed on the related list.",
"additionalProperties": false,
"properties": {
"edit": {
"type": "boolean",
"description": "Whether edit operation is allowed on related list records."
},
"create": {
"type": "boolean",
"description": "Whether create operation is allowed on related list records."
},
"bulk_edit": {
"type": "boolean",
"description": "Whether bulk edit operation is allowed on related list records."
},
"delete": {
"type": "boolean",
"description": "Whether delete operation is allowed on related list records."
},
"disassociate": {
"type": "boolean",
"description": "Whether disassociate operation is allowed on related list records."
},
"assign": {
"type": "boolean",
"description": "Whether assign operation is allowed on related list records."
}
},
"required": [
"edit",
"create",
"bulk_edit",
"delete",
"disassociate",
"assign"
]
},
"RelatedList": {
"type": "object",
"description": "Configuration metadata for a related list.",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the related list configuration.",
"pattern": "^[0-9]+$",
"minLength": 1,
"maxLength": 20
},
"sequence_number": {
"type": "string",
"description": "Display order position of the related list in the layout.",
"pattern": "^[0-9]+$",
"minLength": 1,
"maxLength": 10
},
"display_label": {
"type": "string",
"description": "User-friendly label displayed for the related list.",
"minLength": 1,
"maxLength": 100
},
"api_name": {
"type": "string",
"description": "API name identifier for the related list module.",
"pattern": "^[A-Za-z0-9_]+$",
"minLength": 1,
"maxLength": 100
},
"module": {
"description": "Module information for the related list (null if not applicable).",
"oneOf": [
{
"$ref": "#/components/schemas/RelatedListModule"
},
{
"type": "null",
"description": "Null when module information is not applicable"
}
]
},
"name": {
"type": "string",
"description": "Internal name of the related list.",
"pattern": "^[A-Za-z0-9_ -]+$",
"minLength": 1,
"maxLength": 100
},
"action": {
"type": [
"string",
"null"
],
"description": "Action key of the related list (null if no specific action).",
"pattern": "^[A-Za-z0-9_]+$",
"minLength": 1,
"maxLength": 64
},
"href": {
"type": [
"string",
"null"
],
"description": "Reference URL for the related list (null if not applicable).",
"minLength": 1,
"maxLength": 2048
},
"type": {
"type": "string",
"description": "Type classification of the related list.",
"pattern": "^[A-Za-z0-9_]+$",
"minLength": 1,
"maxLength": 64
},
"connectedlookupApiName": {
"type": "string",
"description": "API name of the connected lookup field if applicable.",
"pattern": "^[A-Za-z0-9_]+$",
"minLength": 1,
"maxLength": 100
},
"field_enabled": {
"type": "boolean",
"description": "Whether field customization is enabled for this related list."
},
"customize_sort": {
"type": "boolean",
"description": "Whether custom sorting can be applied to this related list."
},
"customize_fields": {
"type": "boolean",
"description": "Whether field selection can be customized for this related list."
},
"customize_display_label": {
"type": "boolean",
"description": "Whether the display label can be customized for this related list."
},
"status": {
"type": "string",
"description": "The visibility status of the related list.",
"enum": [
"visible",
"user_hidden",
"scheduled_for_deletion"
]
},
"visibility": {
"type": "integer",
"format": "int32",
"description": "Visibility level setting for the related list.",
"minimum": 0
},
"personality_name": {
"type": "string",
"description": "Name of the personality associated with the related list.",
"minLength": 1,
"maxLength": 100
},
"record_operations": {
"$ref": "#/components/schemas/RelatedListRecordOperations"
},
"connectedmodule": {
"type": [
"string",
"null"
],
"description": "The connected module name (null if no module connection).",
"pattern": "^[A-Za-z0-9_]+$",
"minLength": 1,
"maxLength": 250
},
"linkingmodule": {
"type": [
"string",
"null"
],
"description": "The linking module name (null if no linking module).",
"pattern": "^[A-Za-z0-9_]+$",
"minLength": 1,
"maxLength": 250
},
"parent_related_lists": {
"type": [
"array",
"null"
],
"description": "Array of parent related lists that this list depends on.",
"items": {
"$ref": "#/components/schemas/RelatedListParentReference"
},
"minItems": 0,
"maxItems": 2147483647
}
},
"required": [
"id",
"sequence_number",
"display_label",
"api_name",
"name",
"action",
"href",
"type",
"customize_sort",
"customize_fields",
"customize_display_label",
"status"
]
},
"ErrorDetail": {
"type": "object",
"description": "Detailed information about a validation error",
"additionalProperties": true,
"properties": {
"param": {
"type": "string",
"description": "Name of the parameter that caused the error",
"maxLength": 255
},
"param_name": {
"type": "string",
"description": "Name of the parameter that failed validation",
"maxLength": 255
},
"index": {
"type": "integer",
"format": "int32",
"description": "Array index where the validation failure occurred"
},
"supported_values": {
"type": "array",
"description": "List of supported values for the parameter",
"items": {
"type": "string",
"description": "Supported value object",
"maxLength": 255
},
"maxItems": 100
},
"api_name": {
"type": "string",
"description": "API name of the field that caused the validation error",
"maxLength": 100
},
"json_path": {
"type": "string",
"description": "JSON path to the specific field that failed validation",
"maxLength": 500
},
"expected_data_type": {
"type": "string",
"description": "Expected data type for the field that failed validation",
"maxLength": 100
},
"maximum_length": {
"type": "integer",
"format": "int32",
"description": "Maximum allowed length for the field that failed validation"
},
"resource_path_index": {
"type": "integer",
"format": "int32",
"description": "Index of the resource path that contains invalid data"
}
}
},
"ValidationError": {
"type": "object",
"description": "Validation error response structure",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Response status indicating an error occurred"
},
"code": {
"type": "string",
"enum": [
"DUPLICATE_DATA",
"INVALID_DATA",
"RESERVED_KEYWORD_NOT_ALLOWED",
"NOT_ALLOWED",
"MANDATORY_NOT_FOUND"
],
"description": "Specific error code indicating the type of validation or business rule failure"
},
"message": {
"type": "string",
"description": "Human-readable error message describing what went wrong",
"maxLength": 1000
},
"details": {
"$ref": "#/components/schemas/ErrorDetail"
}
},
"required": [
"status",
"code",
"message",
"details"
]
},
"InvalidModuleError": {
"type": "object",
"description": "Invalid Validation error response structure",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Response status indicating an error occurred"
},
"code": {
"type": "string",
"enum": [
"INVALID_MODULE"
],
"description": "Specific error code indicating the type of validation or business rule failure"
},
"message": {
"type": "string",
"description": "Human-readable error message describing what went wrong",
"maxLength": 1000
},
"details": {}
},
"required": [
"status",
"code",
"message",
"details"
]
}
},
"parameters": {
"Module": {
"name": "module",
"in": "query",
"description": "API name of the CRM module (e.g., Leads, Contacts, Accounts)",
"required": true,
"schema": {
"type": "string",
"enum": [
"Leads",
"Contacts",
"Accounts",
"Deals",
"Tasks",
"Events",
"Calls",
"Products",
"Quotes",
"Sales_Orders",
"Purchase_Orders",
"Invoices",
"Campaigns",
"Vendors",
"Price_Books",
"Cases",
"Solutions"
]
}
},
"Status": {
"name": "status",
"in": "query",
"description": "Filter related lists by visibility status",
"required": false,
"schema": {
"type": "string",
"enum": [
"visible",
"scheduled_for_deletion",
"user_hidden"
]
}
},
"LayoutId": {
"name": "layout_id",
"in": "query",
"description": "Unique identifier of the layout for which to retrieve related lists",
"required": false,
"schema": {
"type": "string",
"pattern": "^[0-9]+$",
"minLength": 1,
"maxLength": 20
}
}
},
"securitySchemes": {
"iam-oauth2-schema": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
"tokenUrl": "https://accounts.zoho.com/oauth/v2/token",
"refreshUrl": "https://accounts.zoho.com/oauth/v2/token",
"scopes": {
"ZohoCRM.settings.ALL": "Full access to all CRM settings including related lists",
"ZohoCRM.settings.related_lists.ALL": "Full access to related lists configuration (read and write)",
"ZohoCRM.settings.related_lists.READ": "Read-only access to related lists configuration",
"ZohoCRM.settings.related_lists.UPDATE": "Update access to related lists configuration"
}
}
}
}
}
}
}