8. [PULL] Schedule periodic form response (lead) pulls

GET {{baseUrl}}/leadFormResponses?q=owner&owner=(organization:urn%3Ali%3Aorganization%3A{{organization_id}})&leadType=(leadType:{{leadtype_organic}})&limitedToTestLeads=false&submittedAtTimeRange=(start:{{timerange_start}},end:{{timerange_end}})&fields=ownerInfo,associatedEntityInfo,leadMetadataInfo,leadType,versionedLeadGenFormUrn,id,submittedAt,testLead,formResponse,form:(hiddenFields,creationLocale,name,id,content)&count=10&start=0

This example pulls back all form responses (leads) for the chosen organization for a given lead type. It also uses field projection to pull back specific fields in the response and the submittedAtTimeRange field to pull back leads up to 365 days in the past. To pull back leads for other lead types make an additional API call with the appropriate lead type (note the environment by default is set to COMPANY however, other lead types that are not the SPONSORED leadType are considered organic).

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

Refer to Lead Form Responses documentation for more information.

Request Params

HEADERS

RESPONSES

status: OK

{"paging":{"start":0,"count":10,"links":[],"total":2},"elements":[{"form":{"name":"LeadGen form for Highlander Cranberries LLC","hiddenFields":[{"name":"Entity name","value":"Highlander Cranberries LLC"}],"id":6955637458260688897,"content":{"questions":[{"questionId":415148,"question":{"localized":{"en_US":"First Name"}},"responseEditable":true,"name":"firstName","questionDetails":{"textQuestionDetails":{"maxResponseLength":300}},"predefinedField":"FIRST_NAME","responseRequired":true},{"questionId":413300,"question":{"localized":{"en_US":"Last Name"}},"responseEditable":true,"name":"lastName","questionDetails":{"textQuestionDetails":{"maxResponseLength":300}},"predefinedField":"LAST_NAME","responseRequired":true},{"questionId":413956,"question":{"localized":{"en_US":"Email Address"}},"responseEditable":true,"name":"email","questionDetails":{"textQuestionDetails":{"maxResponseLength":300}},"predefinedField":"EMAIL","responseRequired":true},{"questionId":411540,"question":{"localized":{"en_US":"Job title"}},"responseEditable":true,"name":"jobTitle","questionDetails":{"textQuestionDetails":{"maxResponseLength":300}},"predefinedField":"JOB_TITLE","responseRequired":true},{"questionId":412068,"question":{"localized":{"en_US":"Company name"}},"responseEditable":true,"name":"company","questionDetails":{"textQuestionDetails":{"maxResponseLength":300}},"predefinedField":"COMPANY_NAME","responseRequired":true}],"description":{"localized":{"en_US":"Share your information below with Highlander Cranberries LLC to be contacted with more information"}},"legalInfo":{"consents":[{"consent":{"localized":{"en_US":"Highlander Cranberries LLC may contact me via email"}},"checkRequired":true,"id":1}],"legalInfoId":1237956,"privacyPolicyUrl":"http://www.example.com/privacy","legalDisclaimer":{"localized":{"en_US":"Highlander Cranberries LLC may use your name and email address to send you communications about the company's products."}}},"headline":{"localized":{"en_US":"Contact Highlander Cranberries LLC"}}},"creationLocale":{"country":"US","language":"en"}},"leadType":"COMPANY","leadMetadataInfo":{},"associatedEntityInfo":{"associatedCompany":{"organizationUrn":"urn:li:organization:11223344"}},"versionedLeadGenFormUrn":"urn:li:versionedLeadGenForm:(urn:li:leadGenForm:6955637458260688897,1)","ownerInfo":{"organizationInfo":{"organizationUrn":"urn:li:organization:11223344"}},"id":"a9a29e52-c0a3-42e3-8af1-2fc83b697003-4","submittedAt":1690908974184,"testLead":false,"formResponse":{"consentResponses":[{"accepted":true,"consentId":1}],"answers":[{"answerDetails":{"textQuestionAnswer":{"answer":"kitty@gmail.com"}},"questionId":413956},{"answerDetails":{"textQuestionAnswer":{"answer":"Shelly"}},"questionId":415148},{"answerDetails":{"textQuestionAnswer":{"answer":"Kitty"}},"questionId":413300},{"answerDetails":{"textQuestionAnswer":{"answer":"Lead Customer Solutions Engineer"}},"questionId":411540},{"answerDetails":{"textQuestionAnswer":{"answer":"Kellog"}},"questionId":412068}]}},{"form":{"name":"LeadGen form for Highlander Cranberries LLC","hiddenFields":[{"name":"Entity name","value":"Highlander Cranberries LLC"}],"id":6955637458260688897,"content":{"questions":[{"questionId":415148,"question":{"localized":{"en_US":"First Name"}},"responseEditable":true,"name":"firstName","questionDetails":{"textQuestionDetails":{"maxResponseLength":300}},"predefinedField":"FIRST_NAME","responseRequired":true},{"questionId":413300,"question":{"localized":{"en_US":"Last Name"}},"responseEditable":true,"name":"lastName","questionDetails":{"textQuestionDetails":{"maxResponseLength":300}},"predefinedField":"LAST_NAME","responseRequired":true},{"questionId":413956,"question":{"localized":{"en_US":"Email Address"}},"responseEditable":true,"name":"email","questionDetails":{"textQuestionDetails":{"maxResponseLength":300}},"predefinedField":"EMAIL","responseRequired":true},{"questionId":411540,"question":{"localized":{"en_US":"Job title"}},"responseEditable":true,"name":"jobTitle","questionDetails":{"textQuestionDetails":{"maxResponseLength":300}},"predefinedField":"JOB_TITLE","responseRequired":true},{"questionId":412068,"question":{"localized":{"en_US":"Company name"}},"responseEditable":true,"name":"company","questionDetails":{"textQuestionDetails":{"maxResponseLength":300}},"predefinedField":"COMPANY_NAME","responseRequired":true}],"description":{"localized":{"en_US":"Share your information below with Highlander Cranberries LLC to be contacted with more information"}},"legalInfo":{"consents":[{"consent":{"localized":{"en_US":"Highlander Cranberries LLC may contact me via email"}},"checkRequired":true,"id":1}],"legalInfoId":1237956,"privacyPolicyUrl":"http://www.example.com/privacy","legalDisclaimer":{"localized":{"en_US":"Highlander Cranberries LLC may use your name and email address to send you communications about the company's products."}}},"headline":{"localized":{"en_US":"Contact Highlander Cranberries LLC"}}},"creationLocale":{"country":"US","language":"en"}},"leadType":"COMPANY","leadMetadataInfo":{},"associatedEntityInfo":{"associatedCompany":{"organizationUrn":"urn:li:organization:11223344"}},"versionedLeadGenFormUrn":"urn:li:versionedLeadGenForm:(urn:li:leadGenForm:6955637458260688897,1)","ownerInfo":{"organizationInfo":{"organizationUrn":"urn:li:organization:11223344"}},"id":"55386bd2-6b88-45e5-9529-985af6cf30a7-3","submittedAt":1690909024749,"testLead":false,"formResponse":{"consentResponses":[{"accepted":true,"consentId":1}],"answers":[{"answerDetails":{"textQuestionAnswer":{"answer":"tina@email.com"}},"questionId":413956},{"answerDetails":{"textQuestionAnswer":{"answer":"Tina"}},"questionId":415148},{"answerDetails":{"textQuestionAnswer":{"answer":"McGee"}},"questionId":413300},{"answerDetails":{"textQuestionAnswer":{"answer":"Principal Customer Solutions Engineer"}},"questionId":411540},{"answerDetails":{"textQuestionAnswer":{"answer":"SAP"}},"questionId":412068}]}}]}