Search People

POST/v1/search/people

POST

/v1/search/people

Search leads by filters

Authorization

`x-api-key`<token>

API key for Open API authentication

In: header

All filters listed below follow AND logic between different filters - meaning every specified filter must match for a result to qualify. Within a single filter that accepts multiple values (e.g., multiple industries or locations), OR logic is applied - meaning any one of the provided values can match.

For a complete reference of each filter's predefined/accepted values, you can download the filter values CSV here.


{
  "includes": [
    "Jane Doe"
  ],
  "exactMatch": 0
}
true
true
true
[
  "https://linkedin.com/in/example-profile"
]
{
  "includes": [
    "California, United States",
    "New York, United States"
  ],
  "excludes": [
    "Los Angeles, California, United States"
  ],
  "exactMatch": 0
}
{
  "includes": [
    "Sales",
    "Marketing"
  ],
  "excludes": [
    "Customer Service"
  ]
}
{
  "includes": [
    "United States",
    "United Kingdom"
  ],
  "excludes": [
    "China"
  ],
  "exactMatch": 0
}
{
  "includes": [
    "PMP",
    "AWS Solutions Architect"
  ]
}
{
  "includes": [
    "VP of Sales",
    "Head of Sales"
  ],
  "excludes": [
    "Assistant",
    "Intern"
  ],
  "exactMatch": 0,
  "shouldSearchPast": 0
}
{
  "includes": [
    "C-Level",
    "Director",
    "Manager"
  ],
  "excludes": [
    "Intern"
  ]
}
{
  "min": "0",
  "max": "2"
}
{
  "min": "1000000",
  "max": "50000000"
}
{
  "min": "5000000",
  "max": "100000000"
}
{
  "min": "2024-01-01",
  "max": "2025-12-31"
}
{
  "min": "2015",
  "max": "2023"
}
{
  "includes": [
    "Python",
    "Machine Learning"
  ],
  "excludes": [
    "Excel"
  ],
  "exactMatch": 0
}
{
  "min": "1",
  "max": "5"
}
{
  "min": "0",
  "max": "2"
}
{
  "min": "5",
  "max": "15"
}
{
  "includes": [
    "Software Development",
    "Information Technology & Services"
  ],
  "excludes": [
    "IT Services and IT Consulting"
  ]
}
{
  "includes": [
    "HubSpot",
    "Salesforce"
  ],
  "excludes": [
    "Google"
  ],
  "exactMatch": 0,
  "shouldSearchPast": 0
}
{
  "min": "100000",
  "max": "300000"
}
{
  "min": "50",
  "max": "500"
}
{
  "min": "500",
  "max": "5000"
}
{
  "min": "500",
  "max": "10000"
}
{
  "includes": [
    "MBA"
  ],
  "excludes": [
    "Diploma"
  ]
}
{
  "includes": [
    "https://twitter.com/example",
    "https://github.com/example"
  ]
}
{
  "includes": [
    "artificial intelligence",
    "growth marketing"
  ]
}
1
5
{
  "includes": [
    "hubspot.com",
    "salesforce.com"
  ],
  "excludes": [
    "google.com"
  ]
}

#	Filter Name	Key Name	Type / Structure	Sample Value
1	Full Name	full_name	object(Include Only) `includes`array[string], optional Name(s) to search (OR logic). `exactMatch`number, optional, enum: 0 \| 1 Set 1 for exact full name match, 0 for partial/keyword match.	{ "includes": [ "Jane Doe" ], "exactMatch": 0 }
2	Decision Maker	decision_maker	boolean	true
3	Company Bootstraped	company_bootstraped	boolean	true
4	Is B2b	is_b2b	boolean	true
5	Linkedin Url	linkedin_url	array[string]	[ "https://linkedin.com/in/example-profile" ]
6	Location	location	object(Include/Exclude) `includes`array[string], optional Locations to match (OR logic). Format: "City, State, Country" or partial. `excludes`array[string], optional Locations to exclude. `exactMatch`number, optional, enum: 0 \| 1 Set 1 for exact location string match, 0 for partial match.	{ "includes": [ "California, United States", "New York, United States" ], "excludes": [ "Los Angeles, California, United States" ], "exactMatch": 0 }
7	Department	department	object(Include/Exclude) `includes`array[string], optional Departments to match (OR logic). `excludes`array[string], optional Departments to exclude.	{ "includes": [ "Sales", "Marketing" ], "excludes": [ "Customer Service" ] }
8	Company Hq Location	company_hq_location	object(Include/Exclude) `includes`array[string], optional HQ locations to match (OR logic). `excludes`array[string], optional HQ locations to exclude. `exactMatch`number, optional, enum: 0 \| 1 Set 1 for exact match, 0 for partial.	{ "includes": [ "United States", "United Kingdom" ], "excludes": [ "China" ], "exactMatch": 0 }
9	Certifications	certifications	object(Include Only) `includes`array[string], optional Certification keywords to match (OR logic).	{ "includes": [ "PMP", "AWS Solutions Architect" ] }
10	Job Title	job_title	object(Include/Exclude) `includes`array[string], optional Title keywords to match (OR logic). `excludes`array[string], optional Title keywords to exclude. `exactMatch`number, optional, enum: 0 \| 1 Set 1 for exact full title match, 0 for keyword match. `shouldSearchPast`number, optional Set 1 to also search titles from previous roles.	{ "includes": [ "VP of Sales", "Head of Sales" ], "excludes": [ "Assistant", "Intern" ], "exactMatch": 0, "shouldSearchPast": 0 }
11	Management Level	management_level	object(Include/Exclude) `includes`array[string], optional Levels to match (OR logic). `excludes`array[string], optional Levels to exclude.	{ "includes": [ "C-Level", "Director", "Manager" ], "excludes": [ "Intern" ] }
12	Jobs Changed Within	jobs_changed_within	object(Range) `min`string, optional Minimum value (passed as string). `max`string, optional Maximum value (passed as string).	{ "min": "0", "max": "2" }
13	Company Annual Revenue	company_annual_revenue	object(Range) `min`string, optional Minimum revenue in USD (passed as string). `max`string, optional Maximum revenue in USD (passed as string).	{ "min": "1000000", "max": "50000000" }
14	Company Funding Amount	company_funding_amount	object(Range) `min`string, optional Minimum total funding in USD (passed as string). `max`string, optional Maximum total funding in USD (passed as string).	{ "min": "5000000", "max": "100000000" }
15	Company Funding Date	company_funding_date	object(Range) `min`string, optional Start date (YYYY-MM-DD format). `max`string, optional End date (YYYY-MM-DD format).	{ "min": "2024-01-01", "max": "2025-12-31" }
16	Company Founded Year	company_founded_year	object(Range) `min`string, optional Earliest founding year (passed as string). `max`string, optional Latest founding year (passed as string).	{ "min": "2015", "max": "2023" }
17	Skills	skills	object(Include/Exclude) `includes`array[string], optional Skill keywords to match (OR logic). `excludes`array[string], optional `exactMatch`number, optional, enum: 0 \| 1 If true, matches full skill name exactly.	{ "includes": [ "Python", "Machine Learning" ], "excludes": [ "Excel" ], "exactMatch": 0 }
18	Current Company Experience	current_company_experience	object(Range) `min`string, optional Minimum years at current company (passed as string). `max`string, optional Maximum years at current company (passed as string).	{ "min": "1", "max": "5" }
19	Current Role Tenure	current_role_tenure	object(Range) `min`string, optional Minimum years in current role (passed as string). `max`string, optional Maximum years in current role (passed as string).	{ "min": "0", "max": "2" }
20	Total Experience	total_experience	object(Range) `min`string, optional Minimum years (passed as string). `max`string, optional Maximum years (passed as string).	{ "min": "5", "max": "15" }
21	Company Industry	company_industry	object(Include/Exclude) `includes`array[string], optional Industry keywords to match (OR logic). `excludes`array[string], optional Industry keywords to exclude.	{ "includes": [ "Software Development", "Information Technology & Services" ], "excludes": [ "IT Services and IT Consulting" ] }
22	Company Name	company_name	object(Include/Exclude) `includes`array[string], optional Company names to match (OR logic). `excludes`array[string], optional Company names to exclude. `exactMatch`number, optional, default: 0, enum: 0 \| 1 Set 1 for exact company name match, 0 for partial match. Defaults to 0. `shouldSearchPast`number, optional Set 1 to also search previous companies.	{ "includes": [ "HubSpot", "Salesforce" ], "excludes": [ "Google" ], "exactMatch": 0, "shouldSearchPast": 0 }
23	Projected Base Salary	projected_base_salary	object(Range) `min`string, optional Minimum salary in USD (passed as string). `max`string, optional Maximum salary in USD (passed as string).	{ "min": "100000", "max": "300000" }
24	Company Size	company_size	object(Range) `min`string, optional Minimum employee count (passed as string). `max`string, optional Maximum employee count (passed as string).	{ "min": "50", "max": "500" }
25	Linkedin Connection Count	linkedin_connection_count	object(Range) `min`string, optional `max`string, optional	{ "min": "500", "max": "5000" }
26	Linkedin Followers Count	linkedin_followers_count	object(Range) `min`string, optional Minimum follower count. `max`string, optional Maximum follower count.	{ "min": "500", "max": "10000" }
27	Education Degrees	education_degrees	object(Include/Exclude) `includes`array[string], optional Degree/school keywords to include (OR logic). `excludes`array[string], optional Degree/school keywords to exclude.	{ "includes": [ "MBA" ], "excludes": [ "Diploma" ] }
28	Social Link	social_link	object(Include Only) `includes`array[string], optional	{ "includes": [ "https://twitter.com/example", "https://github.com/example" ] }
29	Keywords	keywords	object(Include Only) `includes`array[string], optional	{ "includes": [ "artificial intelligence", "growth marketing" ] }
30	Page	page	number(default: 1, min: 1, max: 400)	1
31	Limit Per Company	limitPerCompany	number(min: 1, max: 10000)	5
32	Company Domain	company_domain	object(Include/Exclude) `includes`array[string], optional Domains to match (OR logic). `excludes`array[string], optional Domains to exclude.	{ "includes": [ "hubspot.com", "salesforce.com" ], "excludes": [ "google.com" ] }

Responses

201

Leads searched successfully

{
  "message": "Success",
  "payload": {
    "status": "success",
    "display_limit": 10000,
    "total_results": 2,
    "page": 1,
    "per_page": 25,
    "total_pages": 1,
    "has_next_page": false,
    "has_previous_page": false,
    "people": [
      {
        "id": 1001,
        "full_name": "Jane Doe",
        "picture_url": "https://avatar.example.com/jane-doe.jpg",
        "job_title": "VP of Sales",
        "company_name": "Acme Corp",
        "company_website": "https://acme.example.com",
        "department": "Sales",
        "location": {
          "country": "United States",
          "state": "California",
          "city": "San Francisco"
        },
        "total_experience": 96,
        "decision_maker": true,
        "company_is_b2b": true
      },
      {
        "id": 1002,
        "full_name": "Alex Smith",
        "picture_url": "https://avatar.example.com/alex-smith.jpg",
        "job_title": "Account Executive",
        "company_name": "Acme Corp",
        "company_website": "",
        "department": "Sales",
        "location": {
          "country": "United States",
          "state": "",
          "city": ""
        },
        "total_experience": 30,
        "decision_maker": false,
        "company_is_b2b": null
      }
    ]
  }
}

Success

Key	Type	Description
message	string
payload	object
└status	string	Search status string, e.g. "success".
└display_limit	number	Maximum number of results the account is allowed to retrieve for this search.
└total_results	number	Total number of matching results across all pages.
└page	number	Current page number, matching the request's `page` parameter.
└per_page	number	Number of results returned on this page.
└total_pages	number	Total number of pages available.
└has_next_page	boolean	Whether a page after the current one exists.
└has_previous_page	boolean	Whether a page before the current one exists.
└people	array[object]	The matching people for this page. When there are zero matching results, `payload` itself becomes the literal empty array `[]` instead of an object containing this field. Client code reading `payload.people` should confirm `payload` is not itself an array first (e.g. `Array.isArray(payload)`).
└id	number	Numeric identifier for this person.
└full_name	string	Person's full name.
└picture_url	string	Profile picture URL.
└job_title	string	Current job title.
└company_name	string	Current employer's company name.
└company_website	string	Current employer's website. Can be an empty string.
└department	string	Department at the current company.
└location	object	Person's location.
└country	string	Country name. Can be an empty string.
└state	string	State or province name. Can be an empty string. In some records this holds the same value as `city`, or is blank, rather than a distinct state name.
└city	string	City name. Can be an empty string. See the note on `state` above about data quality in this object.
└total_experience	number	Total professional experience, in months.
└decision_maker	boolean	Whether this person is flagged as a decision maker.
└company_is_b2b	boolean	Whether the person's company is flagged as B2B. `null` when unknown.

No Results

Key	Type	Description
message	string
payload	array	Empty when no results match — `payload` itself becomes a literal empty array instead of an object with an empty `people` array. Client code should check `Array.isArray(payload)` before reading `payload.people`.

Search leads by filters

Authorization

`x-api-key`<token>

Request Body

Responses

Success

No Results

Request

Response

Search People

Search leads by filters

Authorization

x-api-key<token>

Request Body

Responses

Success

No Results

Request

Response

`x-api-key`<token>