API Reference / LeadService

LeadService

Captures and exports leads generated from ads.

CreateLead

Request

Field	Type	Validation	Description
business_name	string	min_len: 1
first_name	string	min_len: 1
last_name	string	min_len: 1
email	string	email
zip_code	string	min_len: 1
phone_number	string	—
website	string	—

Response

Field	Type	Description
id	string	ULID of the resource

ListLeads

Request

Field	Type	Validation	Description
page	int32	.int32.gte = 0
page_size	int32	—

Response

Field	Type	Description
leads	Lead[]
total_results	int64
page	int32
page_size	int32

GetLead

Request

Field	Type	Validation	Description
id	string	min_len: 26	ULID of the resource

Response

Field	Type	Description
lead	Lead
locations	LeadLocation[]

Messages

Lead

Field	Type	Description
id	string	ULID of the resource
business_name	string
first_name	string
last_name	string
email	string
zip_code	string
phone_number	string
website	string
enrichment_status	string
created_at	timestamp
location_count	int64
image_gathering_status	string
selected_logo	LeadImage
selected_banner	LeadImage

LeadImage

Field	Type	Description
id	string	ULID of the resource
image_kind	string
source_url	string
page_url	string
created_at	timestamp

LeadLocation

Field	Type	Description
id	string	ULID of the resource
street_address	string
city	string
state	string
zip	string
phone	string
created_at	timestamp