---
title: "Property Explorer Bulk Job Status"
method: GET
path: "/v3/jobs/{request_id}/status"
tags: ["Property Explorer API"]
---

# Property Explorer Bulk Job Status

`GET /v3/jobs/{request_id}/status`

Check the status of a property explorer bulk job request. This endpoint is meant to be polled to monitor the progress of jobs created by the PEXP static or dynamic link batch endpoints. The request_id is obtained from the POST requests to the pexp_static_link or pexp_dynamic_link endpoints.  

Pricing Tier: Premium 

## Request Path Params

<table><tr><th>Property</th><th>Type</th><th>Description</th><th>Example</th></tr>
<tr><td>request_id</td><td>string</td><td>The unique identifier for the bulk request obtained from the POST pexp endpoints</td><td>b2177aa4-f220-4da9-bd03-e7d3d28a89f0.2</td>
        </tr>
</table>

## Response

<table><tr><th>Field</th><th>Type</th><th>Description</th><th>Example</th><th>Enum Values</th></tr>
<tr><td>request_id</td><td>string</td><td>The unique identifier for the bulk request</td><td>b2177aa4-f220-4da9-bd03-e7d3d28a89f0.2</td>
        <td></td></tr>
<tr><td>all_tasks_are_finished</td><td>boolean</td><td>Indicates whether all tasks in this job are finished (either successfully or failed)</td><td>true</td>
        <td></td></tr>
<tr><td>task_states</td><td>array</td><td>Array of individual task states, each correlating to an individual address request</td><td></td>
        <td></td></tr>
<tr><td>task_states[]</td><td>object</td><td></td><td></td>
        <td></td></tr>
<tr><td>task_states[].uuid</td><td>string</td><td>Unique identifier for the individual task</td><td>00000000-0000-0000-0003-631700000000</td>
        <td></td></tr>
<tr><td>task_states[].name</td><td>string</td><td>Name of the task type</td><td>bulk_pexp_static_link_task</td>
        <td></td></tr>
<tr><td>task_states[].state</td><td>string</td><td>Current state of the task. PENDING: initial state, RECEIVED: received by worker, STARTED: worker started processing, RETRY: failed task scheduled for retry, SUCCESS: processed successfully, FAILURE: processing failed</td><td>SUCCESS</td>
        <td>[PENDING, RECEIVED, STARTED, RETRY, SUCCESS, FAILURE]</td></tr>
<tr><td>task_states[].error</td><td>string</td><td>Error message if the task failed, empty string if no error</td><td></td>
        <td></td></tr>
<tr><td>task_uuid_to_link_map</td><td>object</td><td>Map of task UUIDs to their generated download links</td><td><pre id="json">{
  "00000000-0000-0000-0003-631700000000": "https://download-links.dev.hc.housecanary.net/dl/HQQLSTuOVZHi0G2Umiwa9A/221975/170-King-St-Unit-618-San-Francisco-CA-94107.pdf",
  "00000000-0000-0000-0003-631800000000": "https://download-links.dev.hc.housecanary.net/dl/ZmpJHQO5Sb37sr7EJTM00w/221976/1070-Post-St-Apt-4-San-Francisco-CA-94109.pdf"
}</pre></td>
        <td></td></tr>
</table>

## Path parameters

- `request_id` string, required

## Response `200`

Success

- object — Status information for the bulk job request and individual tasks
  - `request_id` string, required — The unique identifier for the bulk request
  - `all_tasks_are_finished` boolean, required — Indicates whether all tasks in this job are finished (either successfully or failed)
  - `task_states` object[], required — Array of individual task states, each correlating to an individual address request
    - `uuid` string, required — Unique identifier for the individual task
    - `name` string, required — Name of the task type
    - `state` 'PENDING' | 'RECEIVED' | 'STARTED' | 'RETRY' | 'SUCCESS' | 'FAILURE', required — Current state of the task. PENDING: initial state, RECEIVED: received by worker, STARTED: worker started processing, RETRY: failed task scheduled for retry, SUCCESS: processed successfully, FAILURE: processing failed
    - `error` string, required — Error message if the task failed, empty string if no error
  - `task_uuid_to_link_map` object, required — Map of task UUIDs to their generated download links

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `429` — Rate limit exceeded

---

[API](https://skmtc.net/housecanary/apis/housecanary-analytics-and-portfolio-monitoring-apis.md) · [All operations](https://skmtc.net/housecanary/apis/housecanary-analytics-and-portfolio-monitoring-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/housecanary/housecanary-analytics-and-portfolio-monitoring-apis/revisions/38afb6724de7/schema)