Skip to main content
GET
/
v1
/
companies
/
{company-id}
/
company_shares
Retrieve CompanyShares for a Company
curl --request GET \
  --url https://api.tread-horizon.com/v1/companies/{company-id}/company_shares \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "parent_company_share_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_shareable_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "receiver_company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tread_id": "ABC123",
        "legal_name": "<string>",
        "company_type": "hauler"
      },
      "company_shareable": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ]
}

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[sender_company_id]
string<uuid>

Sender Company ID

​
filter[receiver_company_id]
string<uuid>

Receiver Company ID

​
filter[between_company_id]
string<uuid>

Between Company ID

​
filter[company_shareable_type]
enum<string>

Company Shareable Type

Available options:
User,
Equipment,
Site
​
filter[company_shareable_id]
string<uuid>

Company Shareable ID

Response

OK

​
data
CompanyShare-Read · object[]
required