Zoho

Zoho Read API

The Read API from Zoho — 3 operation(s) for read.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.zoho.com/crm/developer/docs/api/
📖
APIReference
https://www.zoho.com/crm/developer/docs/api/v8/
📖
GettingStarted
https://www.zoho.com/crm/developer/docs/
📖
Documentation
https://desk.zoho.com/DeskAPIDocument
📖
Documentation
https://www.zoho.com/analytics/api/v2/introduction.html
📖
APIReference
https://www.zoho.com/analytics/api/v2/
📖
Documentation
https://www.bigin.com/developer/docs/apis/v2/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/openapi/zoho-read-api-openapi.yml

Code Examples

💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-Sample-apps-iOS
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-android
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-flutter
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-reactnative
💻
CodeExamples
https://github.com/zoho/Zoho-Desk-ASAP-Mobile-SDK-API-Samples
💻
CodeExamples
https://github.com/zoho/analytics-codestudio

Other Resources

🔗
SDKs
https://packagist.org/packages/zohocrm/php-sdk-8.0
🔗
SDKs
https://pypi.org/project/zohocrmsdk8-0/
🔗
SDKs
https://www.nuget.org/packages/ZOHOCRMSDK-8.0/
🔗
SDKs
https://github.com/zoho/zohocrm-java-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/nodejs-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/typescript-sdk-8.0
🔗
SDKs
https://rubygems.org/gems/ZOHOCRMSDK8_0
🔗
SDKs
https://github.com/zoho/zohocrm-javascript-sdk-8.0
🔗
SDKs
https://github.com/zoho/zohocrm-scala-sdk-8.0
🔗
SDKs
https://cocoapods.org/pods/ZCRMiOS
🔗
DeveloperPortal
https://www.zoho.com/desk/developers/
🔗
SDKs
https://github.com/zoho/ZohoDeskPortalSDK
🔗
SDKs
https://github.com/zoho/react-native-zohodesk-portal-sdk
🔗
SDKs
https://github.com/zoho/zdesk-asap-flutter
🔗
SDKs
https://github.com/zoho/cordova-plugin-zohodesk-portal
🔗
Tools
https://github.com/zoho/analytics-mcp-server
🔗
Integrations
https://github.com/zoho/analytics-dataiku-import-plugin
🔗
Integrations
https://github.com/zoho/analytics-dataiku-export-plugin
🔗
DeveloperPortal
https://www.bigin.com/developer-center.html

OpenAPI Specification

zoho-read-api-openapi.yml Raw ↑ 
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
 

# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/openapi/zoho-read-api-openapi.yml