GET

Get lead information

GET

https://api.metahvac.com

/salesforce/v1.1/leads/:id

Retrieve detailed information for a single lead by ID

Get lead information › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get lead information › Responses

200

Successful response for single lead details

id

string

email

string · email

name

string

FirstName

string

LastName

string

company

string

phone

string

category

string

status

string

purchaseStatus

string

address

object

annualRevenue

number

assignedContractor

string

assignedBU

string

doNotSell

boolean

approvalCode

string

isApprovedHEAR

boolean

isQualifiedHEAR

boolean

tierHEAR

string

Consumer_Rebate_Summary__c

string

Contractor_Rebate_Summary__c

string

Campaign__c

string

Auto_Assign_Contractors__c

boolean

Rooms__c

string

When_Are_You_Planning_to_Purchase__c

string

RecordTypeId

string

GET/salesforce/v1.1/leads/:id

curl https://api.metahvac.com/salesforce/v1.1/leads/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "00QYYYYYY000000BBB",
  "email": "[email protected]",
  "name": "John Doe",
  "FirstName": "John",
  "LastName": "Doe",
  "company": "Acme Corp",
  "phone": "+1234567890",
  "category": "Homeowner",
  "status": "Approved",
  "purchaseStatus": "In Progress",
  "address": {},
  "annualRevenue": 50000,
  "assignedContractor": "001XXXXXXXXXX",
  "assignedBU": "BU-Test",
  "doNotSell": false,
  "approvalCode": "ABC123",
  "isApprovedHEAR": true,
  "isQualifiedHEAR": true,
  "tierHEAR": "Tier 1",
  "Consumer_Rebate_Summary__c": "Rebate details",
  "Contractor_Rebate_Summary__c": "Contractor rebate details",
  "Campaign__c": "701ZZZZZ00ZZZZZZZZ",
  "Auto_Assign_Contractors__c": true,
  "Rooms__c": "3-4 rooms",
  "When_Are_You_Planning_to_Purchase__c": "Within 3 months",
  "RecordTypeId": "012XXXXXXXXXX"
}

json

application/json

Get leads

GET

https://api.metahvac.com

/salesforce/v1.1/leads

Retrieve a paginated list of leads with basic information for browsing

Get leads › query Parameters

fields

string[]

Comma seperated list of fields from Salesforce

createdAfter

string · date-time

ISO formatted date to filter leads after

count

number

number of leads returned for pagination use

cursorCreatedDate

string · date-time

PAGINATION USE ONLY: Last date from previous query

cursorId

date

PAGINATION USE ONLY: Last ID of lead from previous query

Get leads › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get leads › Responses

Successful response for list of leads

Id

string

CreatedDate

string · date-time

LeadID__c

string

Status

string

LeadSource

string

Name

string

Business_Unit__c

string

StateCode

string

PostalCode

string

Campaign__c

string

marketing_term__c

string

marketing_medium__c

string

utm_advertising_campaign__c

string

Rooms__c

string

When_Are_You_Planning_to_Purchase__c

string

RecordTypeId

string

GET/salesforce/v1.1/leads

curl https://api.metahvac.com/salesforce/v1.1/leads \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "Id": "00QXXXXXX000000AAA",
  "CreatedDate": "2025-01-01T00:00:00.000+0000",
  "LeadID__c": "00QYYYYYY000000BBB",
  "Status": "Approved",
  "LeadSource": "TestChannel",
  "Name": "Test Record",
  "Business_Unit__c": "BU-Test",
  "StateCode": "ZZ",
  "PostalCode": "99999",
  "Campaign__c": "701ZZZZZ00ZZZZZZZZ",
  "marketing_term__c": "DEMO_CAMPAIGN_TERM",
  "marketing_medium__c": "organic",
  "utm_advertising_campaign__c": "UTM | Example | Test | NoRealData",
  "Rooms__c": "3-4 rooms",
  "When_Are_You_Planning_to_Purchase__c": "Within 3 months",
  "RecordTypeId": "012XXXXXXXXXX"
}

json

application/json