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.
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.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/workers/string/locate" \ -H "Content-Type: application/json" \ -d '{}'{ "request_id": "00000000-aaaa-bbbb-cccc-111122223333", "worker_handle": "worker001", "status": "pending", "created_at": "2026-06-03T05:46:57.096Z", "updated_at": "2026-06-03T05:46:57.096Z", "devices": [ { "device_id": "AAA11111-BBBB-2222-CCCC-3333DDDD4444", "status": "pending" } ]}{ "detail": {}, "message": "string"}{ "detail": {}, "message": "string"}{ "detail": { "<location>": { "<field_name>": [ "string" ] } }, "message": "string"}