Skip to main content
POST
連絡先識別子で人物を検索

承認

pubrio-api-key
string
header
必須

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

ボディ

application/json
email
string<email>
必須

検索する仕事用または個人のメールアドレス。システムは照合前に大文字小文字と空白を正規化します。

phone
string

検索する電話番号。国際形式(E.164)を推奨します。

:

"+15551234567"

first_name
string

名(ファーストネーム)。is_enable_similarity_searchtrue のとき、last_name および domain または company と併せて使用します。

:

"King"

last_name
string

姓(ラストネーム)。is_enable_similarity_searchtrue のとき、first_name および domain または company と併せて使用します。

:

"Lai"

domain
string

会社ドメイン。is_enable_similarity_searchtrue の場合に、first_name + last_name と組み合わせて類似度検索のアンカーとして使用します。

:

"pubrio.com"

company
string

会社名。is_enable_similarity_searchtruedomain が未指定の場合に、first_name + last_name と組み合わせて類似度検索のアンカーとして使用します。

:

"Pubrio"

true の場合、メール/電話の完全一致が見つからないときに、名前ベースの類似度マッチにフォールバックします。first_namelast_name、および domain または company が必要です。

:

true

profile_id
integer

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

レスポンス

一致した人物と一致メタデータを含む正常応答。

data
object | null

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