Skip to main content
GET
/
v1
/
companies
/
{company-id}
/
material_rates
/
typeahead
Typeahead search on MaterialRates for a Company
curl --request GET \
  --url https://api.tread-horizon.com/v1/companies/{company-id}/material_rates/typeahead \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sell_price": "<string>",
      "buy_price": "<string>",
      "unit_of_measure": "Load",
      "site": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "external_id": "<string>",
        "company_share": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_id": "<string>",
          "ticket_match_id": "<string>",
          "sender_company": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "tread_id": "ABC123",
            "legal_name": "<string>",
            "company_type": "hauler"
          },
          "dispatchable": true,
          "schedule_on": true,
          "rate_override": true,
          "expires_at": "2023-11-07T05:31:56Z"
        }
      },
      "material": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "external_id": "<string>"
      },
      "project": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "external_id": "<string>"
      },
      "customer_account": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "schedule_on": true,
        "connected_company": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Path Parameters

​
company-id
string<uuid>
required

Company ID

Query Parameters

​
page[limit]
integer<int32>
default:25

The maximum number of paginated results to return

Required range: x <= 100
​
page[after]
string

The cursor to start paginating after

​
page[before]
string

The cursor to stop paginating at

​
search[site][query]
string

Search string for queries on Site

​
filter[customer_account_id]
string<uuid>

The associated Customer Account ID

​
filter[project_id]
string

Project ID filter

​
filter[material_id]
string<uuid>

The associated Material ID

​
filter[site_id]
string<uuid>

The associated Site ID

Response

OK

​
data
MaterialRate-Read-Typeahead · object[]
required