Zoho Recruit icon

Zoho Recruit

Interact with Zoho Recruit API v2 and v2.1

Record APIs → Search

AI-generated

Summary

Search records within a specified Zoho Recruit module using criteria, email, phone, or word search types, optionally returning all matching entries or limiting the results.

Inputs

  • Use Custom Module — Whether to enter a custom module name manually instead of selecting from predefined modules.
  • Module (required) — The Zoho Recruit module API name to search within (e.g., Candidates, Contacts). Ignored if 'Use Custom Module' is true.
  • Custom Module (required) — Manual module API name to search within, used if 'Use Custom Module' is true.
  • Return All — Whether to return all matching records (when true) or limit the results.
  • Limit — Maximum number of records to return when 'Return All' is false. Defaults to 50 and capped between 1 and 200.
  • Search Type (required) — The type of search to perform: Criteria-based, Email, Phone, or Word.
  • Criteria (required) — Search criteria expression, required if Search Type is 'Criteria'.
  • Email (required) — Email address to search for, required if Search Type is 'Email'.
  • Phone (required) — Phone number to search for, required if Search Type is 'Phone'.
  • Word (required) — Keyword to search for, required if Search Type is 'Word'.

Output shape

a list of matching record objects from the specified module, each returned as a separate item.

If 'Return All' is enabled, pagination is handled internally to return all matches; otherwise, the number of returned records is limited. Search is performed via GET requests to the '/recruit/v2/{module}/search' endpoint with appropriate query parameters based on search type.

Links

Discussion