Download Bulk Read Result

Purpose

To download the bulk read job as a CSV or an ICS file (only for the Events module). The file would be in .zip format. Extract it to get the CSV or ICS file.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/read/{job_id}/result
where job_id is the unique ID of the bulk read job.

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.bulk.read
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}

Possible module names

leads, accounts, contacts, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, and custom

Possible operation types

ALL - Full access to related records
READ - Get bulk read job

Note

  • Only 10 requests for download are allowed for one-minute interval. Crossing the limit will result in an error (HTTP code :429) returned to the user as response.

  • To know more about the Bulk API limits, go here.

  • The value of the fields with sensitive health data will be retrieved only when Restrict Data access through API option in the compliance settings is disabled. If the option is enabled, the value will be empty in the result.

Sample Result

CSV

ICS

For CSV type export,

  • If the "fields" attribute in the query JSON is left empty, all the fields available in CRM are listed in the CSV file. In case you need only specific fields, like in the above image, please specify the fields for export.

  • The "id" column is added by default in the CSV file, and it contains the id of the exported records.

  • The "Data/Time" fields in the CSV file are given in the ISO8601 format.

  • You can export a maximum of 200,000 records in a single API call.

For ICS type export,

  • The "fields" attribute is not supported when you want to export the events as an ICS file.

  • If you do not specify "file_type" as "ics", the records will be exported in the CSV format, by default.

  • You can export a maximum of 20,000 records in a single API call.

  • To know more about the Bulk API limits on ICS file, go here.

Possible Errors

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoCRM.bulk.read or ZohoCRM.modules.{module_name}.READ. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to read
    Resolution: The user does not have permission to read records. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to read.
    Resolution: The user does not have the permission to read records. Contact your system administrator.

  • RESOURCE_NOT_FOUNDHTTP 404

    The requested resource doesn't exist.
    Resolution: The job ID specified is invalid. Specify a valid job ID.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/bulk/v5/read/554023000000568002/result"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"