Zoho Recruit

related.list

Retrieves a paginated list of records from a specific related list of a parent record in a Recruit module. Supports filtering by fields and conditional requests using If-Modified-Since header.

Remote zoho/recruit

Remote (network-hosted)

Other tools also called related.list? See providers with this name

Input Schema


            {
  "type": "object",
  "properties": {
    "ids": {
      "type": "string",
      "pattern": "^[0-9]+(,[0-9]+)*$",
      "maxLength": 2000,
      "description": "Comma-separated list of record IDs to retrieve."
    },
    "page": {
      "type": "integer",
      "format": "int32",
      "description": "To get the list of records from the respective pages"
    },
    "fields": {
      "type": "string",
      "maxLength": 1024,
      "description": "Specify the API names of the fields you want to retrieve when fetching the records."
    },
    "sort_by": {
      "enum": [
        "id",
        "Created_Time",
        "Modified_Time"
      ],
      "type": "string",
      "description": "To sort the records based on the fields id, Created_Time, and Modified_Time. The default value is 'id'"
    },
    "per_page": {
      "type": "integer",
      "format": "int32",
      "description": "Specify how many records to return per page"
    },
    "converted": {
      "enum": [
        "false",
        "true",
        "both"
      ],
      "type": "string",
      "description": "To get the list of converted records"
    },
    "page_token": {
      "type": "string",
      "maxLength": 100,
      "description": "To fetch more than 2000 records, you must include the \"page_token\" param in the request"
    },
    "sort_order": {
      "enum": [
        "desc",
        "asc"
      ],
      "type": "string",
      "description": "To sort the available list of records in either ascending or descending order"
    },
    "relatedList": {
      "type": "string",
      "pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
      "maxLength": 100,
      "description": "The name of the related list (module) containing the records to retrieve or modify"
    },
    "parentRecord": {
      "type": "string",
      "pattern": "^[0-9]+$",
      "maxLength": 20,
      "description": "The unique identifier of the parent record. Must be a valid numeric record ID."
    },
    "parentRecordModule": {
      "type": "string",
      "pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
      "maxLength": 100,
      "description": "The module name of the parent record (e.g., Contacts, Leads, Deals, Accounts, Services__s, Price_Books)"
    }
  }
}