Zoho: Get related records count schemas
19 Zoho schemas with complete fields and constraints.
← Get related records count operations · All schemas
Get related records count — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request payload for counting related records. Contains an array of related list count specifications, each identifying a related list and optional filtering criteria. Additional keys: not allowed |
get_related_records_count | array | Required within parent | Represents the array of related list count request objects. Each object specifies a related list to query and optional filtering criteria to apply before counting. Maximum items: 20 Minimum items: 1 |
get_related_records_count[] | Model | Each item | Expand Get related records count — request body — body get related records count item |
Referenced models: Get related records count — request body — body get related records count item
Get related records count — request body — body get related records count item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single related list count specification, including the target related list and optional filtering criteria to apply before counting. Additional keys: not allowed |
params | Model | Optional | Expand Get related records count — request body — body get related records count item params |
related_list | Model | Required within parent | Expand Get related records count — request body — body get related records count item related list |
Referenced models: Get related records count — request body — body get related records count item params, Get related records count — request body — body get related records count item related list
Get related records count — request body — body get related records count item params
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents optional filtering and selection parameters applied to related records before counting. Includes support for approval status, conversion status, category type, and field-level equality filters. Additional keys: not allowed |
approval_state | string | Optional | Represents the approval workflow state used to filter related records before counting. Possible values: **approved** - Count only records in the approved workflow state. One of: approved |
approved | boolean | Optional | Indicates whether to restrict the count to approved records only. Possible values: **true** - Count only approved records. **false** - Count only records that are not approved. |
category | string | Optional | Represents the category type used to filter related records before counting. Possible values: **link** - Count only link-type related records. **files** - Count only file-attachment related records. One of: link, files |
converted | boolean | Optional | Indicates whether to restrict the count to converted records only. Applicable to the Leads module. Possible values: **true** - Count only converted records. **false** - Count only records that have not been converted. |
filters | Model | Required within parent | Expand Get related records count — request body — body get related records count item params filters |
Referenced models: Get related records count — request body — body get related records count item params filters
Get related records count — request body — body get related records count item params filters
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the field-based filter criteria applied to related records before counting. Contains the field to evaluate, the comparison operator, and the value to compare against. Additional keys: not allowed |
comparator | string | Required within parent | Represents the comparison operator used to filter related records before counting. Possible values: **equal** - Matches records where the specified field value equals the given value. One of: equal |
field | Model | Required within parent | Expand Get related records count — request body — body get related records count item params filters field |
value | string | Required within parent | Represents the value to compare the specified field against when filtering related records before counting. Maximum length: 255 Minimum length: 1 |
Referenced models: Get related records count — request body — body get related records count item params filters field
Get related records count — request body — body get related records count item params filters field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the field to use when filtering related records before counting. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the field to filter on when counting related records. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
Get related records count — request body — body get related records count item related list
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a related list identified by its API name and unique ID. Used in both the request to specify the target related list and in the response to echo the queried related list. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the related list. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
id | string | Required within parent | Represents the unique ID of the related list. Use the [Get Related Records API](related_records.yaml#$.paths./{parentRecordModule}/{parentRecord}/{relatedList}.get) to get the ID of the related list in the key ID. Format: int64 Maximum length: 20 Minimum length: 1 Pattern: ^[0-9]+$ |
Get related records count — response body — get related records count
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned when the count operation succeeds. Contains an array of count results, one entry for each related list requested. Additional keys: not allowed |
get_related_records_count | array | Required within parent | Represents the array of count results, one entry for each related list requested. Maximum items: 20 |
get_related_records_count[] | Model | Each item | Expand Get related records count — response body — get related records count get related records count item |
Referenced models: Get related records count — response body — get related records count get related records count item
Get related records count — response body — get related records count get related records count item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the count result for a specific related list, including the total number of matching records and the related list identifier. Additional keys: not allowed |
count | JSON | Required within parent | |
count (anyOf 1) | integer | Alternative | Represents the total number of related records matching the specified criteria. Format: int32 Minimum: 0 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
related_list | Model | Required within parent | Expand Get related records count — request body — body get related records count item related list |
Referenced models: Get related records count — request body — body get related records count item related list
Get related records count — response body — value / get_related_records_count / get_related_records_count / item / code: MANDATORY NOT FOUND, message: required field not found, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Per-item MANDATORY_NOT_FOUND error entry inside the get_related_records_count array of a partial-success (HTTP 207) response. Indicates that a required field (such as related_list) was missing from this particular request item. Additional keys: not allowed |
code | string | Required within parent | Error code for missing mandatory field Known values: MANDATORY_NOT_FOUND |
details | Model | Required within parent | Expand Get related records count — response body — value / get_related_records_count / get_related_records_count / item / code: MANDATORY NOT FOUND, message: required field not found, status: error details |
message | string | Required within parent | Human-readable error message describing the missing mandatory field Known values: required field not found |
status | string | Required within parent | The status of this item, always 'error' for failed items Known values: error |
Get related records count — response body — value / get_related_records_count / get_related_records_count / item / code: MANDATORY NOT FOUND, message: required field not found, status: error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Error details with field information, used for field-level validation errors Additional keys: not allowed |
api_name | string | Required within parent | The API name of the field that caused the error Maximum length: 100 |
json_path | string | Required within parent | JSON path indicating the location of the field in the request Maximum length: 500 |
Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Per-item error entry inside the get_related_records_count array of a partial-success (HTTP 207) response. Indicates that this particular related list count request failed while other items in the same array may have succeeded. Additional keys: not allowed |
code | string | Required within parent | Error code identifying the failure reason for this item Known values: INVALID_DATA, EXPECTED_FIELD_MISSING, AMBIGUITY_DURING_PROCESSING, NOT_SUPPORTED |
details | JSON | Required within parent | Additional context about the per-item error (field info, expected fields, ambiguity info, or unsupported-filter info depending on the error code) |
details (anyOf 1) | Model | Alternative | Expand Get related records count — response body — value / get_related_records_count / get_related_records_count / item / code: MANDATORY NOT FOUND, message: required field not found, status: error details |
details (anyOf 2) | Model | Alternative | Expand Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error details expected fields |
details (anyOf 3) | Model | Alternative | Expand Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error details ambiguity due to |
details (anyOf 4) | Model | Alternative | Expand Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error details expected data type: json type |
details (anyOf 5) | Model | Alternative | Expand Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error details object |
message | string | Required within parent | Represents the error message describing the validation failure. Maximum length: 500 |
status | string | Required within parent | Represents the status of the response. Possible values: **error** - The request was unsuccessful. Known values: error |
Referenced models: Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error details ambiguity due to, Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error details object, Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error details expected fields, Get related records count — response body — value / get_related_records_count / get_related_records_count / item / code: MANDATORY NOT FOUND, message: required field not found, status: error details, Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error details expected data type: json type
Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error details ambiguity due to
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Error details containing information about ambiguous fields that caused processing conflict Additional keys: not allowed |
ambiguity_due_to | array | Required within parent | List of conflicting fields that caused the ambiguity (id and api_name) Maximum items: 2 Minimum items: 2 |
ambiguity_due_to[] | object | Each item | Details of a field that contributed to the ambiguity Additional keys: not allowed |
ambiguity_due_to[].api_name | string | Required within parent | The API name of the ambiguous field Maximum length: 100 |
ambiguity_due_to[].json_path | string | Required within parent | JSON path indicating the location of the ambiguous field in the request Maximum length: 500 |
Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error details expected data type: json type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Error details for unsupported filters, containing the expected data type and field information Additional keys: not allowed |
api_name | string | Required within parent | The API name of the field that is not supported Maximum length: 100 |
expected_data_type | string | Required within parent | The expected data type for the field Known values: json_type |
json_path | string | Required within parent | JSON path indicating the location of the unsupported field in the request Maximum length: 500 |
Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error details expected fields
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Error details containing list of expected fields that are missing Additional keys: not allowed |
expected_fields | array | Required within parent | List of field names that were expected but not provided Maximum items: 20 Minimum items: 1 |
expected_fields[] | object | Each item | Details of an expected field Additional keys: not allowed |
expected_fields[].api_name | string | Required within parent | API name of the expected field Maximum length: 100 |
expected_fields[].json_path | string | Required within parent | JSON path indicating where the field was expected in the request Maximum length: 500 |
Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error details object
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Empty error details object for errors that don't require additional context Additional keys: not allowed |
Get related records count — response body — value get related records count get related records count item — Partial Success Mandatory Not Found Response Item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | A single entry inside the get_related_records_count array of a partial-success MANDATORY_NOT_FOUND response. Each entry is independently either a successful count result or a per-item MANDATORY_NOT_FOUND error. |
$ (anyOf 1) | Model | Alternative | Expand Get related records count — response body — get related records count get related records count item |
$ (anyOf 2) | Model | Alternative | Expand Get related records count — response body — value / get_related_records_count / get_related_records_count / item / code: MANDATORY NOT FOUND, message: required field not found, status: error |
Referenced models: Get related records count — response body — value / get_related_records_count / get_related_records_count / item / code: MANDATORY NOT FOUND, message: required field not found, status: error, Get related records count — response body — get related records count get related records count item
Get related records count — response body — value get related records count get related records count item — Partial Success Response Item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | A single entry inside the get_related_records_count array of a partial-success response. Each entry is independently either a successful count result or a per-item error. |
$ (anyOf 1) | Model | Alternative | Expand Get related records count — response body — get related records count get related records count item |
$ (anyOf 2) | Model | Alternative | Expand Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error |
Referenced models: Get related records count — response body — value / get_related_records_count / get_related_records_count / item / status: error, Get related records count — response body — get related records count get related records count item
Get related records count — response body — value get related records count — Get Related Records Count Partial Success Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Multi-Status (HTTP 207) response returned when a request containing multiple related list count items has mixed results - some items succeed with a count while others fail with a per-item error. Each entry in get_related_records_count corresponds positionally to a requested item and independently reports either success (count + related_list) or an error (status, code, message, details). Additional keys: not allowed |
get_related_records_count | array | Required within parent | Array of per-item results, one entry per requested related list. Each entry is either a RelatedRecordCountResult (success) or a PartialSuccessItemError (failure). Maximum items: 20 Minimum items: 1 |
get_related_records_count[] | Model | Each item | Expand Get related records count — response body — value get related records count get related records count item — Partial Success Response Item |
Referenced models: Get related records count — response body — value get related records count get related records count item — Partial Success Response Item
Get related records count — response body — value get related records count — Partial Success Mandatory Not Found Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Multi-Status (HTTP 207) response returned when a request contains multiple related list count items where some succeed and others fail because a required field (such as related_list) is missing. Each entry in get_related_records_count corresponds positionally to a requested item and independently reports either success (count + related_list) or a MANDATORY_NOT_FOUND error (status, code, message, details). Additional keys: not allowed |
get_related_records_count | array | Required within parent | Array of per-item results, one entry per requested related list. Each entry is either a RelatedRecordCountResult (success) or a PartialSuccessMandatoryNotFoundItemError (failure). Maximum items: 20 Minimum items: 1 |
get_related_records_count[] | Model | Each item | Expand Get related records count — response body — value get related records count get related records count item — Partial Success Mandatory Not Found Response Item |
Referenced models: Get related records count — response body — value get related records count get related records count item — Partial Success Mandatory Not Found Response Item