EndpointsLane Preferences

List a carrier's lane preferences

Return every CarrierLanePreferenceH3 row for the given carrier, joined with its Lane row so origin/destination city+state come back inline. Filter with `is_active=false` to pull only disabled lanes (the re-enable surface on the carrier detail page). Admin-only — the response is what the PATCH toggle endpoint modifies, so viewing is gated the same way as editing. **Authentication:** Bearer token required.

Authentication

AuthorizationBearer

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

Path parameters

carrier_idstringRequiredformat: "uuid"

Headers

X-Organization-IDstring or nullOptional

Query parameters

is_activeboolean or nullOptional

Filter by is_active (omit for all)

limitintegerOptional1-2000Defaults to 500

Max rows returned (1..2000, default 500)

Response

Successful Response
idstringformat: "uuid"
carrier_idstringformat: "uuid"
lane_idstringformat: "uuid"
is_activeboolean
preference_typestring
updated_atdatetime or null
origin_citystring or null
origin_statestring or null
destination_citystring or null
destination_statestring or null

Errors

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