Create Worker
Create a worker
Create a worker
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/workers/" \ -H "Content-Type: application/json" \ -d '{ "worker_handle": "james@ht.com", "ops_group_handle": "store-sf", "product_types": [ "plumbing", "hardware" ], "device_id": "00000000-4636-461C-B5F6-7E4BEFC09575", "profile": { "workerId": "0012244", "vehicle": "Ford F-150", "zoneId": "4" }, "schedule": [ { "start_time": "09:00", "end_time": "18:00", "day_of_week": "MONDAY" }, { "start_time": "09:00", "end_time": "18:00", "day_of_week": "TUESDAY" }, { "start_time": "09:00", "end_time": "18:00", "day_of_week": "WEDNESDAY" }, { "start_time": "09:00", "end_time": "18:00", "day_of_week": "THURSDAY" }, { "start_time": "09:00", "end_time": "18:00", "day_of_week": "FRIDAY" } ], "home": { "address": "777 Story Rd, San Jose, CA 95122", "geometry": { "type": "Point", "coordinates": [ -121.8624398, 37.3304521 ] }, "radius": 100 } }'{ "worker_handle": "james@ht.com", "ops_group_handle": "store-sf", "product_types": [ "plumbing", "hardware" ], "device_id": "00000000-4636-461C-B5F6-7E4BEFC09575", "profile": { "workerId": "0012244", "vehicle": "Ford F-150", "zoneId": "4" }, "status": { "available": false, "working": false }, "schedule": [ { "start_time": "09:00", "end_time": "18:00", "day_of_week": "MONDAY" }, { "start_time": "09:00", "end_time": "18:00", "day_of_week": "TUESDAY" }, { "start_time": "09:00", "end_time": "18:00", "day_of_week": "WEDNESDAY" }, { "start_time": "09:00", "end_time": "18:00", "day_of_week": "THURSDAY" }, { "start_time": "09:00", "end_time": "18:00", "day_of_week": "FRIDAY" } ], "created_at": "2023-06-01T02:00:00Z", "home": { "address": "777 Story Rd, San Jose, CA 95122", "geometry": { "type": "Point", "coordinates": [ -121.8624398, 37.3304521 ] }, "radius": 100 }, "device_status": { "value": "unavailable" }}{ "detail": {}, "message": "string"}{ "detail": { "<location>": { "<field_name>": [ "string" ] } }, "message": "string"}Get Workers GET
Fetch workers in a paginated list
Poll the state of a worker locate request GET
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.