openapi: 3.1.0 info: title: Helpcenter Read API version: 1.0.0 tags: - name: Read 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 properties: api_name: type: string description: The api name maxLength: 255 description: The field additionalProperties: false description: The group item additionalProperties: false description: The group maxItems: 2 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: - INVALID_CALLBACK_METHOD - INVALID_CALLBACK_URL description: The code details: type: object properties: supported_callback_methods: type: array items: type: string description: The supported callback methods item maxLength: 500 enum: - - post description: The supported callback methods maxItems: 1000 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: - GROUP_OPERATOR_NOT_SUPPORTED description: The code details: type: object properties: supported: type: array items: type: string description: The supported item maxLength: 500 enum: - - and - or description: The supported maxItems: 1000 required: - supported 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: - PAGE_RANGE_EXCEEDED description: The code details: type: object properties: max_limit: type: integer format: int32 description: The max limit required: - max_limit 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: - INVALID_REQUEST 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: - MODULE_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: - CVID_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: status: type: string enum: - error description: The status code: type: string enum: - REQUEST_BODY_IS_EMPTY - MODULE_NOT_AVAILABLE - TOO_MANY_REQUESTS - COMPARATOR_AND_ENCRYPTED_VALUE_IN_CRITERIA_NOT_COMPATIBLE - PAGE_NOT_SUPPORTED - NOT_SUPPORTED_FEATURE - FIELD_NOT_SUPPORTED - QUERY_NOT_SUPPORTED - VALUE_LIMIT_EXCEEDED_IN_CRITERIA - JOB_NOT_SUPPORTED - CRITERIA_LIMIT_EXCEEDED - REQUEST_BODY_NOT_READABLE - FIELD_AND_COMPARATOR_IN_CRITERIA_NOT_COMPATIBLE - INVALID_URL_PATTERN - NO_PERMISSION - FIELD_AND_VALUE_IN_CRITERIA_NOT_COMPATIBLE - FIELD_IN_CRITERIA_NOT_AVAILABLE - VALUE_IN_CRITERIA_NOT_SUPPORTED - MEDIA_TYPE_NOT_SUPPORTED - INVALID_BULK_OPERATION - CALLBACK_FAILURE - INVALID_SERVICE_NAME - JOIN_LIMIT_EXCEEDED - CRITERIA_NOT_SUPPORTED - INVALID_REQUEST - INVALID_REQUEST_METHOD - INVALID_TOKEN description: The code message: type: string description: The message maxLength: 1000 details: oneOf: - type: object description: The details oneof additionalProperties: false - type: object description: The details oneof properties: criteria: type: object description: The api name maxLength: 255 required: - criteria additionalProperties: false - type: object properties: api_name: type: string description: The api name maxLength: 255 module: type: string description: The module maxLength: 255 required: - api_name - module description: The details oneof additionalProperties: false - type: object properties: api_name: type: string description: The api name maxLength: 255 reason: type: string description: The reason maxLength: 500 module: type: string description: The module maxLength: 500 required: - api_name - reason description: The details oneof additionalProperties: false - type: object properties: comparator: type: string description: The comparator maxLength: 500 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: - comparator - api_name - supported description: The details oneof additionalProperties: false - type: object properties: api_name: type: string description: The api name maxLength: 255 required: - api_name description: The details oneof additionalProperties: false - type: object properties: api_name: type: string description: The api name maxLength: 255 field_label: type: string description: The field name maxLength: 255 required: - api_name - field_label description: The details oneof additionalProperties: false required: - status - code - message - details description: The response oneof additionalProperties: false - type: object properties: code: type: string enum: - INVALID_CRITERIA description: The code details: type: object properties: field: type: object properties: api_name: type: string description: The api name maxLength: 255 id: type: string description: The id maxLength: 100 required: - api_name - id description: The field additionalProperties: false 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 - boolean - array description: The value additionalProperties: true 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: - VALUE_TYPE_NOT_SUPPORTED description: The code details: 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 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_NOT_SUPPORTED description: The code details: type: object properties: api_name: type: string description: The api name maxLength: 255 description: The details additionalProperties: false message: type: string description: The message maxLength: 1000 status: type: string enum: - error description: The status description: The response oneof additionalProperties: false - type: object properties: code: type: string enum: - MODULE_NOT_AVAILABLE description: The code details: type: object properties: api_name: type: string description: The api name maxLength: 255 reason: type: string description: The reason maxLength: 500 module: type: string description: The module maxLength: 500 required: - api_name description: The details additionalProperties: false message: type: string description: The message maxLength: 1000 status: type: string enum: - error description: The status description: The response oneof additionalProperties: false - type: object properties: code: type: string enum: - FIELD_NOT_AVAILABLE 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 description: The response oneof additionalProperties: false - type: object properties: code: type: string enum: - CRITERIA_LIMIT_EXCEEDED description: The code message: type: string description: The message maxLength: 1000 details: type: object properties: max_limit: type: integer format: int32 description: The max limit enum: - 25 description: The details additionalProperties: false status: type: string enum: - error description: The status description: The response oneof additionalProperties: false - type: object properties: code: type: string enum: - VALUE_LIMIT_EXCEEDED_IN_CRITERIA description: The code message: type: string description: The message maxLength: 1000 details: type: object properties: max_limit: type: integer format: int32 description: The max limit enum: - 200 description: The details additionalProperties: false status: type: string enum: - error description: The status description: The response oneof additionalProperties: false - type: object properties: code: type: string enum: - VALUE_IN_CRITERIA_NOT_SUPPORTED description: The code details: type: object properties: field: type: object properties: api_name: type: string description: The api name maxLength: 255 id: type: string description: The id maxLength: 100 required: - api_name - id description: The field additionalProperties: false 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 description: The details additionalProperties: false message: type: string description: The message maxLength: 1000 status: type: string enum: - error description: The status description: The response oneof additionalProperties: false - type: object description: The response oneof additionalProperties: false - type: object properties: code: type: string enum: - EXPIRED_VALUE 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: - INVALID_DATA description: The code details: type: object description: The details additionalProperties: false properties: field: type: object properties: api_name: type: string description: The api name maxLength: 255 id: type: string description: The id maxLength: 100 required: - api_name - id description: The field additionalProperties: false 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 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: - INVALID_DATA description: The code details: type: object description: The details additionalProperties: false properties: api_name: type: string description: The api name maxLength: 255 supported_values: type: array description: The id maxLength: 100 enum: - - ics - csv 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 summary: Createbulkreadjob description: Createbulkreadjob security: - iam-oauth2-schema: - ZohoCRM.bulk.READ - ZohoCRM.modules.ALL tags: - Read /read/{jobId}: get: operationId: getBulkReadJobDetails parameters: - name: jobId in: path required: true schema: type: string description: The job id maxLength: 100 description: The jobId responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string description: The id maxLength: 100 operation: type: string description: The operation maxLength: 500 state: type: string enum: - COMPLETED - ADDED - QUEUED - IN PROGRESS description: The state query: type: object properties: module: type: object properties: api_name: type: string description: The api name maxLength: 255 id: type: string description: The id maxLength: 100 required: - api_name - id description: The module additionalProperties: false cvid: type: string 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 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 id: type: - string - 'null' description: The id maxLength: 100 required: - api_name - id description: The field additionalProperties: false id: type: - string - 'null' description: The id maxLength: 100 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 - id - value - type - comparator description: The group item additionalProperties: false description: The group maxItems: 1000 required: - group_operator - group description: The criteria additionalProperties: false required: - module - page description: The query additionalProperties: false created_by: type: object properties: name: type: string description: The name maxLength: 255 id: type: string description: The id maxLength: 100 required: - name - id description: The created by additionalProperties: false created_time: type: string format: date-time description: The created time result: type: object properties: page: type: integer format: int32 description: The page count: type: integer format: int32 description: The count download_url: type: string description: The download url maxLength: 2048 per_page: type: integer format: int32 description: The per page more_records: type: boolean description: The more records next_page_token: type: string description: The next page token maxLength: 500 required: - page - count - download_url - per_page - more_records description: The result additionalProperties: false file_type: type: string enum: - csv description: The file type Attachment_Source__s: type: string enum: - custom_link - document - zoho_workdrive - custom_file description: The attachment source s File_Id__s: type: - string - 'null' description: The file id s maxLength: 100 required: - id - operation - state - query - created_by - created_time - file_type - Attachment_Source__s - File_Id__s description: The data item additionalProperties: false description: The data maxItems: 1000 required: - data description: The response additionalProperties: false '404': description: Client error response content: application/json: schema: type: object properties: code: type: string enum: - RESOURCE_NOT_FOUND description: The code details: type: object properties: resource: type: string description: The resource maxLength: 500 required: - resource 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 additionalProperties: false summary: Getbulkreadjobdetails description: Getbulkreadjobdetails security: - iam-oauth2-schema: - ZohoCRM.bulk.READ - ZohoCRM.modules.ALL tags: - Read /read/{jobId}/result: get: operationId: downloadResult parameters: - name: jobId in: path required: true schema: type: string description: The job id maxLength: 100 description: The jobId responses: '200': description: Successful response content: application/zip: schema: type: object properties: file: type: object description: The file additionalProperties: false required: - file description: The response additionalProperties: false '404': description: Client error response content: application/json: schema: type: object properties: code: type: string enum: - RESOURCE_NOT_FOUND description: The code details: type: object properties: resource: type: string description: The resource maxLength: 500 required: - resource 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 additionalProperties: false summary: Downloadresult description: Downloadresult security: - iam-oauth2-schema: - ZohoCRM.bulk.READ - ZohoCRM.modules.ALL tags: - Read components: securitySchemes: iam-oauth2-schema: $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema x-entity: Helpcenter