How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

tread.io Sites API

The Sites API from tread.io — 28 operation(s) for sites.

tread.io Sites API is one of 58 APIs that tread.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sites. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 36 operations across 28 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.tread-horizon.com.

36 operations 28 paths 47 schemas 4 DELETE21 GET4 PATCH2 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.tread-horizon.com
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

tread.io Sites API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 36

Across 28 paths, the API surfaces 36 operations — 4 DELETE, 21 GET, 4 PATCH, 2 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Sites 36
GET
/v1/companies/{company-id}/orders/{order-id}/default_sites/{waypoint-type}
Retrieve default sites for an order, given a waypoint type.
get-v1-companies-company-id-orders-order-id-default-sites 7 params → 200401403404406
PUT
/v1/companies/{company-id}/orders/{order-id}/default_sites/{waypoint-type}/{site-id}
Add a site to default site list on order
put-v1-companies-company-id-orders-order-id-default_sites-waypoint-type-site-id 5 params → 200400401403404406422
DELETE
/v1/companies/{company-id}/orders/{order-id}/default_sites/{waypoint-type}/{site-id}
Delete a single site from a default list of an order.
delete-v1-companies-company-id-orders-order-id-default_sites-waypoint-type-site-id 5 params → 204400401403404406
GET
/v1/companies/{company-id}/orders/{order-id}/sites/typeahead
Typeahead search on Sites that belong to Order's Company
get-v1-companies-company-id-orders-order-id-sites-typeahead 8 params → 200401404406422
GET
/v1/companies/{company-id}/sites
Retrieve Sites that belong to a Company
get-v1-companies-company-id-sites 9 params → 200401404406
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-index 24 params → 200401404406422
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-dispatch-typeahead 24 params → 200401404406422
GET
/v1/companies/{company-id}/sites/typeahead
Typeahead search on Sites for a Company
get-v1-companies-company-id-site-typeahead 8 params → 200401404406422
GET
/v1/companies/{company-id}/sites/{id}
Retrieve a single Site for a Company
get-v1-companies-company-id-sites-id 3 params → 200401404406
GET
/v1/companies/{company-id}/sites/{site-id}/additional_geofences
Retrieve additional geofences for a Site
get-v1-companies-company-id-sites-site_id-additional_geofences 6 params → 200401404406
GET
/v1/companies/{company-id}/sites/{site-id}/contacts
Retrieve Contacts for a Site within a Company
get-v1-companies-company-id-sites-site-id-contacts 6 params → 200401404406422
GET
/v1/companies/{company-id}/sites/{site-id}/stats
Retrieve SiteEquipmentStats for given Site
get-v1-companies-company-id-site-id-stats 3 params → 200401404406
GET
/v1/orders/{order-id}/default_sites/{waypoint-type}deprecated
Retrieve default sites for an order, given a waypoint type.
get-v1-orders-order-id-default-sites 6 params → 200401403404406
PUT
/v1/orders/{order-id}/default_sites/{waypoint-type}/{site-id}deprecated
Add a site to default site list on order
put-v1-orders-order-id-default_sites-waypoint-type-site-id 4 params → 200400401403404406422
DELETE
/v1/orders/{order-id}/default_sites/{waypoint-type}/{site-id}deprecated
Delete a single site from a default list of an order.
delete-v1-orders-order-id-default_sites-waypoint-type-site-id 4 params → 204400401403404406
GET
/v1/orders/{order-id}/sites/typeaheaddeprecated
Typeahead search on Sites that belong to Order's Company
get-v1-orders-order-id-sites-typeahead 7 params → 200401404406422
GET
/v1/projects/{project-id}/default_sites/{waypoint-type}
Retrieve default sites for a project, given a waypoint type.
get-v1-projects-project-id-default-sites 6 params → 200401403404406
PUT
/v1/projects/{project-id}/default_sites/{waypoint-type}/{site-id}
Add a site to default site list on order
put-v1-projects-project-id-default_sites-waypoint-type-site-id 4 params → 200400401403404406422
DELETE
/v1/projects/{project-id}/default_sites/{waypoint-type}/{site-id}
Delete a single site from a default list of an order.
delete-v1-projects-project-id-default_sites-waypoint-type-site-id 4 params → 204400401403404406
POST
/v1/sites
Create a new Site
post-v1-sites 1 param body → 201400401403406415422
GET
/v1/sites
Retrieve Sites that belong to the current Company
get-v1-sites 7 params → 200401406
GET
/v1/sites/dispatch
Retrieve Sites based on the current Dispatch results
get-v1-sites-dispatch-index 23 params → 200401406422
GET
/v1/sites/dispatch/typeahead
Retrieve Sites based on the current Dispatch results
get-v1-sites-dispatch 23 params → 200401406422
GET
/v1/sites/typeahead
Typeahead search on Sites
get-v1-sites-typeahead 6 params → 200401406422
GET
/v1/sites/{id}deprecated
Retrieve a single Site
get-v1-sites-id 2 params → 200401404406
PATCH
/v1/sites/{id}
Update a Site
patch-v1-sites-id 2 params body → 200400401403404406415422
DELETE
/v1/sites/{id}
Delete a Site by ID
delete-v1-sites-id 2 params → 204401403404406422
PUT
/v1/sites/{site-id}/activate
Activate a Site
put-v1-sites-site-id-activate 2 params body → 200400401403404406409415
POST
/v1/sites/{site-id}/additional_geofences
Create an Additional Geofence for a Site
post-v1-sites-site_id-additional_geofences 2 params body → 201400401403404406415422
GET
/v1/sites/{site-id}/additional_geofencesdeprecated
Retrieve additional geofences for a Site
get-v1-sites-site_id-additional_geofences 5 params → 200401404406
PATCH
/v1/sites/{site-id}/additional_geofences/bulk_assign
Bulk assign Additional Geofences for a Site
patch-v1-sites-site_id-additional_geofences-bulk_assign 2 params body → 200400401403404406415422
GET
/v1/sites/{site-id}/additional_geofences/{id}
Retrieve an Additional Geofence by ID
get-v1-sites-site_id-additional_geofences-id 3 params → 200401404406
PATCH
/v1/sites/{site-id}/additional_geofences/{id}
Update an Additional Geofence for a Site
patch-v1-sites-site_id-additional_geofences-id 3 params body → 200400401403404406415422
GET
/v1/sites/{site-id}/contactsdeprecated
Retrieve Contacts for a Site
get-v1-sites-site-id-contacts 5 params → 200401404406422
PATCH
/v1/sites/{site-id}/contacts/bulk_assign
Assign Contacts for a Site
patch-v1-sites-site-id-contacts-bulk_assign 2 params body → 202401403404406415422
PUT
/v1/sites/{site-id}/deactivate
Deactivate a Site
put-v1-sites-site-id-deactivate 2 params body → 200400401403404406409415

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are Site-Create (13 properties), Site-Update (11 properties), Address-Update (10 properties), Address-Read (9 properties). Each schema is shown below with its type and property counts.

Contact-Update
object
3 properties
Destroyable
object
2 properties
Site-Read
Address-Create
object
9 properties 5 required
ModelError-Response
object
1 property 1 required
Geofence-Data
object
5 properties
MovingSite-Update-Destroyable
CompanyType
Company Type
SiteType
UnauthenticatedError-Response
object
1 property 1 required
ContactBulkAssign-Create
object
1 property
Company-Read-Nested
Compact Company model for nested reads.
MovingSite-Create
object
2 properties 1 required
NullableGeofenceType
stringnull
StateError-Item
GeofenceTag
SiteEquipmentStats-Read
SiteState
Contact-Create
object
3 properties
Contact-Update-Destroyable
StateError
Address-Read
object
9 properties 9 required
TreadId
object
1 property 1 required
Address-Update-Destroyable
ModelError-Item
object
3 properties 3 required
Site-Create
object
13 properties 3 required
Site-Read-Nested
Contact-Read-Nested
UnauthenticatedError
Site-Update
object
11 properties
Identifier
object
1 property 1 required
Discardable
object
1 property 1 required
NextBillionGeofence-Read
StateError-Response
object
1 property 1 required
Timestamps
object
2 properties 2 required
NextBillionGeofence-Create
GeofenceType
Error
object
An Error.
1 property 1 required
Address-Update
object
10 properties
MovingSite-Read
Address-Read-Nested
Department-Read-Nested
Site-Read-Typeahead
ModelError
A Model-specific error
NextBillionGeofence-Update
Error-Response
object
1 property 1 required
CompanyShare-Read-Nested

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

treadio-sites-api-openapi.yml Raw ↑

Other APIs tread.io publishes across the network.

tread.io AccountExternalTruckIdentifier API
tread.io Accounts API
tread.io AddOnCharges API
tread.io AddOns API
tread.io Agave API
tread.io ApprovalAssignments API
tread.io Authentication API
tread.io AutoAddOnAssignments API
tread.io Companies API
tread.io CompanyDayJobStats API
tread.io CompanyShares API
tread.io Compliance API
Where this information came from

This is an independent, third-party profile of tread.io Sites API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.