Skip to navigation
HeyReach APICampaigns

GetCampaignsForLead

View as Markdown

Gets Campaigns for a Lead

Retrieves the list of campaigns where the specified lead is.

Remark: The response will contain campaigns that match the provided lead information, such as email, LinkedIn ID, or profile URL.

Body Parameters

  • email (string, optional): The email address of the lead.

  • linkedinId (string, optional): The LinkedIn ID of the lead.

  • profileUrl (string, optional): The LinkedIn profile URL of the lead.

  • for example: https://www.linkedin.com/in/john_doe/

  • offset (integer): The number of records to skip (for pagination).

  • limit (integer): The maximum number of records to return.

Response:

LeadStatus

  • Pending

  • InSequence

  • Finished

  • Paused

  • Failed

  • Excluded

  • PendingOrExcludedToBeCalculated

CampaignStatus

  • DRAFT

  • IN_PROGRESS

  • PAUSED

  • FINISHED

  • CANCELED

  • FAILED

  • STARTING

Headers

X-API-KEYstringOptional

Request

This endpoint expects an object.
emailstringRequired
linkedinIdstringRequired
profileUrlstringRequired
offsetintegerRequired
limitintegerRequired

Response

OK
leadFullNamestring
totalCountinteger
itemslist of objects