Get an offer

{
  "id": "ofr_00000000-0000-0000-0000-000000000000",
  "tms_load_id": "string",
  "load_id": "load_00000000-0000-0000-0000-000000000000",
  "offer_amount": 1.1,
  "status": "pending",
  "source": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "carrier_id": "car_00000000-0000-0000-0000-000000000000",
  "contact_id": "con_00000000-0000-0000-0000-000000000000",
  "call_id": "call_00000000-0000-0000-0000-000000000000",
  "email_message_id": "string",
  "notes": "string",
  "created_by_id": "usr_00000000-0000-0000-0000-000000000000",
  "updated_by_id": "usr_00000000-0000-0000-0000-000000000000",
  "load_number": "string",
  "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"
  },
  "contact_name": "string",
  "contact_phone": "string",
  "email_conversation_id": "string",
  "rep_name": "string"
}

Get a specific offer 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

offer_idstringRequiredformat: "uuid"

Response

Successful Response

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

tms_load_idstring

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

offer_amountdouble

statusenum

sourcestring

created_atdatetime

updated_atdatetime

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

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

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

email_message_idstring or nullOptional

notesstring or nullOptional

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

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

load_numberstring or nullOptional

carrierobject or nullOptional

v1 carrier response - wraps domain CarrierModel with prefixed IDs.

contact_namestring or nullOptional

contact_phonestring or nullOptional

email_conversation_idstring or nullOptional

rep_namestring 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/offers/offer_id \
>	-H "Authorization: Bearer <token>"

Authentication

Path parameters

Headers

Response

Errors