Get a carrier

{
  "id": "car_00000000-0000-0000-0000-000000000000",
  "name": "string",
  "mc_number": "string",
  "dot_number": "string",
  "email": "string",
  "phone": "string",
  "dispatcher_name": "string",
  "dispatcher_phone": "string",
  "dispatcher_email": "string",
  "is_active": true,
  "provider": "string",
  "ingestion_method": "string",
  "equipment_types": [
    "VAN"
  ],
  "insurance_expiration": "2024-01-15T09:30:00Z",
  "w9_on_file": true,
  "authorized_for_hire": true,
  "on_time_pickup_pct": 1.1,
  "on_time_delivery_pct": 1.1,
  "tracking_compliance_pct": 1.1,
  "avg_response_time_min": 1.1,
  "total_loads_hauled": 1,
  "is_onboarded": false,
  "carrier_rep_user_id": "usr_00000000-0000-0000-0000-000000000000",
  "carrier_rep_name": "string",
  "carrier_rep_email": "string",
  "is_verified": false,
  "verified_date": "2024-01-15T09:30:00Z",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z"
}

Get a carrier by ID.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

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

Path parameters

carrier_idstringRequiredformat: "uuid"

Response

Successful Response

idstringformat: "^car_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

namestring

mc_numberstring or nullOptional

dot_numberstring or nullOptional

emailstring or nullOptional

phonestring or nullOptional

dispatcher_namestring or nullOptional

dispatcher_phonestring or nullOptional

dispatcher_emailstring or nullOptional

is_activebooleanOptionalDefaults to true

providerstring or nullOptional

ingestion_methodstring or nullOptional

equipment_typeslist of enums or nullOptional

insurance_expirationdatetime or nullOptional

w9_on_fileboolean or nullOptional

authorized_for_hireboolean or nullOptional

on_time_pickup_pctdouble or nullOptional

on_time_delivery_pctdouble or nullOptional

tracking_compliance_pctdouble or nullOptional

avg_response_time_mindouble or nullOptional

total_loads_hauledinteger or nullOptional

is_onboardedbooleanOptionalDefaults to false

carrier_rep_user_idstringOptionalformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

carrier_rep_namestring or nullOptional

carrier_rep_emailstring or nullOptional

is_verifiedbooleanOptionalDefaults to false

verified_datedatetime or nullOptional

created_atdatetime or nullOptional

updated_atdatetime or nullOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

$	curl https://tryenvoy.ai/api/v1/carriers/carrier_id \
>	-H "Authorization: Bearer <token>"

Authentication

Path parameters

Headers

Response

Errors