Retrieve Prospect Notes

The Prospect Notes API allows you to retrieve notes that were created about prospects on a given Recruiter contract. In order to properly store and associate these notes within your application, you need to first retrieve the LinkedIn ID for the Recruiter seatholders (Seat URN) and the prospects (Prospect URN).

It is recommended to make calls to this API periodically using a batch process. Set the maximum time range to 12 hours per call, or more frequently as needed (for example, every 30 minutes). Please note the timestamps returned are by last updated date and the note status is reflected with "active": true field to make the appropriate deletions during syncs.

All API requests require authorization. Additionally, API requests return paged results. Details on paging through results can be found here .

Retrieve Prospect Notes

Retrieve notes created for a prospect under the specified contract:

GET https://api.linkedin.com/v2/prospectNotes?q=criteria

Query parameters

Field	Description	Format	Required	Notes
contract	The contract identifier	Contract URN in format urn:li:contract:{id}	Yes	Find prospect notes associated with a specific Recruiter contract.
owners	The seat identifier	Seat URN in format urn:li:seat:{id}	No	Find prospect notes associated with specific seatholders. Multiple allowed.
beforeDate	Inclusive upper date boundary	Epoch in milliseconds (UTC)	No	Find prospect notes that were created before a specific date.
cutoffDate	Non-inclusive lower date boundary	Epoch in milliseconds (UTC)	No	Find prospect notes that were created after a specific date.

Sample Request

GET https://api.linkedin.com/v2/prospectNotes?q=criteria&contract=urn:li:contract:1234567&owners=urn:li:seat:123456789&beforeDate=1489192513000&start=0&count=5

Sample Response

{
    "elements": [
        {
            "active": true,
            "contract": "urn:li:contract:1234567",
            "created": 1489192513000,
            "id": 1323073443,
            "lastModified": 1489192513000,
            "member": "urn:li:person:a1b2c3d4e5",
            "note": "Testing out the Notes functionality 1",
            "owner": "urn:li:seat:123456789"
        },
        {
            "active": true,
            "contract": "urn:li:contract:1234567",
            "created": 1489192513000,
            "id": 1285510423,
            "lastModified": 1489192513000,
            "member": "urn:li:person:f6g7h8i9j0",
            "note": "Testing out the Notes functionality 2",
            "owner": "urn:li:seat:987654321"
        },
        {
            "active": true,
            "contract": "urn:li:contract:1234567",
            "created": 1489192513000,
            "id": 1323073443,
            "lastModified": 1489192513000,
            "member": "urn:li:person:a1b2c3d4e5",
            "note": "Testing out the Notes functionality 3",
            "owner": "urn:li:seat:123456789"
        },
        {
            "active": true,
            "contract": "urn:li:contract:1234567",
            "created": 1489192513000,
            "id": 1323073443,
            "lastModified": 1489192513000,
            "member": "urn:li:person:a1b2c3d4e5",
            "note": "Testing out the Notes functionality 4",
            "owner": "urn:li:seat:123456789"
        },
        {
            "active": true,
            "contract": "urn:li:contract:1234567",
            "created": 1489192513000,
            "id": 1323073443,
            "lastModified": 1489192513000,
            "member": "urn:li:person:a1b2c3d4e5",
            "note": "Testing out the Notes functionality 5",
            "owner": "urn:li:seat:123456789"
        }
    ],
    "paging": {
        "count": 5,
        "links": [
            {
                "href": "/v2/prospectNotes?beforeDate=1489192513000&contract=urn%3Ali%3Acontract%3A1234567&count=5&q=criteria&start=5&owners=urn%3Ali%3Aseat%3A123456789",
                "rel": "next",
                "type": "application/json"
            }
        ],
        "start": 0,
        "total": 10
    }
}

Delete Prospect Notes

When a prospect note is deleted, a Push Event will be sent.

Request Body Fields

Field	Description	Type	Required
type	Type of push event, in this case DELETE_PROSPECT_NOTE	enum	Yes
prospectNoteId	Unique ID of the prospect note deleted.	long	Yes
integrationContext	Integration context of the customer in the format of urn:li:contract:123.	URN	Yes

Sample Request

"Content-Type":"application/json",
"X-LI-Signature":"d3756e445a8065c0f38c2182c502f8229800eb2c6a9f3b4a1fdf152af867e6fc",
"Content-Length":"138",
"Connection":"Keep-Alive",
"Accept-Encoding":"gzip,deflate"

{
   "prospectNoteId":"1323073443",
   "type":"DELETE_PROSPECT_NOTE",
   "integrationContext":"urn:li:contract:123"
}