Zoho Recruit
related.count
Retrieves the count of related records for a specific parent record. Supports filtering by various criteria including approval status, conversion status, and custom field filters. This operation is useful for analytics and UI display purposes where you need to show counts without fetching the actual related records.
Remote zoho/recruit
Remote (network-hosted)
Other tools also called related.count?
See providers with this name
Input Schema
{
"type": "object",
"properties": {
"recordId": {
"type": "string",
"maxLength": 64,
"description": "The unique identifier of the record"
},
"moduleApiName": {
"type": "string",
"maxLength": 64,
"description": "The API name of the module"
},
"get_related_records_count": {
"type": "array",
"items": {
"type": "object",
"required": [
"related_list"
],
"properties": {
"params": {
"type": "object",
"required": [
"filters"
],
"properties": {
"filters": {
"type": "object",
"required": [
"comparator",
"field",
"value"
],
"properties": {
"field": {
"type": "object",
"required": [
"api_name"
],
"properties": {
"api_name": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+$",
"maxLength": 100,
"minLength": 1,
"description": "The API name of the field to filter on."
}
},
"description": "Specifies the field to filter on when counting related records.",
"additionalProperties": false
},
"value": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "The value to compare the field against."
},
"comparator": {
"enum": [
"equal"
],
"type": "string",
"description": "The comparison operator to use for filtering."
}
},
"description": "Field-based filter criteria to apply before counting records.",
"additionalProperties": false
},
"approved": {
"type": "boolean",
"description": "Filter to include only approved records when counting."
},
"category": {
"enum": [
"link",
"files"
],
"type": "string",
"description": "Filter by record category type."
},
"converted": {
"type": "boolean",
"description": "Filter to include only converted records when counting (applicable to Leads)."
},
"approval_state": {
"enum": [
"approved"
],
"type": "string",
"description": "Filter by approval workflow state."
}
},
"description": "Optional filtering and selection parameters to apply before counting records.",
"additionalProperties": false
},
"related_list": {
"type": "object",
"required": [
"api_name",
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9]+$",
"maxLength": 20,
"minLength": 1,
"description": "The unique identifier of the related list definition."
},
"api_name": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+$",
"maxLength": 100,
"minLength": 1,
"description": "The API name of the related list (e.g., 'Contacts', 'Deals', 'Tasks')."
}
},
"description": "Identifies a specific related list by its API name and unique identifier.",
"additionalProperties": false
}
},
"description": "Specifies a related list to count and optional filtering criteria.",
"additionalProperties": false
},
"maxItems": 20,
"minItems": 1,
"description": "Array of related list count requests. Each item specifies a related list and optional filtering criteria."
}
}
}