Workers

Locate a worker

Initiates an async worker locate. The implementation sets the worker's availability=true (waking the SDK), pulls a fresh location from each currently-linked device, then sets availability back to false. Returns immediately with a request_id; poll the GET endpoint or listen for the locate webhook for the final result.

post/workers/{worker_handle}/locate

Request

Base URL
https://v3.api.hypertrack.com
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/hypertrack/apis/hypertrack-api/docs/workers/:worker_handle/locate/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

worker_handlestring required

Request body

CreateLocateRequest required

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.