Skip to main content
POST
類似人物を検索

承認

pubrio-api-key
string
header
必須

API で実行する操作内容と、その操作に付与された権限を識別するための一意の API トークンです。このトークンはダッシュボードの 設定 画面から発行できます。

ボディ

application/json
search_term
string

検索結果を絞り込むために使用するキーワード文字列です。

:

"pubrio"

people_name
string

指定したユーザー名に一致する人物のみが含まれるように検索結果を絞り込みます。

:

"king"

people_titles
string[]

対象人物に関連する役職名です。完全一致でなくても、類似する役職を含む結果が返されます(例:software engineersenior software engineer もヒット)。

:
peoples
string<uuid>[]

ユーザー検索処理で利用する people_search_id の一覧です。

management_levels
string[]

現在の組織におけるマネジメントレベルを示します。C レベルやシニア層など、特定のレポート階層に属する人物を絞り込むために使用します。

:
departments
string[]

特定の専門領域に属する人物を探すための部署情報です。詳細はフィルタータブの department エンドポイントを参照します。

:
department_functions
string[]

職務機能フィルターで、検索対象の職種や専門分野を指定します。詳細はフィルタータブの department functions エンドポイントを参照します。

:
employees
string[][]

企業の従業員数レンジを表します。複数レンジを指定することで、対象となる会社規模の幅を広げられます。詳細は company size エンドポイントを参照します。

:
people_locations
string[]

ユーザー(人物)の所在地を示すフィルターです。

:
company_locations
string[]

企業本社の所在地を示すフィルターです。

:
company_linkedin_urls
string[]

企業の LinkedIn 公式ページを指す完全な URL です。値は http で始まり、linkedin.com/company/ を含んでいる必要があります。

:
linkedin_urls
string[]

個人の LinkedIn プロフィールを指す完全な URL です。値は http で始まり、linkedin.com/in/ または linkedin.com/pub/ を含んでいる必要があります。

:
companies
string<uuid>[]

企業および人物検索処理で利用する domain_search_id の一覧です。

domains
string[]

企業および人物検索に使用する会社ドメインの一覧です。www や URL スキームが含まれる場合も、自動的にルートドメインへ正規化されます。

:
filter_conditions
object[]

/people/search におけるフィルターのキーごとの AND/OR 上書き。省略時のデフォルトは OR。完全なキー再マッピングのリファレンスは「人物 + 企業フィルター」開発者ガイドを参照してください。

対応するフィルターで類似度検索を有効にするフラグです。有効化すると、ID ではなく自由テキストを渡しても、内部で類似スコアに基づいて候補を解決できます。

similarity_score
number<float>

is_enable_similarity_search と併用するスコアしきい値で、業種や技術などのスラッグとユーザー入力の近さを数値で指定します。値が高いほどマッチング条件が厳しくなり、より精度の高い結果に絞り込まれます。

:

0.7

per_page
integer

1 ページあたりに返される検索結果件数です。ページサイズを制限することで、レスポンス速度や API パフォーマンスの向上が期待できます。

:

25

page
integer

取得したい結果セットのページ番号です。

:

1

profile_id
integer

オプション。リクエストを送信するチームを表す識別子です。API キーにワークスペース情報が既に含まれているため、このパラメータは必須ではなくなりました。指定した場合、検索結果が特定のチーム(ワークスペース)に紐づけられ、データ取得およびクレジット利用状況の追跡が可能になります。詳しくは、チーム関連の「ユーザー詳細」エンドポイントを参照してください。

company_filters
object

企業レベルフィルターのラッパーオブジェクト。推奨グループ化 — どのキーが人物を絞り(トップレベル)、どのキーが企業を絞るかを視覚的に分けます。トップレベルの企業フィルターと同じキーを受け付けます(例: technologiesverticalsvertical_categoriesvertical_sub_categoriescategorieskeywordsfounded_datesemployeesrevenuescompany_locationscompany_exclude_locationscompany_placescompany_exclude_placescompaniesdomainscompany_linkedin_urlsis_enable_similarity_searchsimilarity_score、および filter_conditions)。エンジンは処理前にこのオブジェクトをトップレベルに展開します — 同名キーがある場合はトップレベルが勝ちます。Monitor company_filters と同じ形状です。例はフィルター概要開発者ガイドを参照してください。

:

レスポンス

関連する詳細情報を含む成功レスポンスです。

data
object | null

エンドポイント固有のレスポンスをオブジェクト形式で格納する汎用コンテナです。