Bulk Read APIs - An Overview

The Bulk Read API allows you to fetch large sets of data efficiently. It is useful for exporting large amounts of data or backing up data without significantly affecting your API limits.

Note

  • Asynchronous Processing: The response is not available immediately.
  • Notification via Callback: You can receive a notification at a specified callback URL when the data is ready.
  • Polling Option: Alternatively, you can check the job status periodically.
  • The results are available only as a downloadable CSV file or an ICS file.
  • You can export the records as an ICS file only for the Events module.

How Bulk Read API Works in Zoho CRM

The Bulk Read API follows a three-step process:

Step 1 : Create a Bulk Read Job

  • Make a POST API call to create a bulk read job.
  • Provide the module name, list of fields to export, and filter criteria to specify the data you need.
  • The response contains a unique job ID (id), which serves as a reference for your request.

Step 2: Check Job Status

  • If you want automatic notification when the job is completed, specify a callback URL while creating the job.
  • Alternatively, you can poll the job status periodically by making a GET API call using the job ID.

Step 3: Download the Result

  • Once the job is successfully completed, the API response includes a download_url in the result attribute.
  • Call the download_url to download the ZIP file.
  • The ZIP file contains the exported data in CSV or ICS format.