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

The Users API from tread.io — 23 operation(s) for users.

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

This API exposes 30 operations across 23 paths, and defines 44 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.

30 operations 23 paths 44 schemas 4 DELETE12 GET2 PATCH6 POST6 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 Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 30

Across 23 paths, the API surfaces 30 operations — 4 DELETE, 12 GET, 2 PATCH, 6 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 30
POST
/v1/companies/{company-id}/managed_companies/{managed-company-id}/users
Create User for a Managed Company
post-v1-companies-company-id-managed_companies-managed-company-id-users 3 params body → 201400401403404406415422
GET
/v1/companies/{company-id}/managed_companies/{managed-company-id}/users
Retrieve Users for a Managed Company
get-v1-companies-company-id-managed_companies-managed-company-id-users 9 params → 200401404406422
GET
/v1/companies/{company-id}/managed_companies/{managed-company-id}/users/typeahead
Typeahead search Users for a Managed Company
get-v1-companies-company-id-managed_companies-managed-company-id-users-typeahead 8 params → 200401404406
GET
/v1/companies/{company-id}/managed_companies/{managed-company-id}/users/{id}
Retrieve User by ID for a Managed Company
get-v1-companies-company-id-managed_companies-managed-company-id-users-id 4 params → 200401404406
PATCH
/v1/companies/{company-id}/managed_companies/{managed-company-id}/users/{id}
Update User for a Managed Company
patch-v1-companies-company-id-managed_companies-managed-company-id-users-id 4 params body → 200400401403404406415422
DELETE
/v1/companies/{company-id}/managed_companies/{managed-company-id}/users/{id}
Delete User for a Managed Company
delete-v1-companies-company-id-managed_companies-managed-company-id-users-id 4 params → 204401403404406422
PUT
/v1/companies/{company-id}/managed_companies/{managed-company-id}/users/{user-id}/invite/email
Send an Email Invite to a User in a Managed Company
put-v1-companies-company-id-managed_companies-managed-company-id-users-user-id-invite-email 4 params body → 202401403404406415422
PUT
/v1/companies/{company-id}/managed_companies/{managed-company-id}/users/{user-id}/invite/sms
Send an SMS Invite to a User in a Managed Company
put-v1-companies-company-id-managed_companies-managed-company-id-users-user-id-invite-sms 4 params body → 202401403404406415422
GET
/v1/companies/{company-id}/users
Retrieve Users that belong to a Company
get-v1-companies-company-id-users 8 params → 200401404406
GET
/v1/companies/{company-id}/users/typeahead
Typeahead search on Users for a Company
get-v1-companies-company-id-users-typeahead 7 params → 200401404406
POST
/v1/users
Create a User
post-v1-users 1 param body → 201400401403406415422
GET
/v1/users
Retrieve Users that belong to the current Company
get-v1-users 8 params → 200401406
GET
/v1/users/me
Retrieve the current User
get-v1-users-me 1 param → 200401406
GET
/v1/users/me/access
Retrieve current User's Access
get-v1-users-me-access 1 param → 200401406
GET
/v1/users/me/iam_permissions
Retrieve Permissions granted to the current User
get-v1-users-me-iam-permissions 1 param → 200401406
POST
/v1/users/me/location
Set Current Location
get-v1-users-me-location 1 param body → 204401404406415422
POST
/v1/users/me/locations
Bulk Create Historical Locations
patch-v1-users-me-location 1 param body → 204401404406415422
GET
/v1/users/typeahead
Typeahead search on Users
get-v1-users-typeahead 6 params → 200401406
GET
/v1/users/{id}
Retrieve User
get-v1-users-id 2 params → 200401404406
PATCH
/v1/users/{id}
Update a User
patch-v1-users-id 2 params body → 200400401403404406415422
DELETE
/v1/users/{id}
Delete a User
delete-v1-users-id 2 params → 204400401403406422
POST
/v1/users/{user-id}/impersonations
Impersonate a User
post-v1-users-user-id-impersonations 2 params → 201401403404406422
PUT
/v1/users/{user-id}/invite/email
Send an Email Invite to a User
put-v1-users-user-id-invite-email 2 params body → 202401403404406415422
PUT
/v1/users/{user-id}/invite/sms
Send an SMS Invite to a User
put-v1-users-user-id-invite-sms 2 params body → 202401403404406415422
POST
/v1/users/{user-id}/scheduled_time_offs
Create Scheduled Time Off
post-v1-users-user-id-scheduled_time_offs 2 params body → 201401403406415422
GET
/v1/users/{user-id}/scheduled_time_offs
Retrieve Scheduled Time Offs for a User
get-v1-users-user-id-scheduled-time-offs 2 params → 200400401404406
PUT
/v1/users/{user-id}/scheduled_time_offs/available
Mark Schedule Available
put-v1-users-user-id-scheduled_time_offs-available 2 params → 202401403404406422
PUT
/v1/users/{user-id}/scheduled_time_offs/unavailable
Mark Schedule Unavailable
put-v1-users-user-id-scheduled_time_offs-unavailable 2 params → 202401403404406422
DELETE
/v1/users/{user-id}/scheduled_time_offs/{id}
Delete a Scheduled Time Off
delete-v1-users-user-id-scheduled_time_offs-id 3 params → 204401403404406422
DELETE
/v1/users/{user-id}/sessions
Revokes all active B2B and B2B sessions for the given User
delete-v1-users-user-id-sessions 2 params body → 204400401403406

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are UserPreference-Notification-Update (14 properties), UserPreference-Notification-Read (14 properties), User-Create (13 properties), GpsLocation-Create (7 properties). Each schema is shown below with its type and property counts.

Scheduled-Time-Off-Read
Scheduled Time Off
UserPreferences-Read
object
1 property
TreadId
object
1 property 1 required
MobileDeviceLocations-Create
object
Record a history of Mobile Device prior locations
2 properties 2 required
StytchMemberStatus
Stytch member status
CompanyType
Company Type
UserPreference-Notification-Update
object
14 properties
EquipmentType-Read-Nested
object
5 properties 5 required
UserPreferences-Update
object
1 property
Error
object
An Error.
1 property 1 required
Equipment-Read-Typeahead
ModelError-Item
object
3 properties 3 required
AccessName
NotificationMethod
User-Update
Scheduled-Time-Off-Create
object
Scheduled Time Off - Create
2 properties 2 required
AuthToken
object
AuthToken model for reads.
1 property 1 required
AutoAddOn-BulkAssign
object
Note: autoaddonaccounttype is required when assigning to an Account
2 properties
UnauthenticatedError
UserPreference-Notification-Read
object
14 properties
SendInvite
object
2 properties
IamPermission-Read-Nested
object
1 property 1 required
Identifier
object
1 property 1 required
Equipment-Read-Nested
User-Read
User model for reads.
ModelError
A Model-specific error
Discardable
object
1 property 1 required
Access-Read
object
1 property 1 required
AccountType
TimeZone
User-Read-Typeahead
UnauthenticatedError-Response
object
1 property 1 required
ModelError-Response
object
1 property 1 required
MobileDeviceLocation-Create
object
Record a Mobile Device's current location
2 properties 2 required
Company-Read-Nested
Compact Company model for nested reads.
User-Create
object
Input parameters for User creation.
13 properties 4 required
User-Read-Nested
Error-Response
object
1 property 1 required
CompanyShare-Read-Nested
Timestamps
object
2 properties 2 required
User-Me-Read
IamRole-Read-Nested
Label-Read-Nested
GpsLocation-Create
object
This model represents a set of data describing a GPS location
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

treadio-users-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 Users 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.