Zoho Recruit
records.search
Searches records matching your criteria within a Recruit module. Supports criteria queries, email/phone/word searches. At least one search parameter required. Max 2,000 records, 15 criteria conditions. Newly created records may have indexing delays.
Remote zoho/recruit
Remote (network-hosted)
Other tools also called records.search?
See providers with this name
Input Schema
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32",
"description": "To get the list of records from the respective pages"
},
"type": {
"enum": [
"ActiveAndDeactive",
"CurrentUser",
"DeletedUsers",
"ParentRoleUsers",
"ChildRoleUsers",
"DeactiveUsers",
"NotConfirmedUsers",
"ConfirmedUsers",
"ActiveUsers",
"AdminUsers",
"ActiveConfirmedAdmins",
"ActiveConfirmedUsers",
"DeveloperUsers",
"SubordinateRoleUsers",
"AllUsers",
"AllActiveUsers"
],
"type": "string",
"maxLength": 50,
"description": "Filter users by their status, role, or confirmation state"
},
"word": {
"type": "string",
"maxLength": 100,
"minLength": 2,
"description": "A simple word or phrase to search across all supported text fields in the module. Performs a global search with minimum 2 characters required. This is the broadest search method but may be slower than specific field searches.\n*Mandatory if criteria, email, and phone are not present.*"
},
"email": {
"type": "string",
"format": "string",
"maxLength": 255,
"description": "Search records by email address across all email fields in the module. Supports partial matches and searches multiple email fields simultaneously.\n*Mandatory if criteria, phone, and word are not present.*"
},
"phone": {
"type": "string",
"pattern": "^[+]?[0-9\\s\\-\\(\\)\\.]+$",
"maxLength": 50,
"minLength": 3,
"description": "Search records by phone number across all phone fields in the module. Supports various phone number formats including international, national, and partial numbers.\n*Mandatory if criteria, email, and word are not present.*"
},
"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'"
},
"criteria": {
"type": "string",
"maxLength": 3000,
"description": "Complex query string to search for records using field-specific conditions and operators. Supports up to 15 conditions combined with AND/OR operators. **Format:** `(field_name:operator:value)` with logical operators.\n*Mandatory if email, phone, and word are not present.*"
},
"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"
},
"sort_order": {
"enum": [
"desc",
"asc"
],
"type": "string",
"description": "To sort the available list of records in either ascending or descending order"
},
"approval_state": {
"enum": [
"approval_process_pending",
"webform_invalid",
"review_process_pending",
"webform_invalid_approval",
"zia_vision_validation",
"review_process_rejected",
"webform_unapproved",
"email_parser_waiting",
"approved",
"merge_pending",
"email_parser_rejected",
"zia_vision_rejected",
"zia_vision_pending",
"approval_process_rejected",
"webform_double_optin"
],
"type": "string",
"maxLength": 50,
"description": "Filter records by their approval status. This parameter is particularly useful for modules with approval workflows or data validation processes."
}
}
}