Get Workers

get

https://v3.api.hypertrack.com/workers/

Fetch workers in a paginated list

Query Params

from_date

string | null

Defaults to null

ISO 8601 date format ('yyyy-MM-dd') indicating the start date to be used for the summary computation.
Default: Current date in UTC.

to_date

string | null

Defaults to null

ISO 8601 date format ('yyyy-MM-dd') indicating the end date to be used for the summary computation.
Default: Current date in UTC.

limit

integer | null

Defaults to 25

Number of workers to be sent in response

include_schedule

boolean

Defaults to true

Flag to include worker's schedule in the response.

include_summary

boolean

Defaults to true

Flag to include worker's summary stats in the response.

ops_group_handle

string | null

Defaults to null

List of ops group handles as comma separated strings used to filter workers.

profile

string | null

Defaults to null

Profile filter to be applied on the list of workers

worker_handle

string | null

Defaults to null

List of worker handles as comma separated strings used for fetching associated workers

search_term

string | null

Defaults to null

Keyword to match against worker handle, name, or profile

pagination_token

string | null

Defaults to null

Identifier used to fetch the next page of data

device_id

uuid | null

Defaults to null

Unique identifier for a worker's device. This field is present in case the worker is currently linked with a device

include_deleted

boolean

Defaults to false

Flag to include deleted workers

from_time

date-time | null

Defaults to null

deprecated

ISO 8601 datetime indicating the start time to be used for computing summary, status.

to_time

date-time | null

Defaults to null

deprecated

ISO 8601 datetime indicating the end time to be used for computing summary, status.

filter_outage

string | null

Defaults to null

Filter workers on a particular outage code.

filter_outage_category

string | null

Defaults to null

List of comma separated outage categories to be used for filtering workers. Valid categories: behavioural,adversarial,reachability,os,sporadic

filter_geofence_metadata

string | null

Defaults to null

geofence_metadata filter for aggregate response

aggregate

boolean

Defaults to false

Flag set to retrieve aggregated data over the provided time range

work_status

string | null

Defaults to null

URL-encoded json string specifying filters on availability or tracking.

filter_status

string | null

enum

Defaults to null

Only list workers that are currently active/inactive/disconnected.

Allowed:

tracked

boolean | null

Defaults to null

If set to true, only shows workers that were actually tracked during the specified period.

worked

boolean | null

Defaults to null

If set to true, only shows workers that actually during the specified period.

intended_to_track

boolean | null

Defaults to null

If set to true, only shows workers that was supposed to be tracked during the specified period.

include_lp

boolean | null

Defaults to false

Flag to include location permission stats in response (only applicable when aggregate=True).

region_filter

string | null

Defaults to null

URL-encoded JSON string used to filter workers from a particular region. Ex {"city":"Detroit"}

Responses

200Successful response

401Authentication error

422Validation error