8. Retrieve past leads looking back 90 days

GET {{baseUrl}}/adFormResponses?q=account&account=urn%3Ali%3AsponsoredAccount%3A{{sponsoredaccount_id}}&projection=(paging,elements*(id,leadType,account~(id,name,reference~(localizedName)),campaign~(id,name),creative~(id,variables(data((,share~(text))))),form~(form(landingPage,hiddenFields,name)),formResponse(consentResponses*(accepted,consent~),submittedAt,answers*(question~,answerDetails))))&timeRange=(start:1668283699000,end:1668456499000)

Responses can be fetched for a single form, multiple forms, or at the Ad Account level.

This example uses decoration to not only expand certain fields from the form and form response but also additional metadata about the ad account, campaign, and creative associated with the lead.

The adFormResponses endpoint is used to pull leads and accepts timeRange.start and timeRange.end params to pull leads for a particular period. timeRange.start would be equal to the time you last pulled and timeRange.end would either be omitted or set to now.

LinkedIn will store form response (lead) data for up to 90 days. It is a best practice to do a one time pull upon integration setup to ensure no leads are missed for your customer.

Request Params

HEADERS

RESPONSES

status: OK

{"paging":{"total":2,"start":0,"count":10,"links":[]},"elements":[{"creative~":{"variables":{"data":{"com.linkedin.ads.SponsoredUpdateCreativeVariables":{"contentAuthor":{"organization":"urn:li:organization:11223344"},"activity":"urn:li:activity:6904869836686544896","callToActionEnabled":false,"sponsoredStatusUpdateContentType":"IMAGE","mediaAspectRatio":{"widthAspect":1.5037594,"heightAspect":1},"share":"urn:li:share:6904869836015464450","share~":{"text":{"text":"check this out!"}},"directSponsoredContent":true}}},"id":241257736},"form~":{"form":{"name":"Form with written spanish","hiddenFields":[{"name":"hidden_field","value":"abc678"},{"name":"campo_escondido","value":"def789"}],"landingPage":"https://www.linkedin.com"}},"account~":{"name":"Christa's Updated Ad Acount","reference":"urn:li:organization:11223344","id":508679858,"reference~":{"localizedName":"Expedited LLC"}},"creative":"urn:li:sponsoredCreative:241257736","form":"urn:li:adForm:7234246","leadType":"SPONSORED","campaign":"urn:li:sponsoredCampaign:198356826","campaign~":{"name":"Spain campaign","id":198356826},"id":"urn:li:adFormResponse:ed31e922-0d3f-4eb6-b6a4-603d32a8752d-6","account":"urn:li:sponsoredAccount:123456","formResponse":{"answers":[{"question":"urn:li:adFormQuestion:(urn:li:adForm:7234246,3)","question~":{"questionId":3,"question":"Correo electrónico","memberProfileField":"EMAIL","typeSpecificQuestionDetails":{"com.linkedin.ads.TextQuestionDetails":{}},"name":"Email address","predefinedField":"EMAIL"},"answerDetails":{"com.linkedin.ads.TextQuestionAnswer":{"answer":"myemail@gmail.com"}}},{"question":"urn:li:adFormQuestion:(urn:li:adForm:7234246,6)","question~":{"questionId":6,"question":"Correo electrónico del trabajo","memberProfileField":"EMAIL","typeSpecificQuestionDetails":{"com.linkedin.ads.TextQuestionDetails":{}},"name":"Work email","predefinedField":"WORK_EMAIL"},"answerDetails":{"com.linkedin.ads.TextQuestionAnswer":{"answer":"myemail@mywork.com"}}},{"question":"urn:li:adFormQuestion:(urn:li:adForm:7234246,7)","question~":{"questionId":7,"question":"Cuál es tu color favorito","typeSpecificQuestionDetails":{"com.linkedin.ads.MultipleChoiceQuestionDetails":{"options":[{"com.linkedin.ads.TextOptionQuestion":{"text":"Rojo"}},{"com.linkedin.ads.TextOptionQuestion":{"text":"Azul"}}]}},"name":"Custom question 0"},"answerDetails":{"com.linkedin.ads.MultipleChoiceAnswer":{"options":[{"com.linkedin.ads.TextOptionAnswer":{"index":0}}]}}},{"question":"urn:li:adFormQuestion:(urn:li:adForm:7234246,8)","question~":{"questionId":8,"question":"¿Dónde creciste?","typeSpecificQuestionDetails":{"com.linkedin.ads.TextQuestionDetails":{}},"name":"Custom question 1"},"answerDetails":{"com.linkedin.ads.TextQuestionAnswer":{"answer":"En los Estados Unidos"}}},{"question":"urn:li:adFormQuestion:(urn:li:adForm:7234246,1)","question~":{"questionId":1,"question":"Nombre","memberProfileField":"FIRST_NAME","typeSpecificQuestionDetails":{"com.linkedin.ads.TextQuestionDetails":{}},"name":"First name","predefinedField":"FIRST_NAME"},"answerDetails":{"com.linkedin.ads.TextQuestionAnswer":{"answer":"Jenn"}}},{"question":"urn:li:adFormQuestion:(urn:li:adForm:7234246,2)","question~":{"questionId":2,"question":"Apellidos","memberProfileField":"LAST_NAME","typeSpecificQuestionDetails":{"com.linkedin.ads.TextQuestionDetails":{}},"name":"Last name","predefinedField":"LAST_NAME"},"answerDetails":{"com.linkedin.ads.TextQuestionAnswer":{"answer":"Kristof"}}},{"question":"urn:li:adFormQuestion:(urn:li:adForm:7234246,4)","question~":{"questionId":4,"question":"Cargo","memberProfileField":"JOB_TITLE","typeSpecificQuestionDetails":{"com.linkedin.ads.TextQuestionDetails":{}},"name":"Job title","predefinedField":"JOB_TITLE"},"answerDetails":{"com.linkedin.ads.TextQuestionAnswer":{"answer":"software engineer"}}},{"question":"urn:li:adFormQuestion:(urn:li:adForm:7234246,5)","question~":{"questionId":5,"question":"Función","memberProfileField":"JOB_FUNCTION","typeSpecificQuestionDetails":{"com.linkedin.ads.TextQuestionDetails":{}},"name":"Function","predefinedField":"JOB_FUNCTION"},"answerDetails":{"com.linkedin.ads.TextQuestionAnswer":{"answer":"Ingeniería"}}}],"consentResponses":[{"accepted":true,"consent":"urn:li:adFormConsent:(urn:li:adForm:7234246,0)","consent~":{"consentId":0,"consentRequired":true,"content":" marque mi casilla de verificación personalizada!"}}],"submittedAt":1677549459303}}]}