HYhypertrack
Workers

Get Worker By Handle

Fetch the details for a worker using the worker_handle

get/workers/{worker_handle}

Request

Path parameters

worker_handlestring required

Query parameters

include_deletedboolean

Flag to fetch deleted worker

from_timestring date-time nullable

ISO 8601 datetime indicating the start time. Default time range 24 hours.

to_timestring date-time nullable

ISO 8601 datetime indicating the end time. Default time range 24 hours.

datestring nullable

ISO 8601 date format ('yyyy-MM-dd') indicating date to be used for the summary computation.<br> Default: current date in worker's timezone.

include_summaryboolean

Flag to include worker summary. Default true.

include_scheduleboolean

Flag to include worker schedule. Default true.

include_timelineboolean

Flag to include worker timeline. Default false.

Response

Successful response

worker_handlestring required

Unique customer provided identifier for a worker

namestring nullable

Name of the worker

current_datestring required

Current date in the timezone of the worker.

ops_group_handlestring required

Unique identifier for an Ops Group to which the worker belongs

product_typesstring[] nullable

List of product types used for worker matching during order planning

device_idstring nullable

Unique ID representing the worker's device

profileobject nullable

Metadata associated with a worker

deletedboolean nullable

Flag indicating whether the worker was deleted

created_atstring required

Timestamp at which the worker was created

deleted_atstring nullable

Timestamp at which the worker was deleted

unavailable_onstring[] nullable

List of dates (YYYY-MM-DD) on which the worker is not available

timezonestring nullable

Timezone of the worker

Changes

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