Lead Pull

Pull mortgage leads assigned to your partner account. Each request returns leads in the states configured for your account, with the questions covered for that account.

The states included and the questions covered are configurable. To change either, contact [email protected].

Access

Base URL: https://api.mashvisor.com

MethodGET
Endpoint/v1.1/client/mortgage/leads

Send the API key issued for your partner account in the x-api-key header. This key authenticates the lead pull endpoint.

Each request counts toward a limit of 10,000 requests per month, measured in UTC. When that limit is reached, further requests are rejected until the next UTC month.


GET/v1.1/client/mortgage/leads

List leads

Returns leads created in the requested window. Results are ordered by creation time. Pass after_id from the previous page to continue.

A lead is included only when its state is one of the states configured for your account. Each lead's questions array includes the questions covered for your account.

Query parameters

  • Name
    from
    Type
    string
    Description

    Inclusive lower bound on createdAt. UTC ISO 8601, for example 2026-10-12T00:00:00Z. A date-only value such as 2026-10-12 is treated as the start of that UTC day. Values earlier than 2026-10-12T00:00:00Z, and requests that omit this parameter, are treated as that minimum.

  • Name
    to
    Type
    string
    Description

    Inclusive upper bound on createdAt. UTC ISO 8601, for example 2026-10-27T23:59:59Z. A date-only value such as 2026-10-27 is treated as the end of that UTC day (23:59:59). Must be on or after 2026-10-12T00:00:00Z.

  • Name
    after_id
    Type
    integer
    Description

    Exclusive cursor. Returns leads whose id is greater than this value. Use pagination.nextAfterId from the previous response.

  • Name
    limit
    Type
    integer
    Description

    Page size. Default: 100. Maximum: 500.

Lead fields

  • Name
    id
    Type
    integer
    Description

    Lead id. Use the last id on a full page as after_id for the next request.

  • Name
    name
    Type
    string
    Description

    Lead name.

  • Name
    email
    Type
    string
    Description

    Lead email.

  • Name
    phone
    Type
    string
    Description

    Lead phone number.

  • Name
    address
    Type
    string
    Description

    Property street address.

  • Name
    city
    Type
    string
    Description

    Property city.

  • Name
    state
    Type
    string
    Description

    Two-letter state code.

  • Name
    zipcode
    Type
    string
    Description

    Property ZIP code.

  • Name
    propertyType
    Type
    string
    Description

    Property type.

  • Name
    price
    Type
    integer
    Description

    Property price.

  • Name
    source
    Type
    string
    Description

    Lead source.

  • Name
    lead_type
    Type
    string
    Description

    Mortgage lead type.

  • Name
    createdAt
    Type
    string
    Description

    When the lead was created. UTC ISO 8601, for example 2026-09-27T14:30:00.000Z.

  • Name
    updatedAt
    Type
    string
    Description

    When the lead was last updated. UTC ISO 8601.

  • Name
    questions
    Type
    array
    Description

    Questions covered for your account, each with key, question, and answer. Empty when none of those questions were answered.

Request

GET
/v1.1/client/mortgage/leads
curl -G "https://api.mashvisor.com/v1.1/client/mortgage/leads" \
  --data-urlencode "from=2026-10-12T00:00:00Z" \
  --data-urlencode "to=2026-10-27T23:59:59Z" \
  --data-urlencode "after_id=1200" \
  --data-urlencode "limit=100" \
  -H "x-api-key: YOUR_API_KEY"

Response

{
  "status": "success",
  "content": {
    "filters": {
      "from": "2026-10-12T00:00:00.000Z",
      "to": "2026-10-27T23:59:59.000Z",
      "afterId": 1200,
      "limit": 100,
      "dateField": "created_at",
      "dateBounds": "inclusive"
    },
    "leads": [
      {
        "id": 1201,
        "name": "Alex Morgan",
        "email": "[email protected]",
        "phone": "555-0100",
        "address": "18 Palm Court",
        "city": "Miami",
        "state": "FL",
        "zipcode": "33101",
        "propertyType": "Single Family",
        "price": 450000,
        "source": "Mashvisor",
        "lead_type": "Refinance an investment property",
        "createdAt": "2026-10-12T14:30:00.000Z",
        "updatedAt": "2026-10-12T14:30:00.000Z",
        "questions": [
          {
            "key": "Mortgage Lead Type",
            "question": "What are you looking to finance?",
            "answer": "Refinance an investment property"
          },
          {
            "key": "Credit Score",
            "question": "What Is Your Estimated Credit Score?",
            "answer": "720"
          },
          {
            "key": "Estimated Value",
            "question": "What is the estimated value?",
            "answer": "Purchase"
          }
        ]
      }
    ],
    "pagination": {
      "count": 1,
      "limit": 100,
      "hasMore": false,
      "nextAfterId": null
    }
  },
  "message": "Mortgage partner leads"
}

When pagination.hasMore is true, request the next page with the same from and to values and after_id set to pagination.nextAfterId.

Questions covered

Each lead's questions array includes only the questions configured for your account. These are the questions available:

KeyQuestion
Visit ReasonWhat brings you here today?
Purchase GoalHow will this property be used?
First Time BuyerAre you a first time Home Buyer?
TimelineWhen are you planning to make your purchase?
Property TypeWhat Type of Property Are You Looking For?
Specific PropertySpecific property in mind?
Property AddressWhat is your current address?
Market InterestWhat Market are you interested in?
Purchase Price ($)What is Your Estimated Purchase Price?
Down PaymentHow much do you currently have saved for a down payment?
Credit ScoreWhat Is Your Estimated Credit Score?
ScenarioWhich of These Scenarios Best Describe You?
QualificationHow Do You Intend to Qualify?
Household IncomeWhat is your household gross income?
Working With AgentAre you working with an Agent?
LLCDo you plan on putting this property under a LLC?
Interest (LTR/STR)How is the property being rented?
Investment CountHow many investment properties do you currently own?
Primary Residence 12moHave you owned your primary residence for the last 12 months?
Refinancing GoalWhat is your primary goal for refinancing?
property UseWhat best describes how you use this property?
Current LoanWhat is your current loan balance?
Loan TypeWhat Type of Loan is it?
Interest RateWhat is your current interest rate?
Purchase DateWhen did you purchase the property?
Estimated ValueWhat is the estimated value?
Listed last 6 monthsHas the property been listed in the last 6 months?
Estimated Credit ScoreWhat Is Your Estimated Credit Score?
Property LeasedIs the current property leased?
Gross Monthly RevenueWhat is your Gross Monthly Revenue?
NotesAnything else you'd like us to know?
Mortgage Lead TypeWhat are you looking to finance?

Was this page helpful?