FUfullpath
shoppers

List shoppers

Returns a paginated list of shoppers. Supports exact matching via the q query parameter for email or phone.

Additional fields can be included in the response using the embed parameter. Available embed options:

  • primary_contact - Primary contact information (first_name, last_name, email, phone numbers, address)
  • latest_lead_date - Date of the latest lead (YYYY-MM-DD)
  • latest_sale_date - Date of the latest sale (YYYY-MM-DD)
  • latest_sale - Latest sale information
  • latest_lead - Latest lead information including vehicle details
  • adf_leads - Array of ADF leads
  • latest_marketing_touchpoint_date - Date of the latest marketing touchpoint (YYYY-MM-DD)
  • marketing_engagement_score - Marketing engagement score
  • loyalty_score - Loyalty score

Multiple embed options can be specified as a comma-separated list, e.g., embed=primary_contact,latest_lead_date,latest_lead.

get/dealerships/{dealershipId}/shoppers

Request

Path parameters

dealershipIdinteger required

Dealership identifier (integer)

Query parameters

qstring

Exact match query for email address or phone number (E.164 format)

embedstring

Comma-separated list of fields to embed in the response. Available options: primary_contact, latest_lead_date, latest_sale_date, latest_sale, latest_lead, adf_leads, latest_marketing_touchpoint_date, marketing_engagement_score, loyalty_score

pageinteger

Page number (1-based)

per_pageinteger

Number of items per page

sortstring

Sort order (comma-separated field names with optional - prefix for descending, e.g., -created_at)

Response

A paginated list of shoppers

Example response

{
  "data": [
    {
      "id": 16395039,
      "primary_contact": {
        "source": "customer",
        "first_name": "John",
        "last_name": "Doe",
        "full_name": "John Doe",
        "main_email_addresses": "john.doe@example.com",
        "cell_phone": "+15555551234",
        "home_phone": "+15555551235",
        "city": "Anytown",
        "state": "NY",
        "zipcode": "12345",
        "timestamp": "2024-01-15T10:30:00Z",
        "email": "john.doe@example.com",
        "full_address": "Anytown, NY, 12345"
      },
      "latest_lead_date": "2024-01-15",
      "latest_marketing_touchpoint_date": "2024-01-15",
      "latest_lead": {
        "id": "1234567890",
        "salesperson": "Jane Smith",
        "date": "2024-01-15",
        "up_type": "Internet",
        "source": "Website - Contact Form",
        "status": "Bad",
        "sub_status": "Duplicate lead",
        "vehicle": {
          "vin": "1HGBH41JXMN109186",
          "condition": "new",
          "year": "2024",
          "make": "Toyota",
          "model": "Camry",
          "trim": "LE"
        }
      },
      "adf_leads": [],
      "marketing_engagement_score": "10",
      "loyalty_score": "0",
      "contacts": [
        {
          "source": "crm_customer",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "main_email_addresses": "john.doe@example.com",
          "cell_phone": "+15555551234",
          "home_phone": "+15555551235",
          "city": "Anytown",
          "state": "NY",
          "zipcode": "12345",
          "timestamp": "2024-01-15T10:30:00Z",
          "status": "Active",
          "crm_link": "https://example.com/crm/customer/123456",
          "creation_date": "2024-01-15",
          "external_customer_id": "EXT123456"
        }
      ],
      "location": {
        "title": "Anytown, NY, 12345",
        "city": "Anytown",
        "state": "NY",
        "zipcode": "12345",
        "source": "customer"
      },
      "score": 10,
      "public_link": "https://example.com/s/abc123xyz",
      "customer_tags": [],
      "is_enriched": true,
      "salesperson": "Jane Smith",
      "group_shopper_id": "GRP123456789",
      "financial_durability_index": 8.46,
      "aim_propensity_score": 2.54
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.