List related records

GET/{parentRecordModule}/{parentRecord}/{relatedList}

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the List related records action (under Related Records).
Fill in the fields below, then reference the result from later steps as {{listRelatedRecords.response.data}}.

Request

Path parameters

parentRecordModulestringrequired

Specify the API name of the module the parent record belongs to. Refer to the [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html) resource for valid values.

parentRecordstringrequired

Specify the unique numeric identifier of the parent record.

relatedListstringrequired

Specify the API name of the related list containing the records to retrieve or modify. Refer to the [Get Related Lists](https://www.zoho.com/crm/developer/docs/api/v8/related-list-meta.html) resource for valid values.

Query parameters

fieldsstringrequired

Specify the API names of the fields to include in the response as a comma-separated list.

pageinteger (int32)

Specify the page number for paginating results.

Default 1

perPageinteger (int32)

Specify the number of records to return per page. The page and per_page parameter is used to fetch records according to their position in the CRM. Let us assume that the user has to fetch 400 records. The maximum number of records that one can get for an API call is 200. So, for records above the 200th position, they cannot be fetched. By using the page (1 and 2) and per_page (200) parameter, the user can fetch all 400 records using 2 API calls. If the requested related list is not present or hidden in a layout, the system will return an INVALID_DATA response.

Default 200

page_tokenstring

Specify the token to retrieve the next set of records beyond the first 2,000 results. Use the **next_page_token** value from the previous response.

idsstring

Specify the unique identifiers of the records to retrieve as a comma-separated list.

sort_orderstring

Specify the sort direction for the related records. Possible values: **asc**, **desc**.

One ofascdescDefault "desc"

sort_bystring

Specify the field to sort the related records by. Possible values: **ID**, **Created_Time**, **Modified_Time**.

One ofidCreated_TimeModified_TimeDefault "id"

convertedstring

Specify whether to filter records by conversion status. Possible values: **true**, **false**, **both**.

One oftruefalsebothDefault "false"

approvedstring

Filter records by approval status. When set to true, returns only approved records; when false, returns only unapproved records.

One oftruefalsebothDefault "true"

approval_statestring

Filter records by their current approval state.

One ofwebform_unapprovedapprovedapproval_process_pendingapproval_process_rejectedwebform_invalidwebform_invalid_approvalwebform_double_optinreview_process_pendingreview_process_rejectedmerge_pendingzia_vision_pendingzia_vision_rejectedzia_vision_validationemail_parser_waitingemail_parser_rejectedapproval_process_recalled

filtersoneOf

Filter for fetching specific related records based on criteria

Headers

If-Modified-Sincestring (date-time)

Specify the date and time in RFC 2822 format. The response includes only records modified after this timestamp.

Response

Returns 200 with an object. Read it in later steps with {{listRelatedRecords.response.data.<field>}}.

dataarray<object>

Array of related record objects with requested fields.

idstring

Unique identifier of the related record.

Created_Timestring (date-time)

Represents the creation date and time of the related record.

Modified_Timestring (date-time)

Timestamp when the record was last modified.

Moved_To__sstring

Stage value to which the record was moved (stage history / picklist movement).

infoobject

Pagination and response metadata.

pageinteger (int32)required

Current page number.

per_pageinteger (int32)required

Number of records per page.

countinteger (int32)required

Number of records in current response.

more_recordsbooleanrequired

Indicates if more pages are available.

next_page_tokenstring | null

Token to retrieve the next page of results.

page_token_expirystring | null

Expiration timestamp for the page token.

previous_page_tokenstring | null

Token to retrieve the previous page of results.

json

{
  "data": [
    {
      "id": "string",
      "Created_Time": "2025-01-01T00:00:00Z",
      "Modified_Time": "2025-01-01T00:00:00Z",
      "Moved_To__s": "string"
    }
  ],
  "info": {
    "page": 0,
    "per_page": 0,
    "count": 0,
    "more_records": false,
    "next_page_token": "string",
    "page_token_expiry": "2025-01-01T00:00:00Z",
    "previous_page_token": "string"
  }
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?