Lead API - Get Leads

Get leads via the Lead API

There are two endpoints available to get lead data from your leadpro system. One uses the explicit lead ID that you may have retained when creating leads through the API, the other allows you to return multiple leads that match on contact data such as email or phone.

Get lead by ID

Endpoint name: Get Lead Endpoint URL: https://api.lead.pro/api/v103/leads/<id> Type: GET

The get lead endpoint allows you to fetch lead data for a lead from it's ID. This is useful to check what data from a lead created through the API has changed since its initial creation, before applying any updates to it. You must specify a lead ID in the request URI to fetch lead data. A lead's ID is provided in the response body when creating leads through the API.

Get leads by contact details

Endpoint name: Get Lead Endpoint URL: https://api.lead.pro/api/v103/person/leads Type: GET

The get leads endpoint can return one or multiple leads from your system by matching contact details of the lead individual. The parameters that are available to use to query for leads are:

- email. The Person's email address. - phone The Person's phone number. - firstName The Person's first name. - lastName The Person's last name.

Note: Email or Phone must be supplied in your query parameters. Attempting to get lead data by first name or last name alone is not possible. The parameters can be passed into the get URL.