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": "Audit Log Export",
"description": "Bulk Read",
"version": "8.0"
},
"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": {
"/settings/audit_log_export": {
"post": {
"operationId": "createAuditLogExport",
"summary": "Create an Audit Log Export job",
"description": "Creates a new export job for audit logs based on the specified criteria.",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.audit_logs.CREATE"
]
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Request body for creating an audit log export job.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "List of audit log export jobs to be created.",
"maxItems": 100,
"items": {
"type": "object",
"description": "Audit log export job details.",
"properties": {
"criteria": {
"$ref": "#/components/schemas/FilterCriterionRequest"
}
},
"required": [
"criteria"
],
"additionalProperties": false
}
}
},
"required": [
"audit_log_export"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Success Response of Create Audit Log Export",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Success response object for Create Audit Log Export.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "List of audit log export job responses.",
"maxItems": 1,
"items": {
"type": "object",
"description": "Audit log export job response details.",
"properties": {
"code": {
"type": "string",
"description": "Status code for the export job.",
"enum": [
"SCHEDULED"
]
},
"details": {
"type": "object",
"description": "Additional details for the export job.",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the export job.",
"maxLength": 64
}
},
"additionalProperties": false
},
"message": {
"type": "string",
"description": "Message describing the export job status.",
"maxLength": 256
},
"status": {
"type": "string",
"description": "Status of the export job.",
"enum": [
"success"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad Request Response of Create Audit Log Export",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"description": "Bad request response with audit_log_export array.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "Array of audit log export errors.",
"items": {
"type": "object",
"description": "Error object for audit log export.",
"additionalProperties": true
},
"maxItems": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Bad request response with audit_log_export array.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "Array of audit log export errors.",
"items": {
"type": "object",
"description": "Error object for audit log export.",
"additionalProperties": true
},
"maxItems": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Bad request response with audit_log_export array.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "Array of audit log export errors.",
"items": {
"type": "object",
"description": "Error object for audit log export.",
"additionalProperties": true
},
"maxItems": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Error response for missing mandatory fields.",
"properties": {
"code": {
"type": "string",
"description": "Error code.",
"enum": [
"MANDATORY_NOT_FOUND"
]
},
"message": {
"type": "string",
"description": "Error message.",
"maxLength": 256
},
"status": {
"type": "string",
"description": "Error status.",
"enum": [
"error"
]
},
"details": {
"type": "object",
"description": "Additional error details.",
"additionalProperties": true
}
},
"required": [
"code",
"message",
"status",
"details"
],
"additionalProperties": false
},
{
"type": "object",
"description": "Error response for not supported operation.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "Array of audit log export errors.",
"items": {
"type": "object",
"description": "Error object for not supported operation.",
"properties": {
"code": {
"type": "string",
"description": "Error code.",
"enum": [
"NOT_SUPPORTED"
]
},
"details": {
"type": "object",
"description": "Additional error details.",
"additionalProperties": true
},
"message": {
"type": "string",
"description": "Error message.",
"maxLength": 256
},
"status": {
"type": "string",
"description": "Error status.",
"enum": [
"error"
]
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Bad request response with audit_log_export array.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "Array of audit log export errors.",
"items": {
"type": "object",
"description": "Error object for audit log export.",
"additionalProperties": true
},
"maxItems": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Bad request response with audit_log_export array.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "Array of audit log export errors.",
"items": {
"type": "object",
"description": "Error object for audit log export.",
"additionalProperties": true
},
"maxItems": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Bad request response with audit_log_export array.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "Array of audit log export errors.",
"items": {
"type": "object",
"description": "Error object for audit log export.",
"additionalProperties": true
},
"maxItems": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Bad request response with audit_log_export array.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "Array of audit log export errors.",
"items": {
"type": "object",
"description": "Error object for audit log export.",
"additionalProperties": true
},
"maxItems": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Limit exceeded error response.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "Array of audit log export errors.",
"items": {
"type": "object",
"description": "Limit exceeded error object.",
"properties": {
"code": {
"type": "string",
"description": "Error code.",
"enum": [
"LIMIT_EXCEEDED"
]
},
"details": {
"type": "object",
"description": "Additional error details.",
"properties": {
"api_name": {
"type": "string",
"description": "API name.",
"maxLength": 64
},
"json_path": {
"type": "string",
"description": "JSON path.",
"maxLength": 256
},
"limit": {
"type": "string",
"description": "Limit value.",
"maxLength": 32
}
},
"additionalProperties": true
},
"message": {
"type": "string",
"description": "Error message.",
"maxLength": 256
},
"status": {
"type": "string",
"description": "Error status.",
"enum": [
"error"
]
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Dependent mismatch error response.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "Array of audit log export errors.",
"items": {
"type": "object",
"description": "Dependent mismatch error object.",
"properties": {
"code": {
"type": "string",
"description": "Error code.",
"enum": [
"DEPENDENT_MISMATCH"
]
},
"details": {
"type": "object",
"description": "Additional error details.",
"properties": {
"expected_data_type": {
"type": "string",
"description": "Expected data type.",
"maxLength": 32
}
},
"additionalProperties": true
},
"message": {
"type": "string",
"description": "Error message.",
"maxLength": 256
},
"status": {
"type": "string",
"description": "Error status.",
"enum": [
"error"
]
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Bad request response with audit_log_export array.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "Array of audit log export errors.",
"items": {
"type": "object",
"description": "Error object for audit log export.",
"additionalProperties": true
},
"maxItems": 100
}
},
"additionalProperties": false
}
]
}
}
}
}
}
},
"get": {
"summary": "Get Exported AuditLogs",
"description": "Retrieves a list of audit log export jobs along with their details.",
"operationId": "getAuditLogExports",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.audit_logs.READ"
]
}
],
"responses": {
"200": {
"description": "Success Response of Get Exported AuditLogs",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Success response for get exported audit logs.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "List of audit log export jobs.",
"maxItems": 100,
"items": {
"type": "object",
"description": "Audit log export job details.",
"properties": {
"criteria": {
"$ref": "#/components/schemas/FilterCriterionResponse"
},
"id": {
"type": "string",
"description": "Unique identifier for the export job.",
"maxLength": 64
},
"status": {
"type": "string",
"description": "Status of the export job.",
"maxLength": 32
},
"created_by": {
"type": "object",
"description": "User who created the export job.",
"properties": {
"name": {
"type": "string",
"description": "Name of the user.",
"maxLength": 256
},
"id": {
"type": "string",
"description": "User ID.",
"maxLength": 64
}
},
"required": [
"id"
],
"additionalProperties": false
},
"download_links": {
"type": "array",
"description": "Download links for exported audit logs.",
"maxItems": 1000,
"items": {
"type": "string",
"description": "Download link URL.",
"maxLength": 2048
}
},
"job_start_time": {
"type": "string",
"description": "Job start time.",
"format": "date-time"
},
"job_end_time": {
"type": "string",
"description": "Job end time.",
"format": "date-time"
},
"expiry_date": {
"type": "string",
"description": "Expiry date for download links.",
"format": "date-time"
}
},
"required": [
"criteria",
"download_links"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
}
},
"204": {
"description": "No Content Response"
}
}
}
},
"/settings/audit_log_export/{id}": {
"get": {
"summary": "Get Exported AuditLogs",
"description": "Retrieves the details of a specific audit log export job by its ID.",
"operationId": "getAuditLogExportsById",
"parameters": [
{
"$ref": "#/components/parameters/Id"
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.audit_logs.READ"
]
}
],
"responses": {
"200": {
"description": "Success Response of Get Exported AuditLogs by ID",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Success response for get exported audit logs by ID.",
"properties": {
"audit_log_export": {
"type": "array",
"description": "List of audit log export jobs.",
"maxItems": 100,
"items": {
"type": "object",
"description": "Audit log export job details.",
"properties": {
"criteria": {
"$ref": "#/components/schemas/FilterCriterionResponse"
},
"id": {
"type": "string",
"description": "Unique identifier for the export job.",
"maxLength": 64
},
"status": {
"type": "string",
"description": "Status of the export job.",
"maxLength": 32
},
"created_by": {
"type": "object",
"description": "User who created the export job.",
"properties": {
"name": {
"type": "string",
"description": "Name of the user.",
"maxLength": 256
},
"id": {
"type": "string",
"description": "User ID.",
"maxLength": 64
}
},
"required": [
"id"
],
"additionalProperties": false
},
"download_links": {
"type": "array",
"description": "Download links for exported audit logs.",
"maxItems": 1000,
"items": {
"type": "string",
"description": "Download link URL.",
"maxLength": 2048
}
},
"job_start_time": {
"type": "string",
"description": "Job start time.",
"format": "date-time"
},
"job_end_time": {
"type": "string",
"description": "Job end time.",
"format": "date-time"
},
"expiry_date": {
"type": "string",
"description": "Expiry date for download links.",
"format": "date-time"
}
},
"required": [
"criteria",
"download_links"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
}
},
"204": {
"description": "No Content Response"
},
"404": {
"description": "Not Found Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Error response for invalid URL pattern.",
"properties": {
"code": {
"type": "string",
"description": "Error code.",
"enum": [
"INVALID_URL_PATTERN"
]
},
"details": {
"type": "object",
"description": "Additional error details.",
"additionalProperties": true
},
"message": {
"type": "string",
"description": "Error message.",
"maxLength": 256
},
"status": {
"type": "string",
"description": "Error status.",
"enum": [
"error"
]
}
},
"required": [
"code",
"message",
"status"
],
"additionalProperties": false
}
}
}
}
}
}
}
},
"components": {
"parameters": {
"Id": {
"name": "id",
"description": "Unique identifier for the audit log export job.",
"in": "path",
"required": true,
"schema": {
"type": "string",
"maxLength": 64
}
}
},
"securitySchemes": {
"iam-oauth2-schema": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
"tokenUrl": "https://accounts.zoho.com/oauth/v2/token",
"refreshUrl": "https://accounts.zoho.com/oauth/v2/token",
"scopes": {
"ZohoCRM.settings.audit_logs.CREATE": "Create audit log exports",
"ZohoCRM.settings.audit_logs.READ": "Read audit log exports"
}
}
}
}
},
"schemas": {
"FilterFieldBase": {
"type": "object",
"description": "Field reference for filter operations with minimal required properties",
"properties": {
"id": {
"type": "string",
"format": "int64",
"description": "Field identifier (optional for filter operations)"
},
"api_name": {
"type": "string",
"maxLength": 255,
"description": "Field API name for filter application. Supports relationship notation (e.g., 'Deals__r.Stage')"
}
},
"additionalProperties": true
},
"SimpleFilterCriterionValueString": {
"type": "string",
"description": "String value for picklist/text/tag options.",
"maxLength": 255
},
"SimpleFilterCriterionValueNumber": {
"type": "number",
"description": "Numeric value for number field options."
},
"SimpleFilterCriterionValueBoolean": {
"type": "boolean",
"description": "Boolean value for checkbox field options."
},
"SimpleFilterCriterionValueObjectBase": {
"type": "object",
"description": "Base minified record of the lookup module.",
"properties": {
"id": {
"type": "string",
"format": "int64",
"description": "Represents the record id of the lookup module"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Represents the name of the lookup module record"
}
},
"additionalProperties": true
},
"SimpleFilterCriterionValueObjectResponse": {
"allOf": [
{
"$ref": "#/components/schemas/SimpleFilterCriterionValueObjectBase"
},
{
"type": "object",
"additionalProperties": true,
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-audit-log-export-openapi.json