Skip to navigation

Tab counts for the loads list

Returns per-tab badge counts for the loads list view. Honors the same filter set as GET /loads so the badges reflect what each tab would show under the user’s current filters.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Organization-IDstring or nullOptional

Query parameters

searchstring or nullOptional
statuslist of enums or nullOptional
tms_statuslist of strings or nullOptional

Case-insensitive exact filter by raw status received from the source TMS

is_postedboolean or nullOptional
Filter by Envoy's internal posted state
modelist of enums or nullOptional
equipment_typelist of enums or nullOptional
customer_namelist of strings or nullOptional
carrier_rep_namelist of strings or nullOptional

Case-insensitive filter by assigned Envoy rep or source-TMS sales rep name. Repeat the parameter to match any selected rep.

origin_citystring or nullOptional

Substring match on origin stop city (ILIKE)

destination_citystring or nullOptional

Substring match on destination stop city (ILIKE)

pickup_date_fromdate or nullOptional
pickup_date_todate or nullOptional
delivery_date_fromdate or nullOptional
delivery_date_todate or nullOptional
created_at_fromdate or nullOptional
Inclusive load ingestion date
created_at_todate or nullOptional
Inclusive load ingestion date
updated_at_fromdate or nullOptional

Inclusive load last-updated date

updated_at_todate or nullOptional

Inclusive load last-updated date

last_posted_at_fromdate or nullOptional

Earliest UTC calendar day (inclusive) on which Envoy’s posted flag last turned on

last_posted_at_todate or nullOptional

Latest UTC calendar day (inclusive) on which Envoy’s posted flag last turned on

distance_mindouble or nullOptional>=0
distance_maxdouble or nullOptional>=0
posted_rate_mininteger or nullOptional>=0
posted_rate_maxinteger or nullOptional>=0
view_idstring or nullOptionalformat: "uuid"

A saved load view to apply (ENG-2112). Its filters stack under the inline ones: both narrow, neither widens. 404 when the view is not visible to the caller.

Response

Successful Response
allinteger>=0
All loads matching the current filters
active_notificationsinteger>=0
Loads with at least one unread notification for the current user
active_outreachesinteger>=0
Loads with outreach activity and no accepted offer yet
all_callsinteger>=0
Loads with at least one phone call, regardless of status
failed_verificationsinteger>=0

Loads with at least one failed carrier_verifications row recorded against them

active_escalationsinteger>=0

Loads with at least one ACTIVE escalation awaiting a human response. Scheduling escalations (appointment management) are not counted.

active_offersinteger>=0
Loads with at least one pending offer

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error