Lead Nurturing API Methods

Get Leads in a Lead Nurturing Campaign

GET  /nurture/v1/campaign/:campaign_guid/list

For a given portal, return a list of leads currently subscribed to a specific nurturing campaign, specified by its GUID.

Required Parameters How to use Description
Campaign GUID Used in the request URL Unique identifier for a particular lead nurturing campaign.
HubSpot OAuth Access Token access_token=X - Used in the request URL The HubSpot API key for the portal that you're making the call for.
Optional Parameters How to use Description
None None No optional parameters for this method.

Example URL using JSON:  https://api.hubapi.com/nurture/v1/campaign/dd9ba8fa-f7b9-4ece-88d6-cd9dc4124872/list?access_token=demooooo-oooo-oooo-oooo-oooooooooooo

Example JSON output. It's displaying 3 leads associated with a campaign from the HubSpot demo portal:

        [
            {
                "leadGuid": "8a706adf325d88a801325d8958300017",
                "campaignGuid": "dd9ba8fa-f7b9-4ece-88d6-cd9dc4124872",
                "status": "Active"
            },
            {
                "leadGuid": "8a706adf3263653501326365da13000e",
                "campaignGuid": "dd9ba8fa-f7b9-4ece-88d6-cd9dc4124872",
                "status": "Active"
            },
            {
                "leadGuid": "8a706adf32969c770132969c9569000f",
                "campaignGuid": "dd9ba8fa-f7b9-4ece-88d6-cd9dc4124872",
                "status": "Active"
            }
        ]