tread.io

tread.io Typeaheads API

The Typeaheads API from tread.io — 54 operation(s) for typeaheads.

GitHub OpenAPI

Operations 54

GET /v1/accounts/typeahead Typeahead search on Accounts #
GET /v1/companies/typeahead Typeahead search on Companies #
GET /v1/companies/{company-id}/accounts/capacity/typeahead Typeahead search on Accounts for a Company with with Capacity Data #
GET /v1/companies/{company-id}/accounts/typeahead Typeahead search on Accounts for a Company #
GET /v1/companies/{company-id}/add_ons/typeahead Typeahead search on AddOns for a Company #
GET /v1/companies/{company-id}/children/typeahead Typeahead search on Children for a Company #
GET /v1/companies/{company-id}/data_export/tickets/day/{date} Retrieve Daily Ticket Data Export #
GET /v1/companies/{company-id}/departments/typeahead Typeahead search on Departments by Company #
GET /v1/companies/{company-id}/driver_days/typeahead Typeahead search on DriverDays by Company #
GET /v1/companies/{company-id}/equipment/typeahead Typeahead search on Equipment for a Company #
GET /v1/companies/{company-id}/equipment_types/typeahead Typeahead search on EquipmentType for a Company #
GET /v1/companies/{company-id}/foremen/typeahead Typeahead search on Foremen #
GET /v1/companies/{company-id}/fuel_price_indices/typeahead Typeahead search on FuelPriceIndex for a Company #
GET /v1/companies/{company-id}/jobs/typeahead Typeahead search on Jobs by Company #
GET /v1/companies/{company-id}/loads/typeahead Typeahead search on Loads by Company #
GET /v1/companies/{company-id}/managed_companies/{managed-company-id}/drivers/typeahead Typeahead search on Drivers for a Managed Company #
GET /v1/companies/{company-id}/managed_companies/{managed-company-id}/equipment/typeahead Typeahead search on Equipment for a Managed Company #
GET /v1/companies/{company-id}/managed_companies/{managed-company-id}/equipment_types/typeahead Typeahead search on EquipmentType for a Managed Company #
GET /v1/companies/{company-id}/material_rates/typeahead Typeahead search on MaterialRates for a Company #
GET /v1/companies/{company-id}/materials/typeahead Typeahead search on Material for a Company #
GET /v1/companies/{company-id}/orders/dispatch_numbers/typeahead Typeahead search on Orders' Dispatch Number by Company #
GET /v1/companies/{company-id}/orders/typeahead Typeahead search on Orders by Company #
GET /v1/companies/{company-id}/orders/{order-id}/phases Order Phases #
GET /v1/companies/{company-id}/orders/{order-id}/phases/typeahead Typeahead search on Order Phases #
GET /v1/companies/{company-id}/projects/typeahead Typeahead search on Projects for a Company #
GET /v1/companies/{company-id}/rates/typeahead Typeahead search on Rates for a Company #
GET /v1/companies/{company-id}/service_classes/typeahead Typeahead search on ServiceClasses for a Company #
GET /v1/companies/{company-id}/services/typeahead Typeahead search on Services for a Company #
GET /v1/companies/{company-id}/sites/dispatch Retrieve Sites based on the current Dispatch results for a Company #
GET /v1/companies/{company-id}/sites/dispatch/typeahead Retrieve Sites based on the current Dispatch results for a Company #
GET /v1/companies/{company-id}/sites/typeahead Typeahead search on Sites for a Company #
GET /v1/companies/{company-id}/users/typeahead Typeahead search on Users for a Company #
GET /v1/driver_days/{driver-day-id}/phases/typeahead Typeahead search on DriverDay Phases #
GET /v1/equipment/typeahead Typeahead search on Equipment #
GET /v1/equipment_types/typeahead Typeahead search on EquipmentType #
GET /v1/jobs/typeahead Typeahead search on Jobs #
GET /v1/materials/typeahead Typeahead search on Materials #
GET /v1/orders/{order-id}/phases Order Phases #
GET /v1/orders/{order-id}/phases/typeahead Typeahead search on Order Phases #
GET /v1/projects/external_ids/typeahead Typeahead search on Projects for a Company #
GET /v1/projects/typeahead Typeahead search on Projects #
GET /v1/projects/{project-id}/phases Project Phases #
GET /v1/projects/{project-id}/phases/typeahead Typeahead search on Project Phases #
GET /v1/rates/typeahead Typeahead search on Rates #
GET /v1/service_classes/typeahead Typeahead search on ServiceClasses #
GET /v1/services/typeahead Typeahead search on Services #
GET /v1/sites/dispatch Retrieve Sites based on the current Dispatch results #
GET /v1/sites/dispatch/typeahead Retrieve Sites based on the current Dispatch results #
GET /v1/sites/typeahead Typeahead search on Sites #
GET /v1/traffic_control_plans/typeahead Typeahead search on Traffic Control Plans #
GET /v1/users/typeahead Typeahead search on Users #

Documentation

📖
Documentation
https://docs.tread.ai/api-reference/introduction

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/treadio/refs/heads/main/openapi/treadio-typeaheads-api-openapi.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/treadio-typeaheads-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

treadio-typeaheads-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Horizon API V1 AccountExternalTruckIdentifier Typeaheads API
  version: '1.0'
  contact:
    name: Tread
    url: https://tread.io
    email: developers@tread.io
  description: 'This is the Version 1 implementation.


    When in doubt we default to the practices outlined [here](https://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api#advanced-queries)'
  license:
    name: Private
    url: https://tread.io
servers:
- description: production
  url: https://api.tread-horizon.com
security:
- bearerAuth: []
tags:
- name: Typeaheads
paths:
  /v1/accounts/typeahead:
    parameters:
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on Accounts
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    x-stoplight:
                      id: wvfdabnd4w4ar
                    items:
                      $ref: '#/components/schemas/Account-Read-Typeahead'
                required:
                - data
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '406':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/ModelError'
      operationId: get-v1-accounts-typeahead
      x-stoplight:
        id: 249lre4wlspeo
      description: 'Typeahead search against the `name` property for `Accounts` visible to the currently authenticated `Company`.

        '
      x-internal: true
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
      - $ref: '#/components/parameters/filter-account_types'
      - $ref: '#/components/parameters/filter-connected'
      - $ref: '#/components/parameters/filter-date'
  /v1/companies/typeahead:
    parameters:
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on Companies
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Company-Read-Typeahead'
                required:
                - data
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '406':
          $ref: '#/components/responses/Error'
      operationId: get-v1-companies-typeahead
      description: 'Typeahead search against the `legal_name` property for `Companies` visible to the currently authenticated `Company`.

        '
      x-internal: true
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
      x-stoplight:
        id: qkqja5m9f9ixa
  /v1/companies/{company-id}/accounts/capacity/typeahead:
    parameters:
    - schema:
        type: string
      name: company-id
      in: path
      required: true
      description: Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on Accounts for a Company with with Capacity Data
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Account-Read-Capacity-Typeahead'
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/ModelError'
      operationId: get-v1-companies-accounts-capacity-typeahead
      description: 'Typeahead search against the `name` property on `Accounts` for a `Company`.


        Unlike the standard typeahead, this endpoint includes additional fields with capacity data.


        Additionally, this endpoint automatically filters to:


        - Connnected Accoubts

        - Vendor-type Accounts

        - Accounts that are currently scheduled on


        The `availability` filter can be set to true/false to only include Accounts that are scheduled on or off for the `date` specified. If no `date` is specified then the current day is used.'
      x-internal: true
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
      - $ref: '#/components/parameters/filter-availability'
      - $ref: '#/components/parameters/filter-show_all'
      - $ref: '#/components/parameters/filter-label_ids'
      - schema:
          type: string
        in: query
        name: date
        description: The date to query for regarding capacity. In YYYY-MM-DD format.
        required: true
      x-stoplight:
        id: ki83zc9q4cndp
  /v1/companies/{company-id}/accounts/typeahead:
    parameters:
    - schema:
        type: string
      name: company-id
      in: path
      required: true
      description: Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on Accounts for a Company
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    x-stoplight:
                      id: rao3u2ilhbt61
                    items:
                      $ref: '#/components/schemas/Account-Read-Typeahead'
                required:
                - data
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/ModelError'
      operationId: get-v1-companies-accounts-typeahead
      x-stoplight:
        id: 0wetlqfv1ru46
      description: Typeahead search against the `name` property on `Accounts` for a `Company`.
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
      - $ref: '#/components/parameters/filter-account_types'
      - $ref: '#/components/parameters/filter-connected'
      - $ref: '#/components/parameters/filter-date'
      x-internal: true
  /v1/companies/{company-id}/add_ons/typeahead:
    parameters:
    - schema:
        type: string
      name: company-id
      in: path
      required: true
      description: Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on AddOns for a Company
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    x-stoplight:
                      id: hi3wjxsu1x60b
                    items:
                      $ref: '#/components/schemas/AddOn-Read-Typeahead'
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/ModelError'
      operationId: get-v1-companies-company-id-add_ons-typeahead
      x-stoplight:
        id: 4bo2hvhmh5lg8
      x-internal: true
      description: Typeahead search against the `name` property on `AddOn` for a `Company`
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
      - $ref: '#/components/parameters/filter-add_on_types'
      - $ref: '#/components/parameters/filter-add_on_rate_types'
  /v1/companies/{company-id}/children/typeahead:
    parameters:
    - schema:
        type: string
      name: company-id
      in: path
      required: true
      description: Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on Children for a Company
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Company-Read-Typeahead'
                required:
                - data
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
      operationId: get-v1-companies-company-id-accounts-typeahead
      description: Typeahead search against the `legal_name` property on `Children` for a `Company`.
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
      x-stoplight:
        id: 0cc8k3gzl6bwu
      x-internal: true
  /v1/companies/{company-id}/data_export/tickets/day/{date}:
    parameters:
    - schema:
        type: string
      name: company-id
      in: path
      required: true
      description: Company ID
    - schema:
        type: string
      name: date
      in: path
      required: true
      description: Date of daily report
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Retrieve Daily Ticket Data Export
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    $ref: '#/components/schemas/DailyExport-Read'
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/ModelError'
        '422':
          $ref: '#/components/responses/ModelError'
      operationId: get-v1-companies-daily-export-tickets-day
      description: "Returns a daily export of `tickets` for given company. Please\nnote, this endpoint is only available to users authenticating\nan `m2m_client`. This endpoint must be configured for customer\nby Tread. The file_url is signed and will be valid for 1 hour \nfrom time of api call."
      x-internal: true
      x-stoplight:
        id: p3jfje1rwgtac
  /v1/companies/{company-id}/departments/typeahead:
    parameters:
    - schema:
        type: string
        format: uuid
      name: company-id
      in: path
      required: true
      description: Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on Departments by Company
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    x-stoplight:
                      id: dxnoxece9uuo0
                    type: array
                    items:
                      $ref: '#/components/schemas/Department-Read-Typeahead'
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
      operationId: get-v1-companies-company-id-departments-typeahead
      x-stoplight:
        id: 7axs7zey72hwu
      description: Typeahead search against the `name` property on `Departments` for a `Company`.
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
  /v1/companies/{company-id}/driver_days/typeahead:
    parameters:
    - schema:
        type: string
        format: uuid
      name: company-id
      in: path
      required: true
      description: Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on DriverDays by Company
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DriverDay-Read-Typeahead'
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
      operationId: get-v1-companies-company-id-driver_days-typeahead
      x-stoplight:
        id: ddtypahead01
      description: Typeahead search against the `driver_day_id` property for `DriverDays` visible to the currently authenticated `Company`.
      x-internal: true
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
  /v1/companies/{company-id}/drivers/faceted_search:
    parameters:
    - schema:
        type: string
        format: uuid
      name: company-id
      in: path
      description: Company ID
      required: true
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Search Drivers based on the current Dispatch results
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Driver-Read-Typeahead'
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/ModelError'
      operationId: get-v1-companies-company-id-drivers-faceted_search
      description: Searches `Drivers` in a typeahead style but instead of all `Drivers` for a `Company` this returns all `Drivers` that are associated to the dispatch list, where the dispatch list is defined by the `filter` and `search` inputs that belong to a `Company`.
      parameters:
      - $ref: '#/components/parameters/filter-job-company_ids'
      - $ref: '#/components/parameters/filter-job-customer_account_ids'
      - $ref: '#/components/parameters/filter-dispatch_number_ids'
      - $ref: '#/components/parameters/filter-job-driver_ids'
      - $ref: '#/components/parameters/filter-job-dropoff_site_ids'
      - $ref: '#/components/parameters/filter-job-end_date'
      - $ref: '#/components/parameters/filter-job-equipment_ids'
      - $ref: '#/components/parameters/filter-job-external_ids'
      - $ref: '#/components/parameters/filter-job-material_ids'
      - $ref: '#/components/parameters/filter-job-pickup_site_ids'
      - $ref: '#/components/parameters/filter-job-project_ids'
      - $ref: '#/components/parameters/filter-job-service_ids'
      - $ref: '#/components/parameters/filter-job-site_types'
      - $ref: '#/components/parameters/filter-job-start_date'
      - $ref: '#/components/parameters/filter-job-states'
      - $ref: '#/components/parameters/filter-job-vendor_account_ids'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/facet-search-query'
      tags:
      - Typeaheads
      x-internal: false
      x-stoplight:
        id: fkv07ysacff6n
  /v1/companies/{company-id}/equipment/typeahead:
    parameters:
    - schema:
        type: string
      name: company-id
      in: path
      required: true
      description: Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on Equipment for a Company
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Equipment-Read-Typeahead'
                required:
                - data
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
      operationId: get-v1-companies-company-id-equipment-typeahead
      description: Typeahead search against the `name` property on `Equipment` for a `Company`.
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
      - $ref: '#/components/parameters/filter-dispatchable'
      - $ref: '#/components/parameters/filter-shared'
      - $ref: '#/components/parameters/filter-equipment_type_ids'
      - $ref: '#/components/parameters/filter-sender_company_ids'
      x-stoplight:
        id: 6u9sp57komhev
      x-internal: true
  /v1/companies/{company-id}/equipment_types/typeahead:
    parameters:
    - schema:
        type: string
      name: company-id
      in: path
      required: true
      description: Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on EquipmentType for a Company
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    x-stoplight:
                      id: 1y8kgt70w518v
                    items:
                      $ref: '#/components/schemas/EquipmentType-Read-Typeahead'
                required:
                - data
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
      operationId: get-v1-companies-company-id-equipment_types-typeahead
      x-stoplight:
        id: jkeh212xqgfp8
      description: Typeahead search against the `name` property on `EquipmentType` for a `Company`.
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
      x-internal: true
  /v1/companies/{company-id}/foremen/faceted_search:
    parameters:
    - schema:
        type: string
        format: uuid
      name: company-id
      in: path
      required: true
      description: Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Search Foremen based on the current Dispatch results
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Foreman-Read-Typeahead'
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/ModelError'
      operationId: get-v1-companies-company-id-foremen-faceted_search
      x-stoplight:
        id: fhl714kxau0z2
      description: Searches `Foremen` in a typeahead style but instead of all `Foremen` for a `Company` this returns all `Foremen` that are associated to the dispatch list, where the dispatch list is defined by the `filter` and `search` inputs that belong to a `Company`.
      parameters:
      - $ref: '#/components/parameters/filter-job-company_ids'
      - $ref: '#/components/parameters/filter-job-customer_account_ids'
      - $ref: '#/components/parameters/filter-dispatch_number_ids'
      - $ref: '#/components/parameters/filter-job-driver_ids'
      - $ref: '#/components/parameters/filter-job-dropoff_site_ids'
      - $ref: '#/components/parameters/filter-job-end_date'
      - $ref: '#/components/parameters/filter-job-equipment_ids'
      - $ref: '#/components/parameters/filter-job-external_ids'
      - $ref: '#/components/parameters/filter-job-material_ids'
      - $ref: '#/components/parameters/filter-job-pickup_site_ids'
      - $ref: '#/components/parameters/filter-job-project_ids'
      - $ref: '#/components/parameters/filter-job-service_ids'
      - $ref: '#/components/parameters/filter-job-site_types'
      - $ref: '#/components/parameters/filter-job-start_date'
      - $ref: '#/components/parameters/filter-job-states'
      - $ref: '#/components/parameters/filter-job-vendor_account_ids'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/facet-search-query'
  /v1/companies/{company-id}/foremen/typeahead:
    parameters:
    - schema:
        type: string
        format: uuid
      name: company-id
      in: path
      required: true
      description: Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on Foremen
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    x-stoplight:
                      id: 4zf8dir5org9i
                    items:
                      $ref: '#/components/schemas/Foreman-Read-Typeahead'
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
      operationId: get-v1-companies-company-id-foremen-typeahead
      x-stoplight:
        id: shsf9yvsfoan9
      description: 'Typeahead search against the `first_name` and `last_name` property on `Foremen` for a `Company`.

        '
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
      - $ref: '#/components/parameters/filter-shared'
      - $ref: '#/components/parameters/filter-expiring'
      - $ref: '#/components/parameters/filter-sender_company_types'
  /v1/companies/{company-id}/fuel_price_indices/typeahead:
    parameters:
    - schema:
        type: string
        format: uuid
      name: company-id
      in: path
      required: true
      description: Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on FuelPriceIndex for a Company
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    x-stoplight:
                      id: 95bnj47nk3rv3
                    type: array
                    items:
                      $ref: '#/components/schemas/FuelPriceIndex-Read-Typeahead'
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
      operationId: get-v1-companies-company-id-fuel_price_indices-typeahead
      x-stoplight:
        id: 0aigw051bke6i
      description: Typeahead search against the `name` property on `FuelPriceIndex` for a `Company`.
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
  /v1/companies/{company-id}/jobs/typeahead:
    parameters:
    - schema:
        type: string
        format: uuid
      name: company-id
      in: path
      required: true
      description: Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on Jobs by Company
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Job-Read-Typeahead'
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
      operationId: get-v1-companies-company-id-jobs-typeahead
      x-stoplight:
        id: jobbypahead01
      description: Typeahead search against the `job_id` property for `Jobs` visible to the currently authenticated `Company`.
      x-internal: true
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
  /v1/companies/{company-id}/loads/typeahead:
    parameters:
    - schema:
        type: string
        format: uuid
      name: company-id
      in: path
      required: true
      description: Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on Loads by Company
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Load-Read-Typeahead'
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '404':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
      operationId: get-v1-companies-company-id-loads-typeahead
      x-stoplight:
        id: loadtypahead01
      description: Typeahead search against the `load_id` property for `Loads` visible to the currently authenticated `Company`.
      x-internal: true
      parameters:
      - $ref: '#/components/parameters/page-limit'
      - $ref: '#/components/parameters/page-after'
      - $ref: '#/components/parameters/page-before'
      - $ref: '#/components/parameters/search-query'
  /v1/companies/{company-id}/managed_companies/{managed-company-id}/drivers/typeahead:
    parameters:
    - schema:
        type: string
      name: company-id
      in: path
      required: true
      description: Managing Company ID
    - schema:
        type: string
      name: managed-company-id
      in: path
      required: true
      description: Managed Company ID
    - $ref: '#/components/parameters/Accept-Language'
    get:
      summary: Typeahead search on Drivers for a Managed Company
      tags:
      - Typeaheads
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
              description: Contains prev and next links for pagination
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 

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