Skip to main content
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

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
profile_id
integer
required

An identifier for the user profile (workspace) making the request. This ID helps in associating the lookup with a specific user, allowing for data retrieval and credit tracking.

Check out user details endpoints under the Profile tab for more information.

redeem_query_id
string<uuid>
required

When a bulk redeem request is initiated, a redeem_query_id is returned, which can be used here to retrieve the results.

Response

Successful response containing bulk redeem people details.

data
object | null

Response info depends on specific endpoint.