To retrieve records that match your search criteria within a single module. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 1 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Search Records",
"description": "To retrieve records that match your search criteria within a single module.",
"version": "8",
"summary": "Zoho CRM Search API allows you to search for records in a specified module using various criteria and parameters."
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"enum": [
"com",
"eu",
"in",
"cn",
"au"
],
"default": "com",
"description": "API Server URL TLD"
},
"version": {
"default": "v8",
"description": "API Version"
}
}
}
],
"paths": {
"/{module}/search": {
"get": {
"tags": [
"Search"
],
"summary": "Search Records by Criteria, Word, Email, or Phone",
"operationId": "searchRecords",
"description": "Searches records matching your criteria within a CRM 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.",
"parameters": [
{
"$ref": "#/components/parameters/Module"
},
{
"$ref": "#/components/parameters/ApprovalState"
},
{
"$ref": "#/components/parameters/Criteria"
},
{
"$ref": "#/components/parameters/Converted"
},
{
"$ref": "#/components/parameters/SearchWord"
},
{
"$ref": "#/components/parameters/SearchEmail"
},
{
"$ref": "#/components/parameters/SearchPhone"
},
{
"$ref": "#/components/parameters/Fields"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/PerPage"
},
{
"$ref": "#/components/parameters/SortBy"
},
{
"$ref": "#/components/parameters/SortOrder"
},
{
"$ref": "#/components/parameters/Type"
}
],
"responses": {
"200": {
"description": "Successful response containing the list of records matching the search criteria.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Successful search response containing matched records and pagination information",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "Array of records matching the search criteria",
"maxItems": 200,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the record",
"maxLength": 50
},
"Owner": {
"type": "object",
"description": "Owner information of the record",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name of the record owner",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Unique identifier of the owner",
"maxLength": 50
},
"email": {
"type": "string",
"description": "Email address of the owner",
"format": "email"
}
}
},
"Created_Time": {
"type": "string",
"description": "Timestamp when the record was created",
"format": "date-time"
},
"Modified_Time": {
"type": "string",
"description": "Timestamp when the record was last modified",
"format": "date-time"
},
"Created_By": {
"type": "object",
"description": "User who created the record",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name of the user who created the record",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Unique identifier of the user who created the record",
"maxLength": 50
},
"email": {
"type": "string",
"description": "Email address of the user who created the record",
"format": "email"
}
},
"required": [
"id"
]
},
"Modified_By": {
"type": "object",
"description": "User who last modified the record",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name of the user who last modified the record",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Unique identifier of the user who last modified the record",
"maxLength": 50
},
"email": {
"type": "string",
"description": "Email address of the user who last modified the record",
"format": "email"
}
}
}
},
"required": [
"id"
],
"additionalProperties": true,
"description": "Record object containing module-specific fields and system fields"
}
},
"info": {
"type": "object",
"description": "Pagination and response metadata",
"additionalProperties": false,
"properties": {
"per_page": {
"type": "integer",
"description": "Number of records per page",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Number of records in current response",
"format": "int32"
},
"page": {
"type": "integer",
"description": "Current page number",
"format": "int32"
},
"more_records": {
"type": "boolean",
"description": "Indicates if more records are available"
},
"sort_by": {
"type": "string",
"description": "Field used for sorting the records",
"maxLength": 100
},
"sort_order": {
"type": "string",
"description": "Order of sorting the records",
"enum": [
"asc",
"desc"
]
}
}
}
},
"required": [
"data"
]
}
}
}
},
"204": {
"description": "No Content - The request was successful, but no records matched the search criteria. This may occur due to indexing delays when searching for recently created/modified records."
},
"400": {
"description": "Bad Request - The request could not be processed due to invalid input, missing mandatory parameters, or malformed search criteria.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"description": "Invalid request error response",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"description": "Error status indicator",
"enum": [
"error"
]
},
"code": {
"type": "string",
"description": "Error code indicating invalid request",
"enum": [
"INVALID_REQUEST"
]
},
"message": {
"type": "string",
"description": "Human-readable error message",
"maxLength": 1000
},
"details": {
"type": "object",
"description": "Additional error details",
"additionalProperties": false
}
},
"required": [
"status",
"code",
"message"
]
},
{
"type": "object",
"description": "Operation not supported error response",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"description": "Error status indicator",
"enum": [
"error"
]
},
"code": {
"type": "string",
"description": "Error code indicating unsupported operation",
"enum": [
"NOT_SUPPORTED"
]
},
"message": {
"type": "string",
"description": "Human-readable error message",
"maxLength": 1000
},
"details": {
"type": "object",
"description": "Additional error details including module information",
"additionalProperties": false,
"properties": {
"module": {
"type": "string",
"description": "The module that does not support this operation",
"maxLength": 100
}
},
"required": [
"module"
]
}
},
"required": [
"status",
"code",
"message",
"details"
]
},
{
"type": "object",
"description": "Missing required parameter error response",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"description": "Error status indicator",
"enum": [
"error"
]
},
"code": {
"type": "string",
"description": "Error code indicating missing parameters",
"enum": [
"EXPECTED_PARAM_MISSING"
]
},
"message": {
"type": "string",
"description": "Human-readable error message",
"maxLength": 1000
},
"details": {
"type": "object",
"description": "Additional error details including missing parameter names",
"additionalProperties": false,
"properties": {
"param_names": {
"type": "array",
"description": "List of missing parameter names",
"maxItems": 4,
"items": {
"type": "string",
"description": "Parameter name",
"enum": [
"criteria",
"email",
"phone",
"word"
]
}
}
},
"required": [
"param_names"
]
}
},
"required": [
"status",
"code",
"message",
"details"
]
},
{
"type": "object",
"description": "Invalid module error response",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"description": "Error status indicator",
"enum": [
"error"
]
},
"code": {
"type": "string",
"description": "Error code indicating invalid module",
"enum": [
"INVALID_MODULE"
]
},
"message": {
"type": "string",
"description": "Human-readable error message",
"maxLength": 1000
},
"details": {
"type": "object",
"description": "Additional error details including resource path information",
"additionalProperties": false,
"properties": {
"resource_path_index": {
"type": "integer",
"description": "Index of the invalid resource path segment",
"format": "int32"
}
},
"required": [
"resource_path_index"
]
}
},
"required": [
"status",
"code",
"message",
"details"
]
},
{
"type": "object",
"description": "Invalid query error response with various detail formats",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"description": "Error status indicator",
"enum": [
"error"
]
},
"code": {
"type": "string",
"description": "Error code indicating invalid query",
"enum": [
"INVALID_QUERY"
]
},
"message": {
"type": "string",
"description": "Human-readable error message describing the query issue",
"enum": [
"the field in restricted in GDPR",
"the field in restricted in Hipaa",
"Invalid query formed"
]
},
"details": {
"oneOf": [
{
"type": "object",
"description": "Data type mismatch error details",
"additionalProperties": false,
"properties": {
"expected_data_type": {
"type": "string",
"description": "The expected data type for the field",
"maxLength": 100
},
"reason": {
"type": "string",
"description": "Detailed reason for the error",
"maxLength": 500
}
},
"required": [
"expected_data_type",
"reason",
"api_name"
]
},
{
"type": "object",
"description": "Invalid operator error details",
"additionalProperties": false,
"properties": {
"operator": {
"type": "string",
"description": "The invalid operator used in the query",
"maxLength": 50
},
"reason": {
"type": "string",
"description": "Detailed reason for the error",
"maxLength": 500
}
},
"required": [
"operator",
"reason",
"api_name"
]
},
{
"type": "object",
"description": "General query error details",
"additionalProperties": false,
"properties": {
"reason": {
"type": "string",
"description": "Detailed reason for the error",
"maxLength": 500
}
},
"required": [
"reason",
"api_name"
]
}
]
}
},
"required": [
"status",
"code",
"message",
"details"
]
},
{
"type": "object",
"description": "Invalid query error response for IN operator violations",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"description": "Error status indicator",
"enum": [
"error"
]
},
"code": {
"type": "string",
"description": "Error code indicating invalid query",
"enum": [
"INVALID_QUERY"
]
},
"message": {
"type": "string",
"description": "Human-readable error message describing the query issue",
"enum": [
"Only 100 values are allowed in \"IN\" criteria",
"Invalid query formed"
]
},
"details": {
"type": "object",
"description": "Additional error details including field information",
"additionalProperties": false,
"properties": {
"param_name": {
"type": "string",
"description": "Name of the parameter causing the error",
"maxLength": 100
}
},
"required": [
"api_name"
]
}
},
"required": [
"status",
"code",
"message",
"details"
]
},
{
"type": "object",
"description": "Limit reached error response when maximum record iteration exceeded",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"description": "Error status indicator",
"enum": [
"error"
]
},
"code": {
"type": "string",
"description": "Error code indicating limit reached",
"enum": [
"LIMIT_REACHED"
]
},
"message": {
"type": "string",
"description": "Human-readable error message",
"enum": [
"maximum response iteration limit reached"
]
},
"details": {
"type": "object",
"description": "Additional error details including the limit value",
"additionalProperties": false,
"properties": {
"limit": {
"type": "string",
"description": "Maximum number of records allowed",
"enum": [
"2000"
]
}
},
"required": [
"limit"
]
}
},
"required": [
"status",
"code",
"message",
"details"
]
},
{
"type": "object",
"description": "Criteria limit exceeded error response",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"description": "Error status indicator",
"enum": [
"error"
]
},
"code": {
"type": "string",
"description": "Error code indicating criteria limit exceeded",
"enum": [
"CRITERIA_LIMIT_EXCEEDED"
]
},
"message": {
"type": "string",
"description": "Human-readable error message",
"enum": [
"no of criterium that can be given exceed the limit 15"
]
},
"details": {
"type": "object",
"description": "Additional error details",
"additionalProperties": false
}
},
"required": [
"status",
"code",
"message",
"details"
]
},
{
"type": "object",
"description": "Generic error response for other bad request scenarios",
"additionalProperties": false
}
]
}
}
}
},
"401": {
"description": "Unauthorized - Authentication failed or insufficient OAuth scope permissions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - User lacks permission to access the requested module or perform the search operation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found - The requested URL pattern is invalid or the specified resource does not exist.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests - Rate limit exceeded. Wait before making additional requests.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error - An unexpected error occurred on the server. Contact support if the issue persists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"502": {
"description": "Bad Gateway - Temporary service dependency failure. The request should be retried.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "Service Unavailable - The service is temporarily unavailable due to maintenance or capacity issues.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Leads.READ",
"ZohoSearch.securesearch.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Contacts.READ",
"ZohoSearch.securesearch.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Accounts.READ",
"ZohoSearch.securesearch.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Deals.READ",
"ZohoSearch.securesearch.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Tasks.READ",
"ZohoSearch.securesearch.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Events.READ",
"ZohoSearch.securesearch.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Calls.READ",
"ZohoSearch.securesearch.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Products.READ",
"ZohoSearch.securesearch.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Vendors.READ",
"ZohoSearch.securesearch.READ"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Campaigns.READ",
# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-module-search-openapi.json