Get or search for lead

This endpoint can also be used to search for a lead - if campaign_id is left blank, all leads matching email will be returned.

Query Parameters

api_keystring Required
campaign_idstring

Optional - campaign ID; if left blank, all leads matching the email will be returned

emailstring Required

Email address of the lead

Response

200
Object

Response Attributes

idstring

Lead's ID

timestamp_createdstring

Timestamp created

campaignstring

Campaign ID

statusnumber

Lead's status

contactstring

Lead's email

email_openedboolean

If the lead has opened an email

email_repliedboolean

If the lead has replied

lead_dataobject

Show child attributes

campaign_namestring

Name of the campaign

Was this section helpful?

What made this section unhelpful for you?

Language Box

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?