Get records from a specified module

GET/{module}

Use it in a workflow

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

Request

Path parameters

modulestringrequired

Specify the API name of the module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name.

Query parameters

fieldsstringrequired

Specify a comma-separated list of field API names to include in the response. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field IDs and API names.

territory_idstring (int64)

Specify the unique ID of the territory. Use the [Get Territories API](territories.yaml#$.paths./settings/territories.get) to retrieve the territory ID.

idsarray<string (int64)>

Specify a comma-separated list of record IDs. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record IDs.

cvidstring (int64)

Specify the unique ID of the Custom View. Use the [Get Custom Views Metadata API](custom_views.yaml#$.paths./settings/custom_views.get) to retrieve the Custom View IDs.

filtersoneOf

Specify the filter criteria for retrieving specific Custom Views. Accepts a filter object to narrow down results based on Custom View properties.

cross_filtersarray<object>

Specify the filter criteria for retrieving specific Custom Views. Accepts a filter object to narrow down results based on Custom View properties.

include_objectsbooleanrequired

Indicates whether records with matching related records are included in the results.

relationobjectrequired3 fields

Represents the reference to a child relationship module. The api_name property is required to identify the child relationship.

criteriaoneOfrequired

Represents the top-level filter criterion for data selection, supporting both simple field-based filters and complex grouped filters with logical operators.

filterIdstring (int64)

The filter identifier

per_pageinteger (int32)

Specify the number of records to return per page. Maximum is 200.

pageinteger (int32)

Specify the page number to retrieve. Starts at 1.

page_tokenstring

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

sort_orderstring

Specify the sort order for the records. Possible values: desc - Returns records in descending order. asc - Returns records in ascending order.

One ofdescasc

sort_bystring

Specify the field to sort records by. Possible values:**id** - Sorts by record ID. **Created_Time** - Sorts by creation timestamp. **Modified_Time** - Sorts by last modification timestamp.

One ofidCreated_TimeModified_Time

convertedstring

Specify whether to retrieve converted, unconverted, or both types of records. Possible values:**false** - Returns only unconverted records. **true** - Returns only converted records. **both** - Returns both converted and unconverted records.

One offalsetrueboth

include_childboolean

Specify whether to include records assigned to child territories of the specified territory.

Response

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

dataarray<object>

Represents the data value.

idstring (int64)

Represents the unique identifier of the RecordGETDataItem record.

Ownerobject3 fields

Represents the owner value.

Created_Timestring (date-time)

Represents the timestamp when the record was originally created.

Modified_Timestring (date-time)

Represents the timestamp when the record was last modified.

Created_Byobject3 fields

Contains information about the user who originally created the record.

Modified_Byobject3 fields

Contains information about the user who last modified the record.

Wizardobject1 fields

Represents the wizard value.

$statestring

This will be as Save or Draft. 'save' indicates the record is not in any active Blueprint

$wizard_connection_pathstring | null

$wizard_connection_path information denoted by comma separated connection ids between wizard screens.

infoobject

Represents the info value.

pageinteger (int32)required

Represents the info value.

callboolean

Represents the info value.

per_pageinteger (int32)required

Represents the info value.

countinteger (int32)required

Represents the info value.

more_recordsbooleanrequired

Represents the info value.

emailboolean

Represents the info value.

sort_bystringrequired

Represents the info value.

sort_orderstringrequired

Represents the info value.

One ofascdesc

next_page_tokenstring | nullrequired

Represents the info value.

previous_page_tokenstring | nullrequired

Represents the info value.

page_token_expirystring | nullrequired

Represents the info value.

json

{
  "data": [
    {
      "id": "string",
      "Owner": {
        "name": "string",
        "id": "string",
        "email": "string"
      },
      "Created_Time": "2025-01-01T00:00:00Z",
      "Modified_Time": "2025-01-01T00:00:00Z",
      "Created_By": {
        "name": "string",
        "id": "string",
        "email": "string"
      },
      "Modified_By": {
        "name": "string",
        "id": "string",
        "email": "string"
      },
      "Wizard": {
        "id": "string"
      },
      "$state": "save",
      "$wizard_connection_path": "string"
    }
  ],
  "info": {
    "page": 0,
    "per_page": 0,
    "count": 0,
    "more_records": false,
    "sort_by": "string",
    "sort_order": "asc",
    "next_page_token": "string",
    "previous_page_token": "string",
    "page_token_expiry": "2025-01-01T00:00:00Z",
    "call": false,
    "email": false
  }
}

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

Was this page helpful?