api.web2lead.get

GET /Web2Lead/get — ABC

Python

api.web2lead.get(*, params: Web2LeadGetParams | dict) -> Web2LeadResponse

CLI

ab web2lead get [--params ...]

GET /Web2Lead/get.

Args: params: Lead query parameters (29 optional string fields). Accepts a :class:Web2LeadGetParams instance or a dict with snake_case or PascalCase keys.

Params model: :class:Web2LeadGetParams

Query parameters — Web2LeadGetParams

Field	Type	Required	Description
AccessKey	Optional[str]	no	API access key
FirstName	Optional[str]	no	Lead first name
LastName	Optional[str]	no	Lead last name
Address1	Optional[str]	no	Street address line 1
Address2	Optional[str]	no	Street address line 2
City	Optional[str]	no	City
StateProvince	Optional[str]	no	State or province
ZipPostalCode	Optional[str]	no	ZIP or postal code
ReferrerPage	Optional[str]	no	Referring page URL
EntryUrl	Optional[str]	no	Entry URL
SubmissionPage	Optional[str]	no	Form submission page
HowHeard	Optional[str]	no	How the lead heard about us
Email	Optional[str]	no	Lead email address
Phone	Optional[str]	no	Lead phone number
ShipDate	Optional[str]	no	Requested ship date
ShipFrom	Optional[str]	no	Ship from location
ShipTo	Optional[str]	no	Ship to location
BusinessLead	Optional[str]	no	Business lead flag
ReferredBy	Optional[str]	no	Referral source
ReferredName	Optional[str]	no	Referrer name
CustomerComments	Optional[str]	no	Customer comments
IPAddress	Optional[str]	no	Client IP address
SearchTerm	Optional[str]	no	Search term used
FranchiseeId	Optional[str]	no	Franchisee UUID
CompanyName	Optional[str]	no	Company name
Paid	Optional[str]	no	Paid status
Commodity	Optional[str]	no	Commodity type
Industry	Optional[str]	no	Industry
FullName	Optional[str]	no	Lead full name

Response

Returns Web2LeadResponse.

Field	Type	Required	Description
SubmitNewLeadGETResult	Optional[Web2LeadGETResult]	no	Lead submission result

---

← Back to api.web2lead