---
title: "Get Candidate Workers"
method: GET
path: "/orders/{order_handle}/candidate_workers"
tags: ["Orders"]
---

# Get Candidate Workers

`GET /orders/{order_handle}/candidate_workers`

## Request

- Base URL: `https://v3.api.hypertrack.com`
- URL: `https://v3.api.hypertrack.com/orders/{order_handle}/candidate_workers`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/hypertrack/apis/hypertrack-api/docs/orders/:order_handle/candidate_workers/get.ts> (a function with typed inputs; its response is checked against the schema)

Get candidate workers for an order identified by the given order_handle. Optionally pass destination_geometry to use a different destination for this request.

## Path parameters

- `order_handle` string, required

## Query parameters

- `type` string, nullable
- `type_index` integer, nullable
- `fulfillment_attempt` integer, nullable
- `profile_filter` string, nullable
- `limit` integer, nullable
- `skip_already_assigned_worker` boolean, nullable
- `allow_ongoing_order` boolean, nullable
- `destination_geometry` string, nullable

## Response `200`

Successful response

- CandidateWorkersResponse
  - `candidate_workers` CandidateWorker[], required: List of workers that are candidates for the order
    - `worker_handle` string, required: Unique Handle of Worker
    - `profile` object, nullable: Profile of the worker
    - `order_start_location` union: Start location of the order
      - LocationGeometryResponse
        - `type` string, required: Geometry type
        - `coordinates` unknown[], required: Location coordinates represented as list of [longitude, latitude].
          - unknown
      - unknown
    - `route` union: Candidate Route of the worker
      - CandidateWorkerRoute
        - `route_handle` string, required: Unique Handle of Route
        - `index` integer, required: Index at which the order can be added to the route
      - unknown
    - `duration` integer, nullable: Estimated time in seconds for the worker to reach the order destination, taking into account any stops before it
    - `distance` integer, nullable: Estimated distance in meters for the worker to reach the order destination, taking into account any stops before it

## Other responses

- `400`: Validation error
- `401`: Authentication error
- `404`: Not found

---

[API](https://skmtc.dev/hypertrack/apis/hypertrack-api.md) - [All operations](https://skmtc.dev/hypertrack/apis/hypertrack-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hypertrack/apis/hypertrack-api/revisions/389326c4c9c8?raw)