Bulk Read. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 3 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Bulk Read",
"description": "Bulk Read",
"version": "8"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/bulk/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"enum": [
"com",
"eu",
"in",
"cn",
"au"
],
"default": "com",
"description": "API Server URL TLD"
},
"version": {
"description": "API Version",
"default": "v8"
}
}
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.bulk.READ",
"ZohoCRM.modules.ALL"
]
}
],
"paths": {
"/read": {
"post": {
"operationId": "createBulkReadJob",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"callback": {
"type": "object",
"properties": {
"url": {
"type": "string",
"enum": [
"https://www.example.com/callback"
],
"description": "The url"
},
"method": {
"type": "string",
"enum": [
"post"
],
"description": "The method"
}
},
"required": [
"url",
"method"
],
"description": "The callback",
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"module": {
"type": "object",
"properties": {
"api_name": {
"type": "string",
"description": "The api name",
"maxLength": 255
}
},
"required": [
"api_name"
],
"description": "The module",
"additionalProperties": false
},
"cvid": {
"type": [
"string",
"null"
],
"description": "The cvid",
"maxLength": 100
},
"fields": {
"type": "array",
"items": {
"type": "string",
"description": "The fields item",
"maxLength": 500
},
"description": "The fields",
"maxItems": 1000
},
"page": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "The page"
},
"criteria": {
"type": "object",
"properties": {
"group_operator": {
"type": "string",
"enum": [
"or",
"and"
],
"description": "The group operator"
},
"group": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"api_name": {
"type": "string",
"description": "The api name",
"maxLength": 255
}
},
"required": [
"api_name"
],
"description": "The field",
"additionalProperties": false
},
"value": {
"type": "string",
"description": "The value",
"maxLength": 500
},
"type": {
"type": "string",
"enum": [
"value"
],
"description": "The type"
},
"comparator": {
"type": "string",
"enum": [
"equal",
"contains",
"ends_with",
"not_contains",
"not_equal",
"starts_with"
],
"description": "The comparator"
}
},
"required": [
"field",
"value",
"comparator"
],
"description": "The group item",
"additionalProperties": false
},
"description": "The group",
"maxItems": 1000
}
},
"required": [
"group_operator",
"group"
],
"description": "The criteria",
"additionalProperties": false
}
},
"required": [
"module"
],
"description": "The query",
"additionalProperties": false
},
"file_type": {
"type": "string",
"enum": [
"csv",
"ics"
],
"description": "The file type"
}
},
"required": [
"query"
],
"description": "The request body",
"additionalProperties": false
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"success"
],
"description": "The status"
},
"code": {
"type": "string",
"enum": [
"ADDED_SUCCESSFULLY"
],
"description": "The code"
},
"message": {
"type": "string",
"enum": [
"Added successfully."
],
"description": "The message"
},
"details": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id",
"maxLength": 100
},
"operation": {
"type": "string",
"description": "The operation",
"maxLength": 500,
"enum": [
"read"
]
},
"state": {
"type": "string",
"enum": [
"COMPLETED",
"ADDED",
"IN PROGRESS",
"FAILURE"
],
"description": "The state"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id",
"maxLength": 100
},
"name": {
"type": "string",
"description": "The name",
"maxLength": 256
}
},
"required": [
"id"
],
"description": "The created by",
"additionalProperties": false
},
"created_time": {
"type": "string",
"format": "date-time",
"description": "The created time"
}
},
"required": [
"id",
"operation",
"state",
"created_by",
"created_time"
],
"description": "The details",
"additionalProperties": false
}
},
"required": [
"status",
"code",
"message",
"details"
],
"description": "The data item",
"additionalProperties": false
},
"description": "The data",
"maxItems": 1000
},
"info": {
"type": "object",
"description": "The info",
"additionalProperties": false
}
},
"required": [
"data",
"info"
],
"description": "The response",
"additionalProperties": false
}
}
}
},
"400": {
"description": "Client error response",
"content": {
"application/json": {
"schema": {
"description": "Bulk read job creation error response",
"oneOf": [
{
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"REQUEST_BODY_NOT_SUPPORTED"
],
"description": "The code"
},
"details": {
"type": "object",
"description": "The details",
"additionalProperties": false
},
"message": {
"type": "string",
"description": "The message",
"maxLength": 1000
},
"status": {
"type": "string",
"enum": [
"error"
],
"description": "The status"
}
},
"required": [
"code",
"details",
"message",
"status"
],
"description": "The response oneof",
"additionalProperties": false
},
{
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"FIELD_IN_CRITERIA_NOT_SUPPORTED",
"FIELD_COMPARATOR_IN_CRITERIA_NOT_SUPPORTED",
"COMPARATOR_AND_VALUE_IN_CRITERIA_NOT_COMPATIBLE"
],
"description": "The code"
},
"details": {
"oneOf": [
{
"type": "object",
"properties": {
"api_name": {
"type": "string",
"description": "The api name",
"maxLength": 255
},
"comparator": {
"type": "string",
"description": "The comparator",
"maxLength": 500
},
"type": {
"type": "string",
"description": "The type",
"maxLength": 500
},
"value": {
"type": [
"object",
"string",
"array"
],
"description": "The value",
"additionalProperties": false
}
},
"required": [
"api_name"
],
"description": "The details oneof",
"additionalProperties": false
},
{
"type": "object",
"properties": {
"comparator": {
"type": "string",
"description": "The comparator",
"maxLength": 500
},
"type": {
"type": "string",
"description": "The type",
"maxLength": 500
},
"value": {
"type": [
"object",
"string",
"array"
],
"description": "The value",
"additionalProperties": false
}
},
"required": [
"comparator"
],
"description": "The details oneof",
"additionalProperties": false
},
{
"type": "object",
"properties": {
"api_name": {
"type": "string",
"description": "The api name",
"maxLength": 255
},
"comparator": {
"type": "string",
"description": "The comparator",
"maxLength": 500
},
"type": {
"type": "string",
"description": "The type",
"maxLength": 500
},
"value": {
"type": "object",
"description": "The value",
"additionalProperties": false
},
"field": {
"type": "object",
"properties": {
"api_name": {
"type": "string",
"description": "The api name",
"maxLength": 255
}
},
"description": "The field",
"additionalProperties": false
}
},
"required": [
"api_name",
"field"
],
"description": "The details oneof",
"additionalProperties": false
},
{
"type": "object",
"properties": {
"api_name": {
"type": "string",
"description": "The api name",
"maxLength": 255
},
"supported": {
"type": "array",
"items": {
"type": "string",
"description": "The supported item",
"maxLength": 500
},
"description": "The supported",
"maxItems": 1000
}
},
"required": [
"api_name",
"supported"
],
"description": "The details oneof",
"additionalProperties": false
}
]
},
"message": {
"type": "string",
"description": "The message",
"maxLength": 1000
},
"status": {
"type": "string",
"enum": [
"error"
],
"description": "The status"
}
},
"required": [
"code",
"details",
"message",
"status"
],
"description": "The response oneof",
"additionalProperties": false
},
{
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"AMBIGUOUS_CRITERIA",
"AMBIGUOUS_GROUP_IN_CRITERIA"
],
"description": "The code"
},
"details": {
"oneOf": [
{
"type": "object",
"properties": {
"api_name": {
"type": "string",
"description": "The group operator",
"maxLength": 500
}
},
"description": "The details oneof",
"additionalProperties": false
},
{
"type": "object",
"properties": {
"comparator": {
"type": "string",
"description": "The comparator",
"maxLength": 500
},
"type": {
"type": "string",
"description": "The type",
"maxLength": 500
},
"value": {
"type": "object",
"description": "The value",
"additionalProperties": false
},
"field": {
"type": "object",
"properties": {
"api_name": {
"type": "string",
"description": "The api name",
"maxLength": 255
}
},
"required": [
"comparator",
"field",
"type",
"value"
],
"description": "The field",
"additionalProperties": false
}
},
"description": "The details oneof",
"additionalProperties": false
},
{
"type": "object",
"properties": {
"api_name": {
"type": "string",
"description": "The api name",
"maxLength": 255
},
"type": {
"type": "string",
"description": "The type",
"maxLength": 500
},
"comparator": {
"type": "string",
"description": "The value",
"additionalProperties": false
}
},
"required": [
"api_name",
"type",
"comparator"
],
"description": "The details oneof",
"additionalProperties": false
},
{
"type": "object",
"properties": {
"api_name": {
"type": "string",
"description": "The api name",
"maxLength": 255
},
"type": {
"type": "string",
"description": "The type",
"maxLength": 500
},
"value": {
"type": [
"object",
"string"
],
"description": "The value",
"additionalProperties": false
}
},
"required": [
"api_name",
"type"
],
"description": "The details oneof",
"additionalProperties": false
},
{
"type": "object",
"properties": {
"group": {
"type": "array",
"items": {
"type": "object",
"properties": {
"api_name": {
"type": "string",
"description": "The api name",
"maxLength": 255
},
"comparator": {
"type": "string",
"description": "The comparator",
"maxLength": 500
},
"type": {
"type": "string",
"description": "The type",
"maxLength": 500
},
"value": {
"type": [
"object",
"string"
],
"description": "The value",
"additionalProperties": false
},
"field": {
"type": "object",
"properties": {
"api_name": {
"type": "string",
"description": "The api name",
"maxLength": 255
}
},
"description": "The field",
"additionalProperties": false
}
},
"required": [
"api_name",
"comparator",
"type",
"value"
],
"description": "The group item",
"additionalProperties": false
},
"required": [
"api_name",
"comparator",
"type",
"value"
],
"description": "The group",
"maxItems": 1000
},
"group_operator": {
"type": "string",
"description": "The group operator",
"maxLength": 500
}
},
"description": "The details oneof",
"additionalProperties": false
},
{
"type": "object",
"properties": {
"group": {
"type": "array",
"items": {
"type": "object",
"properties": {
"comparator": {
"type": "string",
"description": "The comparator",
"maxLength": 500
},
"type": {
"type": "string",
"description": "The type",
"maxLength": 500
},
"value": {
"type": "string",
"description": "The value",
"additionalProperties": false
},
"field": {
"type": "object",
# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-bulk-read-openapi.json