メインコンテンツへスキップ
POST
/
redeem
/
people
/
batch
/
query
cURL
curl --request POST \
  --url https://api.pubrio.com/redeem/people/batch/query \
  --header 'Content-Type: application/json' \
  --header 'pubrio-api-key: <api-key>' \
  --data '
{
  "profile_id": 123,
  "redeem_query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "data": {
    "profile": {
      "credit": 450376,
      "topup_credit": 235237,
      "total_charged_credit": 465
    },
    "query": {
      "redeem_query_id": "a046c1da-b3d4-4ca1-aca6-1dd8c8055701",
      "is_completed": true,
      "estimated_time": 6,
      "estimated_time_type": "second"
    },
    "peoples": [
      {
        "people_search_id": "540574d1-ff74-475b-aea2-f8ae643b806d",
        "emails": [
          {
            "value": "[email protected]",
            "type": "email-personal",
            "status": null
          },
          {
            "value": "[email protected]",
            "type": "email-work",
            "status": "Verified"
          }
        ],
        "phones": [
          {
            "value": "+1123456789",
            "type": "phone",
            "status": null
          }
        ]
      },
      "..."
    ]
  }
}

Authorizations

​
pubrio-api-key
string
header
required

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

Body

application/json
​
profile_id
integer
required

リクエストを送信するチームを表す識別子です。この ID によって検索結果が特定のチーム（ワークスペース）に紐づけられ、データ取得およびクレジット利用状況の追跡が可能になります。詳しくは、チーム関連の「ユーザー詳細」エンドポイントを参照してください。

​
redeem_query_id
string<uuid>
required

バッチリディーム要求を送信した際に返される ID で、後続の結果取得に使用します。

Response

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

​
data
object

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