Zoho Recruit

records.list

To get the list of available records from a module

Remote zoho/recruit

Remote (network-hosted)

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

Input Schema


            {
  "type": "object",
  "properties": {
    "ids": {
      "type": "string",
      "maxLength": 1024,
      "description": "To retrieve specific records based on their unique ID."
    },
    "cvid": {
      "type": "string",
      "format": "int64",
      "description": "Specify the custom view ID to get the list of records based on custom views"
    },
    "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."
    },
    "module": {
      "type": "string",
      "maxLength": 100,
      "description": "Specifies the module name"
    },
    "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"
    },
    "territory_id": {
      "type": "string",
      "format": "int64",
      "description": "Specify the territory ID to get the list of records that belongs to a specific territory"
    },
    "include_child": {
      "type": "boolean",
      "description": "To include records from the child territories"
    }
  }
}