Get Related Records Count of a Record

Purpose

To get the count of related records of a record in a module.

Endpoints

POST /{module_API_name}/{record_ID}/actions/get_related_records_count

Request Details

Request URL

{api-domain}/crm/{version}/{module_API_name}/{record_ID}/actions/get_related_records_count

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.modules.ALL
(or)
ZohoCRM.{module_name}.{operation_type}

Possible module names

leads, accounts, contacts, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, custom, appointments, appointments_rescheduled_history, and services

Possible operation types

ALL - Full access to records
READ - Get records data

Note

You can get the count of the system-defined related lists like Survey, Desk, Projects, Visits, Expense, Invoice, and Subscription, custom related lists created via lookup, multi-select lookup, multi-module lookup fields, and related lists created when you enable history tracking in a picklist.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/3652397000016143002/actions/get_related_records_count"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POST

Input JSON

related_listJSON object, mandatory
Contains the following keys:
- idstring, mandatory if you do not include "api_name"
  The ID of the related list whose record count you want to fetch. For example, if you want to fetch the number of notes for a specific record in the Leads module, you must give the ID of the Notes related list for this key. Use the Get Related Records API to get the ID of the related list in the key id.
- api_namestring, mandatory if you do not include "id"
  The API name of the related list whose record count you want to fetch. For example, if you want to fetch the number of attachments for a specific record in the Leads module, you must give the ID of the Attachments related list for this key. Use the Get Related Records API to get the API name of the related list in the key api_name.

Note

You can specify up to 20 JSON objects in the input. That is, you can get the count of up to 20 related list records.

Sample Input

Copied{
    "get_related_records_count": [
        {
            "related_list": {
                "id": "3652397000000015122",
                "api_name": "Notes"
            }
        }
]
}

Response JSON Keys

countinteger
The number of related records associated with the record specified in the request.
related_listJSON object
Contains the following keys:
- idstring
  The ID of the related list whose record count you fetched.
- api_namestring
  The API name of the related list whose record count you fetched.

Possible Errors

INVALID_DATAHTTP 400
Either the record ID is invalid in the request URL or you do not have permission to view the record.
Resolution: Specify a valid record ID. Use the Get Records API for the record ID. For permission issue, contact your system administrator.
INVALID_DATAHTTP 400
Either the ID or API name of the related list is invalid in the request body.
Resolution: Specify a valid ID and API name of the related list in the "related_list" JSON object. Use the Get Related Records API to get the ID and API name of the related list.
MANDATORY_NOT_FOUNDHTTP 400
You have not include the "related_list" JSON object in the request body.
Resolution: Refer to the Input JSON section for the mandatory and optional keys in the input.
INVALID_MODULEHTTP 400
The module API name in the request URL is invalid.
Resolution: Specify a valid module API name. Use the Get Module Metadata API for the module API name.
EXPECTED_FIELD_MISSINGHTTP 400
You have specified neither "id" nor "api_name" of the related list in the request body.
Resolution: You must include either "id" or "api_name" of the related list in the input. Refer to the Sample Input section for details.
AMBIGUITY_DURING_PROCESSINGHTTP 400
The ID and API name of the related list do not match.
Resolution: Ensure to specify the right API name and ID of the related list. Use the Get Related Records API to get the ID and API name of the related list.
AUTHORIZATION_FAILEDHTTP 400
You do not have sufficient permission to read the module records.
Resolution: Contact your system administrator.
INVALID_REQUEST_METHODHTTP 400
The request method is incorrect.
Resolution: Use the HTTP POST method to make this API call. Any other request method will result in this error.
AUTHENTICATION_FAILUREHTTP 401
You have not authenticated the API call with valid access token.
Resolution: Include a valid access token in the request header to authenticate the API call.
INVALID_TOKENHTTP 401
Your access token has expired.
Resolution: Generate a new access token with the required scope and make this API call.
OAUTH_SCOPE_MISMATCHHTTP 401
The access token you have used to make this API call does not have the required scope.
Resolution: Generate a new access token with the scopes mentioned in the ZohoCRM.modules.{module_name}.{operation_type}. Refer to the Scope section for details.
NO_PERMISSIONHTTP 403
You do not have permission to read records from the module.
Resolution: Contact your system administrator.
NOT_ALLOWEDHTTP 403
You do not have permission to read related records from the module.
Resolution: Contact your system administrator.
INVALID_URL_PATTERNHTTP 404
The request URL is incorrect.
Resolution: Specify a valid request URL. Refer to the Request URL section for the right URL.
INTERNAL_ERRORHTTP 500
Unexpected and unhandled exception in the server.
Resolution: Contact the support team at support@zohocrm.com.

Sample Response

Copied{
    "get_related_records_count": [
        {
            "count": 11,
            "related_list": {
                "api_name": "Notes",
                "id": "3652397000000015122"
            }
        }
    ]
}