Skip to main content
GET
/
v1
/
companies
/
{company-id}
/
foremen
Retrieve Foremen for a Company
curl --request GET \
  --url https://api.tread-horizon.com/v1/companies/{company-id}/foremen \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tread_id": "ABC123",
        "legal_name": "<string>",
        "company_type": "hauler"
      },
      "discarded_at": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "time_zone": "America/New_York",
      "managed": true,
      "labels": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "color": "<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"
      }
    }
  ]
}

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

​
filter[shared]
boolean

Filter shared CompanyShareable models

​
search[datagrid]
string

Search string for datagrid queries

​
filter[expiring]
boolean

Filter based on record expiry. Default is null, which means all records are returned, true will omit non-expiring records, false will omit expiring records.

​
filter[sender_company_types]
array

CompanyType enum filter. See CompanyType enum for accepted values.

Response

OK

​
data
Foreman-Read · object[]
required