HyperTrackDocs
Workers

Invite Worker

POST
/workers/{worker_handle}/invite

Generate a HyperTrack app (ORDERS or VISITS) installation link to be shared with the worker

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

worker_handle*string

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/invite" \  -H "Content-Type: application/json" \  -d '{}'
{  "worker_handle": "james@ht.com",  "invite_link": "https://hypertrack-logistics.app.link/example-worker-invite"}
{  "title": "string",  "detail": "string"}
{  "code": "string",  "title": "string",  "detail": "string"}
{  "code": "string",  "title": "string",  "detail": "string"}

Get worker export job status GET

Check the status of a worker export job by job_id. Returns current status, progress, and download URL when completed.

Locate a worker POST

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.