HyperTrack

HyperTrack Workers API

The Workers API from HyperTrack — 14 operation(s) for workers.

GitHub OpenAPI

Operations 20

GET /workers/ Get Workers
POST /workers/ Create Worker
GET /workers/locate Poll the state of a worker locate request
POST /workers/export Create a worker export job
GET /workers/ops-groups/ List Ops Groups
POST /workers/ops-groups/ Create Ops Group
GET /workers/{worker_handle} Get Worker By Handle
PATCH /workers/{worker_handle} Patch Worker
DELETE /workers/{worker_handle} Delete Worker
GET /workers/export/{job_id} Get worker export job status
POST /workers/{worker_handle}/invite Invite Worker
POST /workers/{worker_handle}/locate Locate a worker
GET /workers/{worker_handle}/history Get Worker History
POST /workers/{worker_handle}/undelete Undelete Worker
GET /workers/{worker_handle}/approvers List Worker Approvers
POST /workers/{worker_handle}/approvers Create Worker Approver
POST /workers/{worker_handle}/work_status Set Worker Work Status
GET /workers/ops-groups/{ops_group_handle} Get Ops Group by Handle
PATCH /workers/ops-groups/{ops_group_handle} Update Ops Group
DELETE /workers/{worker_handle}/approvers/{approver_id} Delete Worker Approver

Documentation

📖
Documentation
https://hypertrack.com/docs/introduction
📖
APIReference
https://hypertrack.com/reference/get-orders
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/authentication/hypertrack-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/openapi/hypertrack-workers-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/errors/hypertrack-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/data-model/hypertrack-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/conventions/hypertrack-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/conventions/hypertrack-conventions.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/asyncapi/hypertrack-events-webhooks.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/mcp/hypertrack-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/hypertrack-workers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hypertrack-workers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HyperTrack Workers API
  version: '1.0'
  description: HyperTrack API Reference — Orders, Workers, Places, Routes, and more.
  contact:
    name: HyperTrack support
    url: https://hypertrack.com/contact
    email: help@hypertrack.com
servers:
- url: https://v3.api.hypertrack.com
tags:
- name: Workers
paths:
  /workers/:
    get:
      parameters:
      - in: query
        name: from_date
        description: 'ISO 8601 date format (''yyyy-MM-dd'') indicating the start date to be used for the summary computation.<br>Default: Current date in UTC.'
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: to_date
        description: 'ISO 8601 date format (''yyyy-MM-dd'') indicating the end date to be used for the summary computation.<br>Default: Current date in UTC.'
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: limit
        description: Number of workers to be sent in response
        schema:
          type:
          - integer
          - 'null'
          default: 25
        required: false
      - in: query
        name: include_schedule
        description: Flag to include worker's schedule in the response.
        schema:
          type: boolean
          default: true
        required: false
      - in: query
        name: include_summary
        description: Flag to include worker's summary stats in the response.
        schema:
          type: boolean
          default: true
        required: false
      - in: query
        name: ops_group_handle
        description: List of ops group handles as comma separated strings used to filter workers.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: profile
        description: Profile filter to be applied on the list of workers
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: worker_handle
        description: List of worker handles as comma separated strings used for fetching associated workers
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: search_term
        description: Keyword to match against worker handle, name, or profile
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: pagination_token
        description: Identifier used to fetch the next page of data
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: device_id
        description: Unique identifier for a worker's device. This field is present in case the worker is currently linked with a device
        schema:
          type:
          - string
          - 'null'
          format: uuid
        required: false
      - in: query
        name: include_deleted
        description: Flag to include deleted workers
        schema:
          type: boolean
          default: false
        required: false
      - in: query
        name: from_time
        description: ISO 8601 datetime indicating the start time to be used for computing summary, status.
        schema:
          type:
          - string
          - 'null'
          format: date-time
          deprecated: true
        required: false
      - in: query
        name: to_time
        description: ISO 8601 datetime indicating the end time to be used for computing summary, status.
        schema:
          type:
          - string
          - 'null'
          format: date-time
          deprecated: true
        required: false
      - in: query
        name: filter_outage
        description: Filter workers on a particular outage code.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: filter_outage_category
        description: 'List of comma separated outage categories to be used for filtering workers. Valid categories: `behavioural`,`adversarial`,`reachability`,`os`,`sporadic`'
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: filter_geofence_metadata
        description: geofence_metadata filter for aggregate response
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: aggregate
        description: Flag set to retrieve aggregated data over the provided time range
        schema:
          type: boolean
          default: false
        required: false
      - in: query
        name: work_status
        description: URL-encoded json string specifying filters on availability or tracking.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: filter_status
        description: Only list workers that are currently active/inactive/disconnected.
        schema:
          type:
          - string
          - 'null'
          enum:
          - active
          - inactive
          - disconnected
        required: false
      - in: query
        name: tracked
        description: If set to true, only shows workers that were actually tracked during the specified period.
        schema:
          type:
          - boolean
          - 'null'
        required: false
      - in: query
        name: worked
        description: If set to true, only shows workers that actually during the specified period.
        schema:
          type:
          - boolean
          - 'null'
        required: false
      - in: query
        name: intended_to_track
        description: If set to true, only shows workers that was supposed to be tracked during the specified period.
        schema:
          type:
          - boolean
          - 'null'
        required: false
      - in: query
        name: include_lp
        description: Flag to include location permission stats in response (only applicable when `aggregate=True`).
        schema:
          type:
          - boolean
          - 'null'
          default: false
        required: false
      - in: query
        name: region_filter
        description: URL-encoded JSON string used to filter workers from a particular region. Ex `{"city":"Detroit"}`
        schema:
          type:
          - string
          - 'null'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkersResponse'
              examples:
                Filter on profile:
                  summary: Filter on profile
                  value:
                    workers:
                    - created_at: 2023-10-18 12:41:59.865000+00:00
                      device_id: 7B252163-BC27-46B2-8BFD-FFB87D633602
                      device_info:
                        device_brand: OnePlus
                        device_model: DN2111
                        network_operator: JIO 4G
                        os_hardware_identifier: 10b653a2c0a09e77
                        os_name: Android
                        os_version: '11'
                        sdk_version: 7.0.9+a5a509f3
                        timezone: Asia/Kolkata
                      device_status:
                        data:
                          activity: drive
                          recorded_at: 2023-10-24 16:27:52.768000+00:00
                        value: active
                      devices:
                      - device_id: 7B252163-BC27-46B2-8BFD-FFB87D633602
                        start_time: 2023-10-183T20:42:38Z
                      - device_id: 7B252163-BC27-46B2-8BFD-FFB87D633602
                        start_time: 2023-10-183T16:02:38Z
                        end_time: 2023-10-183T20:41:38Z
                      worker_handle: james@ht.com
                      location:
                        accuracy: 19.35
                        bearing: 352.97
                        geometry:
                          coordinates:
                          - -121.94186
                          - 37.3570492
                          - -44.01
                          type: Point
                        speed: 20.2
                      name: James
                      ops_group_handle: store-sf
                      product_types:
                      - plumbing
                      - hardware
                      profile:
                        zoneId: '4'
                      schedule:
                      - day_of_week: MONDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: TUESDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: WEDNESDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: THURSDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: FRIDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: SATURDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: SUNDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      home:
                        address: 777 Story Rd, San Jose, CA 95122
                        geometry:
                          type: Point
                          coordinates:
                          - -121.8624398
                          - 37.3304521
                        radius: 100
                      work_status:
                        available: false
                        tracking: true
                      location_permission:
                        recorded_at: 2023-12-19 12:29:54.321000+00:00
                        state: always
                      unavailable_on:
                      - 2023-12-15
                      summary:
                        orders:
                          completed: 4
                          cancelled: 1
                          assigned: 0
                          tracked: 5
                          total: 6
                        geotags: 4
                        visits: 4
                        distance: null
                        duration: null
                        tracking_rate: null
                    - created_at: 2023-10-06 12:00:45.221000+00:00
                      device_id: 71284FFE-D949-4FF7-B238-44C667BE8EF4
                      device_status:
                        data:
                          recorded_at: 2023-10-24 12:51:25.995000+00:00
                        value: disconnected
                      worker_handle: smith@ht.com
                      location:
                        accuracy: 35
                        bearing: 280.3
                        geometry:
                          coordinates:
                          - 20.016091
                          - 50.103046
                          - 250.59
                          type: Point
                        speed: 0
                      name: fero
                      ops_group_handle: store-sjc
                      profile:
                        zoneId: '4'
                      work_status:
                        available: false
                        tracking: true
                    - created_at: 2023-07-13 15:05:31.341000+00:00
                      worker_handle: rick@ht.com
                      ops_group_handle: store-okl
                      profile:
                        zoneId: '4'
                      schedule:
                      - day_of_week: MONDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: TUESDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: WEDNESDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: THURSDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: FRIDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: SATURDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: SUNDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      work_status:
                        available: false
                        tracking: false
                    pagination_token: eyJwYWdlX251bWJlciI6IDIzLCJsYXN0X2l0ZW1faWQiOiAxMjM0NQ==
                Filter on ops group:
                  summary: Filter on ops group
                  value:
                    workers:
                    - created_at: 2023-07-13 15:05:31.341000+00:00
                      worker_handle: rick@ht.com
                      ops_group_handle: store-okl
                      profile:
                        zoneId: '4'
                      schedule:
                      - day_of_week: MONDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: TUESDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: WEDNESDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: THURSDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: FRIDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: SATURDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      - day_of_week: SUNDAY
                        end_time: 1080
                        ops_group_handle: store-sf
                        priority: null
                        start_time: 09:00
                      work_status:
                        available: false
                        tracking: false
                    pagination_token: eyJwYWdlX251bWJlciI6IDIzLCJsYXN0X2l0ZW1faWQiOiAxMjM0NQ==
                Filter on worker handle:
                  summary: Filter on worker handle
                  value:
                    workers:
                    - created_at: 2023-10-18 12:41:59.865000+00:00
                      device_id: 7B252163-BC27-46B2-8BFD-FFB87D633602
                      device_status:
                        data:
                          activity: drive
                          recorded_at: 2023-10-24 16:27:52.768000+00:00
                        value: active
                      worker_handle: james@ht.com
                      location:
                        accuracy: 19.35
                        bearing: 352.97
                        geometry:
                          coordinates:
                          - -121.94186
                          - 37.3570492
                          - -44.01
                          type: Point
                        speed: 20.2
                      name: James
                      ops_group_handle: store-sf
                      profile:
                        zoneId: '4'
                      work_status:
                        available: false
                        tracking: true
                Filter on work status:
                  summary: Filter on work status
                  value:
                    workers:
                    - created_at: 2023-10-18 12:41:59.865000+00:00
                      device_id: 7B252163-BC27-46B2-8BFD-FFB87D633602
                      device_status:
                        data:
                          activity: drive
                          recorded_at: 2023-10-24 16:27:52.768000+00:00
                        value: active
                      worker_handle: james@ht.com
                      location:
                        accuracy: 19.35
                        bearing: 352.97
                        geometry:
                          coordinates:
                          - -121.94186
                          - 37.3570492
                          - -44.01
                          type: Point
                        speed: 20.2
                      name: James
                      ops_group_handle: store-sf
                      profile:
                        zoneId: '4'
                      work_status:
                        available: true
                        tracking: false
                    - created_at: 2023-10-06 12:00:45.221000+00:00
                      device_id: 71284FFE-D949-4FF7-B238-44C667BE8EF4
                      device_status:
                        data:
                          recorded_at: 2023-10-24 12:51:25.995000+00:00
                        value: disconnected
                      worker_handle: smith@ht.com
                      location:
                        accuracy: 35
                        bearing: 280.3
                        geometry:
                          coordinates:
                          - 20.016091
                          - 50.103046
                          - 250.59
                          type: Point
                        speed: 0
                      name: fero
                      ops_group_handle: store-sjc
                      profile:
                        zoneId: '4'
                      work_status:
                        available: true
                        tracking: false
                    pagination_token: eyJwYWdlX251bWJlciI6IDIzLCJsYXN0X2l0ZW1faWQiOiAxMjM0NQ==
                Fetch aggregate:
                  summary: Fetch aggregate
                  value:
                    aggregate:
                      geotags:
                        count: 107
                        deviation: 2300
                        distance: 8035
                        duration: 14583
                      orders:
                        count:
                          assigned: 22
                          cancelled: 516
                          completed: 634
                          ongoing: 8
                          total: 1261
                        deviation: 365
                        distance: 8035
                        duration: 18374
          description: Successful response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Authentication error
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: Validation error
      tags:
      - Workers
      summary: Get Workers
      description: Fetch workers in a paginated list
      security:
      - BasicAuth: []
      - TokenAuth: []
    post:
      parameters: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostWorkerResponse'
              example:
                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: 1080
                  day_of_week: MONDAY
                - start_time: 09:00
                  end_time: 1080
                  day_of_week: TUESDAY
                - start_time: 09:00
                  end_time: 1080
                  day_of_week: WEDNESDAY
                - start_time: 09:00
                  end_time: 1080
                  day_of_week: THURSDAY
                - start_time: 09:00
                  end_time: 1080
                  day_of_week: FRIDAY
                created_at: 2023-06-01 02:00:00+00:00
                home:
                  address: 777 Story Rd, San Jose, CA 95122
                  geometry:
                    type: Point
                    coordinates:
                    - -121.8624398
                    - 37.3304521
                  radius: 100
                device_status:
                  value: unavailable
          description: Successful response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Authentication error
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: Validation error
      tags:
      - Workers
      summary: Create Worker
      description: Create a worker
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostWorkerRequest'
            example:
              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: 1080
                day_of_week: MONDAY
              - start_time: 09:00
                end_time: 1080
                day_of_week: TUESDAY
              - start_time: 09:00
                end_time: 1080
                day_of_week: WEDNESDAY
              - start_time: 09:00
                end_time: 1080
                day_of_week: THURSDAY
              - start_time: 09:00
                end_time: 1080
                day_of_week: FRIDAY
              home:
                address: 777 Story Rd, San Jose, CA 95122
                geometry:
                  type: Point
                  coordinates:
                  - -121.8624398
                  - 37.3304521
                radius: 100
      security:
      - BasicAuth: []
      - TokenAuth: []
  /workers/locate:
    get:
      parameters:
      - in: query
        name: request_id
        description: Unique identifier returned by POST /workers/{worker_handle}/locate.
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocateResponse'
              examples:
                locate_completed_location_response_example:
                  summary: 'Completed: a device returned a fresh location.'
                  value:
                    request_id: 00000000-aaaa-bbbb-cccc-111122223333
                    worker_handle: worker001
                    status: completed
                    created_at: 2026-06-03 05:46:57.096000+00:00
                    updated_at: 2026-06-03 05:47:10.780000+00:00
                    completed_at: 2026-06-03 05:47:10.780000+00:00
                    devices:
                    - device_id: AAA11111-BBBB-2222-CCCC-3333DDDD4444
                      status: completed
                      completed_at: 2026-06-03 05:47:10.744000+00:00
                      location:
                        geometry:
                          type: Point
                          coordinates:
                          - -119.60121
                          - 34.4225
                locate_completed_outage_response_example:
                  summary: 'Completed with an outage: location permission denied and imprecise.'
                  value:
                    request_id: 00000000-aaaa-bbbb-cccc-111122223333
                    worker_handle: worker001
                    status: completed
                    created_at: 2026-06-03 05:16:03.109000+00:00
                    updated_at: 2026-06-03 05:16:17.146000+00:00
                    completed_at: 2026-06-03 05:16:17.146000+00:00
                    devices:
                    - device_id: AAA11111-BBBB-2222-CCCC-3333DDDD4444
                      status: completed
                      completed_at: 2026-06-03 05:16:17.114000+00:00
                      outage_reasons:
                      - code: location_permissions_denied
                        label: Location permission denied
                        category: behavioural
                        description: Location permission is denied by the worker. The worker should grant it in Settings > Apps > [App name] > Permissions > Location
                        duration: 0
                        distance: 0
                      - code: location_permission_imprecise
                        label: Location imprecise
                        category: behavioural
                        description: The worker did not grant precise location permissions or downgraded permissions to imprecise. The worker should grant precise location permission in Settings > Apps > [App name] > Permissions > Location > Use precise location
                        duration: 0
                        distance: 0
                locate_completed_disconnected_response_example:
                  summary: Completed but the SDK did not wake within budget (device disconnected).
                  value:
                    request_id: 00000000-aaaa-bbbb-cccc-111122223333
                    worker_handle: worker001
                    status: completed
                    created_at: 2026-06-03 00:00:00+00:00
                    updated_at: 2026-06-03 00:05:00+00:00
                    completed_at: 2026-06-03 00:05:00+00:00
                    devices:
                    - device_id: AAA11111-BBBB-2222-CCCC-3333DDDD4444
                      status: completed
                      completed_at: 2026-06-03 00:05:00+00:00
                      device_status:
                        value: disconnected
                        data:
                          reason: sdk_did_not_respond_within_budget
                          budget_seconds: 300
          description: Successful response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Authentication error
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: Validation error
      tags:
      - Workers
      summary: Poll the state of a worker locate request
      description: '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.'
      security:
      - BasicAuth: []
      - TokenAuth: []
  /workers/export:
    post:
      parameters: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkerExportResponse'
          description: Successful response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Authentication error
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: Validation error
      tags:
      - Workers
      summary: Create a worker export job
      description: Creates an asynchronous job to export workers to CSV.gz file. Returns a job_id that can be used to check status. Download link will be sent via email when ready.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkerExportRequest'
      security:
      - BasicAuth: []
      - TokenAuth: []
  /workers/ops-groups/:
    get:
      parameters:
      - in: query
        name: pagination_token
        description: Identifier used to fetch the next page of data
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: include_deleted
        description: Flag to include deleted ops groups
        schema:
          type: boolean
          default: false
        required: false
      - in: query
        name: include_schedule
        description: Flag to include ops group's schedule in the response.
        schema:
          type: boolean
          default: true
        required: false
      - in: query
        name: limit
        description: Number of ops groups to be sent in the response.
        schema:
          type:
          - integer
          - 'null'
          default: 100
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOpsGroupsResponse'
              example:
                ops_groups:
                - ops_group_handle: san-jose-store
                  ops_group_label: store
                  timezone: America/Los_Angeles
                  route_start_location: ops_group_home
                  route_completion_type: manual
                  ops_group_home:
                    geometry:
                      type: Point
                      coordinates:
                      - -121.94186
                      - 37.3570534
                    address: 1709 Automation Pkwy, San Jose, CA 95101
                  objective_fn: minimise_time
                  route_capacity: 10
                  route_max_distance: 20000
                  default_shift_start_time: 07:00
                  default_shift_end_time: 1140
                  order_tracking_mode: auto
                  shift_availability_mode: auto
                  order_tracking_automation:
                    type: manual
 

# --- truncated at 32 KB (202 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/openapi/hypertrack-workers-api-openapi.yml