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 Projects API

The Projects API from tread.io — 10 operation(s) for projects.

tread.io Projects 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 Project. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 10 paths, and defines 71 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.

13 operations 10 paths 71 schemas 1 DELETE8 GET1 PATCH1 POST2 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 Projects API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 1 DELETE, 8 GET, 1 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Projects 13
GET
/v1/companies/{company-id}/projects
Retrieve Projects that belong to a Company
get-v1-companies-company-id-projects 20 params → 200401404406
GET
/v1/companies/{company-id}/projects/salesperson
Retrieve Projects where the current User is a Salesperson
get-v1-companies-company-id-projects-salesperson 5 params → 200401404406
GET
/v1/companies/{company-id}/projects/typeahead
Typeahead search on Projects for a Company
get-v1-companies-company-id-projects-typeahead 9 params → 200401404406
POST
/v1/projects
Create a Project in the current Company
post-v1-projects 1 param body → 201400401403406415422
GET
/v1/projects
Retrieve Projects that belong to the current Company
get-v1-projects 18 params → 200401406
GET
/v1/projects/external_ids/typeahead
Typeahead search on Projects for a Company
get-v1-projects-external_ids-typeahead 7 params → 200401404406
GET
/v1/projects/typeahead
Typeahead search on Projects
get-v1-projects-typeahead 8 params → 200401406
GET
/v1/projects/{id}
Retrieve Project
get-v1-projects-id 2 params → 200401404406
PATCH
/v1/projects/{id}
Update Project
patch-v1-projects-id 2 params body → 200400401403406415422
DELETE
/v1/projects/{id}
Delete Project
delete-v1-projects-id 2 params → 204401403404406422
PUT
/v1/projects/{project-id}/activate
Activate a Project
put-v1-projects-project-id-activate 2 params body → 200400401403404406409415
PUT
/v1/projects/{project-id}/deactivate
Deactivate a Project
put-v1-projects-project-id-deactivate 2 params body → 200400401403404406409415
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

Schemas 71

The contract defines 71 schemas that model the data the API accepts and returns. The most detailed are Project-Create (59 properties), Project-Update (56 properties), Account-Create (15 properties), Address-Create (9 properties). Each schema is shown below with its type and property counts.

Foreman-Read-Nested
DispatchNumber-Read-Nested
Contact-Update
object
3 properties
EquipmentType-Read-Nested
object
5 properties 5 required
RateCommission-Read-Nested
Destroyable
object
2 properties
DispatchNumber-Update
object
2 properties
Address-Create
object
9 properties 5 required
AccountType
ModelError-Response
object
1 property 1 required
Geofence-Data
object
5 properties
Phase-Read
NullableRateType
stringnull
Account-Create
object
15 properties 3 required
RateType
Phase-Create
object
3 properties 1 required
ProjectState
CompanyType
Company Type
OrderUnitOfMeasure
Project-Create
object
59 properties 1 required
DispatchNumber-Create
object
1 property 1 required
RateTime-Read-Nested
ProjectMaterialTotal-Create
object
3 properties 1 required
UnauthenticatedError-Response
object
1 property 1 required
Phase-Update
Company-Read-Nested
Compact Company model for nested reads.
ServiceClass-Read-Nested
User-Read-Nested
NullableGeofenceType
stringnull
StateError-Item
GeofenceTag
RateFlatRate-Read-Nested
Contact-Create
object
3 properties
Contact-Update-Destroyable
StateError
Material-Read-Nested
object
3 properties 3 required
Address-Read
object
9 properties 9 required
TreadId
object
1 property 1 required
Foreman-Read-Typeahead
ModelError-Item
object
3 properties 3 required
Site-Read-Nested
Contact-Read-Nested
Account-Read-Nested
WaypointType
Project-Read-Typeahead-External-Id
object
1 property
UnauthenticatedError
Identifier
object
1 property 1 required
Discardable
object
1 property 1 required
Waypoint-Read-Nested
NextBillionGeofence-Read
User-Read-Typeahead
StateError-Response
object
1 property 1 required
Project-Update
object
Update model for Project
56 properties
Project-Read
Read model for Project
Timestamps
object
2 properties 2 required
Waypoint-Update-Destroyable
ProjectMaterialTotal-Update
NullableOrderUnitOfMeasure
stringnull
RatePerUnit-Read-Nested
Project-Read-Typeahead
GeofenceType
Error
object
An Error.
1 property 1 required
Address-Read-Nested
RateFlatCommission-Read-Nested
Department-Read-Nested
ModelError
A Model-specific error
Error-Response
object
1 property 1 required
Service-Read-Nested
CompanyShare-Read-Nested
Waypoint-Create
object
4 properties 3 required
ProjectMaterialTotal-Read

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

treadio-projects-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 Projects 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.