Get an outreach record

{
  "id": "otr_00000000-0000-0000-0000-000000000000",
  "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,
    "tms_status": "string",
    "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,
    "routing_guide_tier": 1,
    "lane_routing_guide_tier": 1,
    "effective_routing_guide_tier": 1,
    "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",
    "compliance_status": "PASSED",
    "stop_contact_requested_at": "2024-01-15T09:30:00Z",
    "tms_carrier_id": "string",
    "last_verified_at": "2024-01-15T09:30:00Z",
    "last_verified_provider": "string",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z"
  },
  "load_id": "load_00000000-0000-0000-0000-000000000000",
  "modality": "call",
  "direction": "outbound",
  "created_at": "2024-01-15T09:30:00Z",
  "load_number": "string",
  "status": "completed",
  "error_reason": "string",
  "delivery_failed_at": "2024-01-15T09:30:00Z",
  "delivery_failure_reason": "string",
  "carrier_engaged": true,
  "is_automated": false,
  "call_id": "call_00000000-0000-0000-0000-000000000000",
  "conversation_id": "string"
}

Retrieve a single outreach record by ID with carrier and load details.

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

outreach_idstringRequiredformat: "uuid"

Response

Successful Response

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

carrierobject

v1 carrier response - wraps domain CarrierModel with prefixed IDs.

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

modalityenum

Communication channel: call, email, or whatsapp

Allowed values:

directionenum

Direction: inbound or outbound

Allowed values:

created_atdatetime

load_numberstring or nullOptional

statusenumOptionalDefaults to completed

Async-execution lifecycle. Outbound outreaches initiated via the async path move pending → active → completed|failed; inbound and legacy sync paths are written as completed.

Allowed values:

error_reasonstring or nullOptional

Terminal failure detail when status=‘failed’

delivery_failed_atdatetime or nullOptional

When this outreach’s email bounced back undelivered, if it did. Independent of status, which stays ‘completed’ on a bounce because the SEND succeeded — the failure happened afterwards, at the recipient’s mail server. A client showing outreach state must treat a non-null value here as a failure regardless of status, or it will report a delivered email that never arrived.

delivery_failure_reasonstring or nullOptional

Human-readable bounce reason paired with delivery_failed_at (e.g. ‘mailbox does not exist’). Distinct from error_reason, which describes a send that never left.

carrier_engagedboolean or nullOptional

is_automatedbooleanOptionalDefaults to false

True if initiated by the automated outreach worker (the AI agent), not a manual rep action.

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

conversation_idstring or nullOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

Authentication

Path parameters

Headers

Response

Errors