Skip to main content
POST
Поиск людей

Авторизации

pubrio-api-key
string
header
обязательно

Уникальный токен API, представляющий действия, которые вы выполняете через API, и соответствующие права доступа и операции. Вы можете создать его в разделе Settings.

Тело

application/json
search_term
string

Строка слов, по которой мы фильтруем результаты.

Пример:

"pubrio"

people_name
string

Ограничить результаты поиска конкретным именем человека.

Пример:

"king"

people_titles
string[]

Должности, связанные с людьми, которых вы хотите найти.

Результаты также будут включать должности, содержащие схожую терминологию, даже если они не совпадают точно. Например, поиск по software engineer может вернуть результаты с должностью senior software engineer.

Пример:
exclude_people_titles
string[]

Должности для исключения. То же сопоставление на уровне слов, что и у people_titles, поэтому ["senior"] удаляет каждую должность, содержащую это слово. Применяется после people_titles.

Пример:
peoples
string<uuid>[]

Список уникальных идентификаторов (people_search_id), используемых для операций поиска людей.

management_levels
enum<string>[]

Уровень подчинённости человека. Слаг для высшего руководства — c_suite, а не c_level. Неизвестные слаги отбрасываются, если присутствуют другие фильтры по людям, и приводят к ошибке 40037, если это единственный указанный фильтр. Полный список доступен в эндпоинте management level на вкладке Filters.

Доступные опции:
c_suite,
director,
entry,
founder,
head,
intern,
manager,
owner,
partner,
senior,
vp
Пример:
departments
string[]

Поле отдела позволяет искать людей в конкретных областях деятельности.

Подробнее см. эндпоинты department на вкладке Filters.

Пример:
exclude_departments
string[]

Слаги отделов для исключения. Тот же словарь, что и departments. Люди без указанного отдела сохраняются.

Пример:
department_functions
string[]

Поле фильтра по функциям позволяет указать конкретные роли или области деятельности при поиске людей.

Подробнее см. эндпоинты department functions на вкладке Filters.

Пример:
exclude_department_functions
string[]

Слаги функций для исключения. Тот же словарь, что и department_functions. Люди без указанной функции сохраняются.

Пример:
employees
string[][]

Диапазон количества сотрудников, работающих в компании. Позволяет находить компании по численности персонала. Можно добавить несколько диапазонов, чтобы расширить результаты поиска.

Подробнее см. эндпоинты company size на вкладке Filters.

Пример:
people_locations
string[]

Местоположение проживания людей. Подробнее см. эндпоинты location на вкладке Filters.

Пример:
exclude_people_locations
string[]

Страны, в которых человек не должен проживать (ISO 3166-1 alpha-2). Дополняет people_locations.

Пример:
company_locations
string[]

Местоположение штаб-квартиры компании. Подробнее см. эндпоинты location на вкладке Filters.

Пример:
company_exclude_locations
string[]

Страны штаб-квартир для исключения (ISO 3166-1 alpha-2). Дополняет company_locations; передача одного и того же кода в обоих полях не даёт результатов.

Пример:
company_linkedin_urls
string[]

Полностью сформированный URL профиля компании в LinkedIn. URL начинается с http и содержит linkedin.com/company/

Пример:
linkedin_urls
string[]

Полностью сформированный URL профиля пользователя в LinkedIn. URL начинается с http и содержит linkedin.com/in/ или linkedin.com/pub/

Пример:
companies
string<uuid>[]

Список уникальных идентификаторов (domain_search_id), используемых для операций поиска компаний и людей.

domains
string[]

Список доменов компаний, используемых для операций поиска компаний и людей. Если получен URL вида www.pubrio.com или https://docs.pubrio.com/, система преобразует его в pubrio.com для обработки.

Пример:
company_filters
object

Объект-обёртка для фильтров на уровне компании. Рекомендуемая группировка, визуально отделяющая, какие ключи фильтруют человека (верхний уровень), а какие — компанию. Принимает те же ключи, что и фильтры компании верхнего уровня (например, 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, а также filter_conditions). Движок разворачивает этот объект на верхний уровень перед обработкой — при конфликте побеждают ключи верхнего уровня. Та же структура используется в company_filters монитора. Примеры см. в руководстве разработчика Filters Overview.

Пример:
filter_conditions
object[]

Переопределение AND/OR для каждого ключа фильтров в /people/search. По умолчанию — OR, если не указано. Полный справочник по замене ключей см. в руководстве разработчика People + Company Filters.

Если включено, перечисленные выше фильтры, поддерживающие поиск по схожести, можно заполнять произвольным текстом вместо конкретных ID.

similarity_score
number<float>

Используется вместе с is_enable_similarity_search. Это число используется для анализа того, насколько конкретный слаг (например, отрасль, технология) похож на введённый пользователем текст; чем выше число, тем строже сопоставление.

Пример:

0.7

per_page
integer
по умолчанию:25

Количество записей на странице. По умолчанию — 25, что также является пределом на большинстве тарифов — лимит определяется параметром max_search_per_page вашей подписки, который возвращает Profile. Превышение возвращает HTTP 416 с кодом 41676 (или 41613 для поиска компаний и людей), а не усечённый набор результатов.

Требуемый диапазон: x <= 25
Пример:

25

page
integer
по умолчанию:1

Номер страницы, начиная с 1. Предел определяется параметром max_search_page вашей подписки (max_company_search_page для поиска компаний), который возвращает Profile. Превышение возвращает HTTP 416.

Пример:

1

query
string

Поиск на естественном языке. Если указан, Pubrio интерпретирует его в приведённые ниже фильтры по человеку и компании (должность, уровень, отдел, местоположение, отрасль, размер компании и т. д.). Любые явно переданные фильтры имеют приоритет над интерпретированными. Оставьте пустым, чтобы искать только по структурированным фильтрам.

Пример:

"decision makers in marketing"

is_include_similar_people_titles
boolean

Если включено, people_titles также сопоставляется с близкими по смыслу должностями (например, software engineer соответствует senior software engineer), а не только с точными совпадениями.

people_title_similarity_score
number<float>

Используется вместе с is_include_similar_people_titles. Определяет, насколько точно должность должна совпадать; чем выше значение, тем строже сопоставление.

Пример:

0.9

Ответ

Успешный ответ с данными поиска людей.

metadata
object

Контекст запроса: отражённые filters и parameters, необязательный кредитный блок profile и ignored_fields (ключи тела запроса, отброшенные эндпоинтом).

data
object | null

Информация об ответе зависит от конкретного эндпоинта.