HYhypertrack
Workers

Poll the state of a worker locate request

Returns the current state of a locate request. The response shape matches both the POST response and the locate webhook payload. Once status is completed, inspect each devices[] entry for its outcome: a fresh location, outage_reasons when the SDK reported outages, or a device_status of disconnected when the SDK did not wake within the budget.

get/workers/locate

Request

Query parameters

request_idstring required

Unique identifier returned by POST /workers/{worker_handle}/locate.

Response

Successful response

request_idstring required

Unique identifier for the locate request.

worker_handlestring required

Unique customer provided identifier for a worker.

status'pending' | 'completed' | 'error' required

Worker-level rollup: pending while async work is in flight, completed once the async work is done (introspect devices[] for per-device outcomes — connection state lives on device_status, outage detail on outage_reasons), error on unexpected internal failure.

created_atstring nullable

Timestamp at which the locate request was created.

updated_atstring nullable

Timestamp of last update to the locate request.

completed_atstring nullable

Timestamp at which the locate request reached a terminal state.

Changes

No recorded changes to this operation across all 1 revision of this API.