curl --request POST \
--url https://api.example.com/v2/profiles \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"account_id": "<string>",
"action": "<string>",
"params": {
"keyword": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"title": "<string>",
"company_name": "<string>",
"company_url": [
"<string>"
],
"past_company": [
"<string>"
],
"location": [
"<string>"
],
"school_url": [
"<string>"
],
"industry": [
"<string>"
],
"network": [
"<string>"
],
"connection_of": "<string>",
"follower_of": "<string>",
"fetch_invitation_state": true,
"total_results": 123,
"start_page": 123,
"end_page": 123
}
}
'{
"success": true,
"data": {
"results": [
{
"public_id": "janedoe",
"first_name": "Jane",
"last_name": "Doe",
"headline": "Software Engineer at TechCo",
"location": "San Francisco, CA",
"profile_picture_url": "https://media.licdn.com/dms/image/example.jpg",
"linkedin_url": "https://www.linkedin.com/in/janedoe",
"invitation_state": "CONNECTED"
},
{
"public_id": "bobsmith",
"first_name": "Bob",
"last_name": "Smith",
"headline": "Senior Developer at StartupXYZ",
"location": "San Francisco Bay Area",
"profile_picture_url": "https://media.licdn.com/dms/image/example2.jpg",
"linkedin_url": "https://www.linkedin.com/in/bobsmith",
"invitation_state": "PENDING"
}
],
"total_results": 2,
"total_available_results": 15400
},
"metadata": {
"action": "search_people",
"account_id": "your-account-id",
"credits_consumed": 2,
"timestamp": "2026-03-24T12:00:00Z"
}
}
Search for profiles using various filters.
curl --request POST \
--url https://api.example.com/v2/profiles \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"account_id": "<string>",
"action": "<string>",
"params": {
"keyword": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"title": "<string>",
"company_name": "<string>",
"company_url": [
"<string>"
],
"past_company": [
"<string>"
],
"location": [
"<string>"
],
"school_url": [
"<string>"
],
"industry": [
"<string>"
],
"network": [
"<string>"
],
"connection_of": "<string>",
"follower_of": "<string>",
"fetch_invitation_state": true,
"total_results": 123,
"start_page": 123,
"end_page": 123
}
}
'{
"success": true,
"data": {
"results": [
{
"public_id": "janedoe",
"first_name": "Jane",
"last_name": "Doe",
"headline": "Software Engineer at TechCo",
"location": "San Francisco, CA",
"profile_picture_url": "https://media.licdn.com/dms/image/example.jpg",
"linkedin_url": "https://www.linkedin.com/in/janedoe",
"invitation_state": "CONNECTED"
},
{
"public_id": "bobsmith",
"first_name": "Bob",
"last_name": "Smith",
"headline": "Senior Developer at StartupXYZ",
"location": "San Francisco Bay Area",
"profile_picture_url": "https://media.licdn.com/dms/image/example2.jpg",
"linkedin_url": "https://www.linkedin.com/in/bobsmith",
"invitation_state": "PENDING"
}
],
"total_results": 2,
"total_available_results": 15400
},
"metadata": {
"action": "search_people",
"account_id": "your-account-id",
"credits_consumed": 2,
"timestamp": "2026-03-24T12:00:00Z"
}
}
"search_people".Show params properties
"San Francisco", ["Paris", "London"]). Accepts a single string or an array."F" (1st degree), "S" (2nd degree), "O" (3rd degree and beyond). Accepts a single string or an array (e.g., ["F", "S"]).true.10.end_page for pagination mode.start_page for pagination mode.Show data properties
Show result item properties
fetch_invitation_state is true).{
"success": true,
"data": {
"results": [
{
"public_id": "janedoe",
"first_name": "Jane",
"last_name": "Doe",
"headline": "Software Engineer at TechCo",
"location": "San Francisco, CA",
"profile_picture_url": "https://media.licdn.com/dms/image/example.jpg",
"linkedin_url": "https://www.linkedin.com/in/janedoe",
"invitation_state": "CONNECTED"
},
{
"public_id": "bobsmith",
"first_name": "Bob",
"last_name": "Smith",
"headline": "Senior Developer at StartupXYZ",
"location": "San Francisco Bay Area",
"profile_picture_url": "https://media.licdn.com/dms/image/example2.jpg",
"linkedin_url": "https://www.linkedin.com/in/bobsmith",
"invitation_state": "PENDING"
}
],
"total_results": 2,
"total_available_results": 15400
},
"metadata": {
"action": "search_people",
"account_id": "your-account-id",
"credits_consumed": 2,
"timestamp": "2026-03-24T12:00:00Z"
}
}
Was this page helpful?