Skip to main content
GET
/
v1
/
materials
Retrieve Materials that belong to the current Company
curl --request GET \
  --url https://api.tread-horizon.com/v1/materials \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "system": true,
      "company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tread_id": "ABC123",
        "legal_name": "<string>",
        "company_type": "hauler"
      },
      "material_type": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "system": true
      },
      "state": "active",
      "external_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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"

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[datagrid]
string

Search string for datagrid queries

Response

OK

​
data
Material-Read · object[]
required