External DocumentationTo learn more, visit the LinkedIn documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Count | The maximum number of results to return per page. |
| Lead Type | Select the lead type symbol. For more information, refer to the LeadType sub-object in the Lead Sync schema. |
| Owner | The owner URN only. Note: According to the selected Owner Type, Use a urn:li:sponsoredAccount:..., or a urn:li:organization:... URN.Examples: * urn:li:sponsoredAccount:522529623* urn:li:organization:5509810 |
| Owner Type | Select whether owner is a sponsored account or an organization. |
| Start | The pagination offset indicating the starting point for the next set of results. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Associated Entity | The URN of the entity associated with the lead. |
| End Time | The end of the submitted-at time filter. Note: Must use together with Start Time. |
| Limited To Test Leads | Select to return only test leads, otherwise return production leads. |
| Start Time | The start of the submitted-at time filter. Note: Must use together with End Time. |
| Versioned Lead Gen Form URN | The versioned lead gen form URN to return responses only for that form version. For Example: urn:li:versionedLeadGenForm:(urn:li:leadGenForm:3162,1) |
Example Output
{
"elements": [
{
"owner": {
"sponsoredAccount": "urn:li:sponsoredAccount:522529623"
},
"submitter": "urn:li:person:MpGcnvaU_p",
"versionedLeadGenFormUrn": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:3162,1)",
"leadMetadata": {
"sponsoredLeadMetadata": {
"campaign": "urn:li:sponsoredCampaign:367378525"
}
},
"ownerInfo": {
"sponsoredAccountInfo": {
"name": "Angela Test"
}
},
"testLead": false,
"associatedEntity": {
"associatedCreative": "urn:li:sponsoredCreative:121608865"
},
"leadType": "SPONSORED",
"leadMetadataInfo": {
"sponsoredLeadMetadataInfo": {
"campaign": {
"name": "Brand awareness - May 3, 2022",
"type": "SPONSORED_UPDATES",
"id": "urn:li:sponsoredCampaign:367378525"
}
}
},
"associatedEntityInfo": {
"associatedCreative": {
"intendedStatus": "ACTIVE",
"content": {
"reference": "urn:li:ugcPost:6927151919538794496"
},
"id": "urn:li:sponsoredCreative:121608865"
}
},
"id": "aaaabbbb-0000-cccc-1111-dddd2222eeee-5",
"submittedAt": 1686182358881,
"formResponse": {
"answers": [
{
"answerDetails": {
"textQuestionAnswer": {
"answer": "Hello World-testing purpose"
}
},
"questionId": 1
}
],
"consentResponses": [
{
"accepted": true,
"consentId": 4
}
]
}
}
],
"paging": {
"count": 10,
"start": 0,
"total": 1,
"links": []
}
}