Business Contact People Page API
Paginated search for people/contacts by keyword and filters.
ENDPOINTS
POST /api/v1/businessContact/people/page
Request parameters
q_keywords
string
Search keyword — supports name, title, company name, or unlocked email.
- Required:
No - Example:
Jane Smith
person_department_or_subdepartments
array
Department or sub-department filter.
- Required:
No - Example:
[]
person_seniorities
array
Seniority level filter (e.g. "manager", "director").
- Required:
No - Example:
[]
organization_ids
array
Filter by specific company IDs.
- Required:
No - Example:
[]
organization_industry_tag_ids
array
Filter by company industry tag IDs.
- Required:
No - Example:
[]
person_locations
array
Filter by person's location.
- Required:
No - Example:
[]
current
integer
Page number. Default: 1.
- Required:
No - Example:
1
size
integer
Page size. Default: 10, max: 50.
- Required:
No - Example:
25
Request Example
{
"q_keywords": "Jane Smith",
"person_department_or_subdepartments": [],
"person_seniorities": [],
"organization_ids": [],
"organization_industry_tag_ids": [],
"person_locations": [],
"current": 1,
"size": 25
}
curl https://api.tradedata.io/api/v1/businessContact/people/page \
-H "Authorization: Bearer yourTokenHere" \
-H "Content-Type: application/json" \
-d '{"q_keywords": "Jane Smith", "person_department_or_subdepartments": [], "person_seniorities": [], "organization_ids": [], "organization_industry_tag_ids": [], "person_locations": [], "current": 1, "size": 25}'
import requests
response = requests.post(
"https://api.tradedata.io/api/v1/businessContact/people/page",
headers={
"Authorization": "Bearer yourTokenHere",
"Content-Type": "application/json",
},
json={
"q_keywords": "Jane Smith",
"person_department_or_subdepartments": [],
"person_seniorities": [],
"organization_ids": [],
"organization_industry_tag_ids": [],
"person_locations": [],
"current": 1,
"size": 25,
},
)
print(response.json())
const response = await fetch("https://api.tradedata.io/api/v1/businessContact/people/page", {
method: "POST",
headers: {
"Authorization": "Bearer yourTokenHere",
"Content-Type": "application/json",
},
body: JSON.stringify({
"q_keywords": "Jane Smith",
"person_department_or_subdepartments": [],
"person_seniorities": [],
"organization_ids": [],
"organization_industry_tag_ids": [],
"person_locations": [],
"current": 1,
"size": 25
}),
});
const data = await response.json();
<?php
$ch = curl_init("https://api.tradedata.io/api/v1/businessContact/people/page");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer yourTokenHere",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"q_keywords" => "Jane Smith",
"person_department_or_subdepartments" => [],
"person_seniorities" => [],
"organization_ids" => [],
"organization_industry_tag_ids" => [],
"person_locations" => [],
"current" => 1,
"size" => 25
]),
]);
echo curl_exec($ch);
Response parameters
data
array
List of matching people.
data.id
string
Person ID (same as person_id).
- Example:
5a1b2c3d4e5f000000000003
data.person_id
string
Person ID for use in other endpoints.
- Example:
5a1b2c3d4e5f000000000003
data.name
string
Full name.
- Example:
Jane Smith
data.first_name
string
First name.
- Example:
Jane
data.last_name
string
Last name.
- Example:
Smith
data.title
string
Job title.
- Example:
National Operations Manager
data.email
string
Email address. Empty string if locked.
data.emailLocked
boolean
Whether the email is locked.
- Example:
true
data.email_status
string
Email verification status.
- Example:
verified
data.phoneLocked
boolean
Whether the phone is locked.
- Example:
true
data.personalPhoneStatus
integer
Phone unlock status. 0 = initial, 1 = pending, 2 = done.
- Example:
0
data.organization_name
string
Company name.
data.organization
object
Company details (id, name, website, domain, industries, etc.).
data.country
string
Country.
- Example:
Canada
data.city
string
City.
- Example:
Vancouver
data.state
string
State or province.
- Example:
British Columbia
data.seniority
string
Seniority level.
- Example:
manager
data.departments
array
Department list.
- Example:
["master_operations"]
data.linkedin_url
string
LinkedIn profile URL.
total
integer
Total matching records.
- Example:
202
Response Example
{
"code": 200,
"success": true,
"data": [
{
"next_contact_id": null,
"country": "Canada",
"city": "Vancouver",
"title": "National Operations Manager",
"id": "5a1b2c3d4e5f000000000003",
"state": "British Columbia",
"departments": [
"master_operations"
],
"first_name": "Jane",
"headline": "National Operations Manager at Acme Corp",
"email": "",
"person_id": "5a1b2c3d4e5f000000000003",
"emailLocked": true,
"revealed_for_current_team": true,
"last_name": "Smith",
"organization_name": null,
"email_status": "verified",
"personalPhoneStatus": 0,
"phone_numbers": [],
"organization_id": "5b1b2c3d4e5f000000000002",
"organization": {
"estimated_num_employees": 85,
"website_url": "http://www.olliequinn.com",
"sanitized_phone": "+15550000000",
"phone": "+1 555-000-0000",
"industries": [
"retail"
],
"founded_year": 2017,
"name": "Acme Corp",
"id": "5b1b2c3d4e5f000000000002",
"linkedin_url": "https://www.linkedin.com/company/example-corp"
},
"name": "Jane Smith",
"phoneLocked": true,
"linkedin_url": "https://www.linkedin.com/in/example-profile",
"seniority": "manager"
}
],
"msg": "OK",
"total": 202,
"pageSize": 9,
"current": 0,
"sumResult": null
}