Download Bulk Read Result

Download the bulk read job in either CSV or ICS format (only for the Events module). You can download it as a .zip file and then extract it to access the desired CSV or ICS file.

Request URL

{api-domain}/bigin/bulk/v2/read/{job_id}/result

Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

  • For US, https://www.zohoapis.com
  • For EU, https://www.zohoapis.eu
  • For AU, https://www.zohoapis.com.au
  • For IN, https://www.zohoapis.in
  • For CN, https://www.zohoapis.com.cn
  • For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.

 

Authorization

For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with the following scope:

  • ZohoBigin.bulk.READ and ZohoBigin.modules.{module_name}.ALL
  • ZohoBigin.bulk.READ and ZohoBigin.modules.{module_name}.READ

In the above scope, replace {module_name} with the necessary module. The possible modules include deals, contacts, accounts (companies in Bigin), products, calls, events, and tasks.

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.

Request parameters

The available request parameters are given below:

Path parameters

job_id stringRequired

The unique identification of bulk read job, which is obtained from the response of the Create Bulk Read Job API.

 

Sample Result

CSV

ICS

For CSV type export,

  • 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.

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.

Sample request

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