Page tree
Skip to end of metadata
Go to start of metadata

This page describes the MarketingLeadEndpoint endpoint, which can be used to get data about marketing leads.

GET 

Get a marketing lead

Gets a marketing lead from your third-party marketing software solution, such as Marketo or Salesforce Marketing Cloud, based on a filter.

Request URL

/.rest/marketing-automation/v1/leads/

Parameters

Parameter

Description

Parameter type

Data type

definitionName

required

The definition name. 

For example: marketo or salesforce.

query

string

filterType

required

The type of filter applied to the results.

For example: email

query

string

filterValues

required

The value of the filter.

For example: jane.doe@email.com

query

string

fields

required

The fields whose data you want to get.

For example: FirstName,LastName,Email

query

string

checkFormPrefilling

optional

If set to true, checks if form pre-filling is enabled. If it is enabled, lead data is returned. If it is disabled, no lead data is returned. This means you can use this parameter to effectively enable/disable form pre-filling.

If not used or false, then form pre-filling configuration is not checked. 

queryboolean

Example

Gets the first and last names for the lead with the email test@best-cms.com from Marketo.

http://localhost:8080/magnoliaPublic/.rest/marketing-automation/v1/leads?definitionName=marketo&filterType=email&filterValues=test@best-cms.com&fields=FirstName,LastName

Response
{
    "id": {
        "externalId": "13",
        "definitionName": "marketo"
    },
    "values": {
        "id": 13,
        "firstName": "Jane",
        "lastName": "Doe",
        "email": "test@best-cms.com"
    }
}