Download Bulk Read Result
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.
where job_id is the unique ID of the bulk read job.
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Possible module names
accounts(companies in Bigin), contacts, deals, tasks, events, calls and products
Possible operation types
Full access to related records
READ - Get bulk read job
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.
If the "fields" attribute in the query JSON is left empty, all the fields available in Bigin 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.
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.
curl "https://www.zohoapis.com/bigin/bulk/v1/read/554023000000568002/result" -X GET -H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
ZBiginBulkRead readIns = ZBiginRestClient.GetInstance().GetBulkReadInstance(31443322); // To get the ZBiginBulkRead instance using job_id FileAPIResponse respone = readIns.DownloadBulkReadResult(); Stream file = respone.GetFileAsStream();// To get response file stream. CommonUtil.SaveStreamAsFile("/Users/Desktop/", file, respone.GetFileName());//To download stream as zip. file.Close();