Get lead information
GET
https://api.metahvac.com
/salesforce/v1.1/leads/:id
Retrieve detailed information for a single lead by ID
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Successful response for single lead details
idstringemailstring · emailnamestringFirstNamestringLastNamestringcompanystringphonestringcategorystringstatusstringpurchaseStatusstringaddressobjectannualRevenuenumberassignedContractorstringassignedBUstringdoNotSellbooleanapprovalCodestringisApprovedHEARbooleanisQualifiedHEARbooleantierHEARstringConsumer_Rebate_Summary__cstringContractor_Rebate_Summary__cstringCampaign__cstringAuto_Assign_Contractors__cbooleanRooms__cstringWhen_Are_You_Planning_to_Purchase__cstringRecordTypeIdstring
Get leads
GET
https://api.metahvac.com
/salesforce/v1.1/leads
Retrieve a paginated list of leads with basic information for browsing
query Parameters
fieldsstring[]Comma seperated list of fields from Salesforce
createdAfterstring · date-timeISO formatted date to filter leads after
countnumbernumber of leads returned for pagination use
cursorCreatedDatestring · date-timePAGINATION USE ONLY: Last date from previous query
cursorIddatePAGINATION USE ONLY: Last ID of lead from previous query
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Successful response for list of leads
IdstringCreatedDatestring · date-timeLeadID__cstringStatusstringLeadSourcestringNamestringBusiness_Unit__cstringStateCodestringPostalCodestringCampaign__cstringmarketing_term__cstringmarketing_medium__cstringutm_advertising_campaign__cstringRooms__cstringWhen_Are_You_Planning_to_Purchase__cstringRecordTypeIdstring