Get bulk read job details

GET/read/{jobId}

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Get bulk read job details action (under Bulk Read).
Fill in the fields below, then reference the result from later steps as {{getBulkReadJobDetails.response.data}}.

Request

Path parameters

jobIdstringrequired

Specify the unique identifier of the bulk read job.

Response

Returns 200 with an object. Read it in later steps with {{getBulkReadJobDetails.response.data.<field>}}.

dataarray<object>

Represents the list of bulk read job details returned in the response.

idstringrequired

Represents the unique identifier of the bulk read job.

operationstringrequired

Specifies the type of action the API completed. Sample - "operation" : "read”.

statestringrequired

Represents the current processing state of the bulk read job. Possible values: **ADDED** - The job has been created and is awaiting processing. **QUEUED** - The job is queued and scheduled for processing. **IN PROGRESS** - The job is currently being processed. **COMPLETED** - The job has finished processing and the result is available for download.

One ofCOMPLETEDADDEDQUEUEDIN PROGRESS

queryobjectrequired5 fields

Represents the query configuration used to create the bulk read job, including the module, filter criteria, and field selections.

created_byobjectrequired2 fields

Represents the user who created the bulk read job.

created_timestring (date-time)required

Represents the date and time when Zoho CRM created the bulk read job, in ISO 8601 format.

resultobject6 fields

specifies the export result details of the bulk read job, including the download URL and pagination information. Present when the job has completed or partially completed.

file_typestringrequired

Indicates the format of the exported file. Possible values: **csv** - The records are exported in CSV format.

One ofcsv

json

{
  "data": [
    {
      "id": "string",
      "operation": "string",
      "state": "COMPLETED",
      "query": {
        "module": {
          "api_name": "string",
          "id": "string"
        },
        "page": 0,
        "cvid": "string",
        "fields": [
          "string"
        ],
        "criteria": {
          "group_operator": "or",
          "group": [
            {
              "field": null,
              "value": null,
              "type": null,
              "comparator": null,
              "id": null
            }
          ]
        }
      },
      "created_by": {
        "name": "string",
        "id": "string"
      },
      "created_time": "2025-01-01T00:00:00Z",
      "file_type": "csv",
      "result": {
        "page": 0,
        "count": 0,
        "download_url": "string",
        "per_page": 0,
        "more_records": false,
        "next_page_token": "string"
      }
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?