Skip to main content
POST
/
v2
/
profiles
Search People
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"
  }
}

Overview

Search for profiles using a combination of keyword, company, location, school, and other filters. Supports pagination for retrieving large result sets.
This endpoint consumes 1 credit per 10 results returned.

Request

x-api-key
string
required
Your API key for authentication.
account_id
string
required
The unique identifier of the account to use.
action
string
required
Must be "search_people".
params
object

Response

success
boolean
Indicates whether the request was successful.
data
object
metadata
object
{
  "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"
  }
}