Skip to main content
POST
Search for people

Authorizations

pubrio-api-key
string
header
required

A unique API token that represents the actions you perform through the API and the corresponding permissions and operations. You can create it through the Settings section.

Body

application/json
search_term
string

A string of words over which we want to filter the results.

Example:

"pubrio"

people_name
string

Filter search results to include a specific people name.

Example:

"king"

people_titles
string[]

Job titles associated with the individuals you aim to locate.

The results will also encompass job titles that include similar terminology, even if they do not match exactly. For instance, searching for software engineer may yield results for individuals with the title senior software engineer.

Example:
exclude_people_titles
string[]

Job titles to leave out. Same word-level matching as people_titles, so ["senior"] removes every title containing that word. Applied after people_titles.

Example:
peoples
string<uuid>[]

A list of unique identifiers (people_search_id) used for people search operations.

management_levels
enum<string>[]

Reporting tier of the person. The C-suite slug is c_suite, not c_level. An unknown slug matches nobody. Full list from the management level endpoint under Filters.

Available options:
c_suite,
director,
entry,
founder,
head,
intern,
manager,
owner,
partner,
senior,
vp
Example:
departments
string[]

The department field can search for people in specific areas of expertise.

Check out department endpoints under the Filters tab for more information.

Example:
exclude_departments
string[]

Department slugs to leave out. Same vocabulary as departments. People with no department recorded are kept.

Example:
department_functions
string[]

The filter field for job functions can specify particular roles or areas of expertise when searching for people.

Check out department functions endpoints under the Filters tab for more information.

Example:
exclude_department_functions
string[]

Function slugs to leave out. Same vocabulary as department_functions. People with no function recorded are kept.

Example:
employees
string[][]

The number range of employees working for the company. This enables you to find companies based on headcount. You can add multiple ranges to expand your search results.

Check out company size endpoints under the Filters tab for more information.

Example:
people_locations
string[]

The location where people live. Check out location endpoints under the Filters tab for more information.

Example:
exclude_people_locations
string[]

Countries the person must not live in (ISO 3166-1 alpha-2). Companion of people_locations.

Example:
company_locations
string[]

The location of the company headquarters. Check out location endpoints under the Filters tab for more information.

Example:
company_exclude_locations
string[]

Headquarters countries to leave out (ISO 3166-1 alpha-2). Companion of company_locations; sending the same code in both returns nothing.

Example:
company_linkedin_urls
string[]

The fully formed URL of the LinkedIn company profile. URL begin with http and contain linkedin.com/company/

Example:
linkedin_urls
string[]

The fully formed URL of the LinkedIn user profile. URL begin with http and contain linkedin.com/in/ or linkedin.com/pub/

Example:
companies
string<uuid>[]

A list of unique identifiers (domain_search_id) used for company and people search operations.

domains
string[]

List of company domains used for company and people search operations. If we receive a URL such as www.pubrio.com or https://docs.pubrio.com/, the system will convert it to pubrio.com for processing.

Example:
company_filters
object

Wrapper object for company-level filters. Recommended grouping that visually separates which keys filter the person (top-level) from which filter the company. Accepts the same keys as the top-level company filters (e.g. technologies, verticals, vertical_categories, vertical_sub_categories, categories, keywords, founded_dates, employees, revenues, company_locations, company_exclude_locations, company_places, company_exclude_places, companies, domains, company_linkedin_urls, is_enable_similarity_search, similarity_score, plus filter_conditions). Engine flattens this object to the top level before processing — top-level keys win on conflict. Same shape used by Monitor company_filters. See the Filters Overview developer guide for examples.

Example:
filter_conditions
object[]

Per-key AND/OR override for filters in /people/search. Defaults to OR when omitted. See the People + Company Filters developer guide for the full key-remap reference.

When enabled, the filters listed above that support similarity searches can be filled with free text for specific IDs.

similarity_score
number<float>

It is used in conjunction with is_enable_similarity_search. This number is used to analyze whether a specific slug (e.g. vertical industry, technology) is similar to the user input, and the higher the number, the more stringent it is.

Example:

0.7

per_page
integer
default:25

Records per page. Defaults to 25, which is also the ceiling on most plans — the limit is your subscription's max_search_per_page, returned by Profile. Exceeding it returns HTTP 416 with code 41676 (or 41613 on company and people search), not a clamped result set.

Required range: x <= 25
Example:

25

page
integer
default:1

Page number, starting at 1. The ceiling is your subscription's max_search_page (max_company_search_page for company search), returned by Profile. Exceeding it returns HTTP 416.

Example:

1

query
string

Natural-language search. When provided, Pubrio interprets it into the person and company filters below (job role, seniority, department, location, industry, company size, and more). Any explicit filters you also pass take precedence over the interpreted ones. Leave empty to search purely by the structured filters.

Example:

"decision makers in marketing"

is_include_similar_people_titles
boolean
default:true

Enabled by default. people_titles also matches close variants of each title (for example, software engineer matches senior software engineer). metadata.filters.people_titles returns the full list that was searched.

people_title_similarity_score
number<float>

Used together with is_include_similar_people_titles. Controls how closely a title must match; the higher the number, the stricter the match.

Example:

0.9

technologies
integer[]

A list of tag_id used to search for specific technologies used by companies. To find the ID, call the technology endpoint under the Filters tab.

This filter supports is_enable_similarity_search, once enabled you can enter any free text, e.g. ["Shopify"].

A product name the technology list knows matches that product and its own products ("Salesforce" also matches Salesforce Desk and Salesforce Service Cloud), never look-alikes; other text matches by similarity.

categories
integer[]

A list of category_id used to search for specific categories of technology used by companies. To find the ID, call the category endpoint under the Filters tab.

This filter supports is_enable_similarity_search, once enabled you can enter any free text, e.g. ["CDN"].

verticals
integer[]

A list of vertical_id used to search for companies in a specific vertical or industry. To find the ID, call the vertical endpoint under the Filters tab.

This filter supports is_enable_similarity_search, once enabled you can enter any free text, e.g. ["AI"].

vertical_categories
integer[]

A list of vertical_category_id used to search for companies in a specific vertical category. To find the ID, call the vertical category endpoint under the Filters tab.

This filter supports is_enable_similarity_search, once enabled you can enter any free text, e.g. ["Information Technology"].

vertical_sub_categories
integer[]

A list of vertical_sub_category_id used to search for companies in a specific vertical sub-category. To find the ID, call the vertical sub category endpoint under the Filters tab.

This filter supports is_enable_similarity_search, once enabled you can enter any free text, e.g. ["Software"].

keywords
string[]

A list of keywords to filter companies by relevance, specialties, or descriptions.

Example:
founded_dates
integer[]

Years of company founded range. The maximum value founded is the current year.

Example:
revenues
integer[]

Minimum and maximum range of company revenue.

Example:
company_places
string[]

Place names (city, region) used to filter results. Accepts localized or English place names.

Example:
company_exclude_places
string[]

Place names (city, region) to exclude from results. Accepts localized or English place names.

Example:

Response

Successful response containing people search details.

metadata
object

Request context: echoed filters and parameters, an optional profile credit block, and ignored_fields (body keys the endpoint dropped).

data
object | null

Response info depends on specific endpoint.

Last modified on November 12, 2024