Get lead detail

GET /api/v1/leads/{leadId}

Error

A valid request URL is required to generate request examples

200

{
  "ok": "<unknown>",
  "meta": {
    "requestId": "<string>",
    "serverTime": "2023-11-07T05:31:56Z"
  },
  "data": {
    "id": "<string>",
    "legacy": {
      "convexId": "<string>",
      "goldenLeadId": 123
    },
    "master": {
      "projectName": "<string>",
      "description": "<string>",
      "location": {
        "raw": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "streetAddress": "<string>",
        "geo": {
          "lat": 123,
          "lon": 123
        }
      },
      "source": "<string>",
      "enrichment": {
        "summary": "<string>",
        "squareFootage": "<string>",
        "constructionStatus": "<string>",
        "projectStage": "<string>",
        "estimatedCost": "<string>",
        "completionDate": "<string>",
        "constructionStartDate": "<string>",
        "projectCategory": "<string>",
        "healthStatus": "healthy",
        "healthDetails": "<string>",
        "projectInsights": "<string>",
        "isRenovation": true,
        "hasFunding": true,
        "fundingAmount": "<string>",
        "fundingSource": "<string>",
        "categoryExplanation": "<string>",
        "buildingMaterials": "<string>",
        "architecturalStyle": "<string>",
        "notableDesignAspects": "<string>",
        "sustainabilityFeatures": "<string>",
        "masterplanDescription": "<string>",
        "zoningInformation": "<string>"
      },
      "validation": {
        "tier": "PLATINUM",
        "score": 123,
        "notes": "<string>",
        "verificationStatus": "<string>",
        "opportunityStrength": "strong",
        "timingAssessment": "<string>",
        "competitionLevel": "<string>",
        "redFlags": [
          "<string>"
        ]
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "timeline": [
      {
        "id": "<string>",
        "eventDate": "<string>",
        "eventDescription": "<string>",
        "eventType": "<string>",
        "isMilestone": true,
        "status": "<string>",
        "confidence": 123,
        "impactScore": 123,
        "source": "<string>",
        "relatedParties": [
          "<string>"
        ]
      }
    ],
    "keyPlayers": [
      {
        "id": "<string>",
        "name": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "companyName": "<string>",
        "role": "<string>",
        "playerType": "<string>",
        "specialty": "<string>",
        "isPast": true,
        "pastReason": "<string>",
        "firmSizeCategory": "<string>"
      }
    ],
    "sharableLeadUrl": "<string>",
    "vettingNotes": "<string>",
    "vetted": true
  }
}

Path Parameters

leadId · string · required

Minimum string length: 1

Query Parameters

include · string

Comma-separated expansions to include (finite allowlist)

fields · string

Field mask for partial responses

Response

200

application/json

OK

ok · any · required

meta · object · required

Show child attributes

data · object · required

Show child attributes