Responses
Partial Contact Search Response
When the request setting "reveal_all_data" is false, the contact returned will not be charged against your credit balance.
Complete Contact Search Response
When the request setting "reveal_all_data" is activated, each contact returned will be charged as one contact record credit against your credit balance.
All counts provided in the counts node are an approximation of the number of records.
{
"query": {
"reveal_all_data": "boolean",
"page_size": "integer",
"page_number": "integer",
"parameters": {
}
},
"counts": {
"companies_total_results": "integer",
"companies_total_returned": "integer",
"offices_total_results": "integer",
"offices_total_returned": "integer",
"technologies_total_results": "integer",
"technologies_total_returned": "integer",
"profiles_total_results": "integer",
"profiles_total_returned": "integer",
"contacts_total_results": "integer",
"contacts_total_returned": "integer"
},
"results": [
{
"position": "integer",
"contact_data": {
"summary": "string",
"company_id": "string",
"job_functions": [
{
"level1": {
"code": "string",
"confidence_score": "float",
"name": "string"
}
}
],
"office_industries": [
{
"code4": "string",
"standard": "string",
"code3": "string",
"code2": "string",
"activity_priority": "long",
"priority": "long",
"code6": "string",
"code5": "string",
"name6": "string",
"name5": "string",
"name4": "string",
"name3": "string",
"id": "string",
"name2": "string"
}
],
"contact_id": "string",
"priority": "long",
"company_address": {
"continent": "string",
"statistical_area": {
"cbsa_name": "string",
"cbsa_code": "string"
},
"country": "string",
"street_address": "string",
"formatted_address": "string",
"city": "string",
"county": "string",
"accuracy": "string",
"last_modified_date": "string (YYYY-MM-DD HH:MM:SS)",
"score": "float",
"premise": "string",
"street": "string",
"state": "string",
"lat": "float",
"place_id": "string",
"postal_town": "string",
"lng": "float",
"locality": "string",
"sublocality": "string",
"establishment": "string",
"subpremise": "string",
"quality": "string",
"country_code": "string",
"administrative_area_level_2": "string",
"administrative_area_level_3": "string",
"administrative_area_level_1": "string",
"confidence_score": "float",
"street_number": "string",
"administrative_area_level_4": "string",
"administrative_area_level_5": "string",
"postal_code": "string",
"region": "string",
"state_code": "string"
},
"contact_last_modified_date": "string (YYYY-MM-DD HH:MM:SS)",
"office_id": "string",
"company_web_address": {
"url": "string"
},
"contact_tags": [
"string"
],
"office_address": {
"region": "string"
},
"company_name": "string",
"contact_last_name": "string",
"contact_social_links": [
{
"status_last_verification_date": "string (YYYY-MM-DD HH:MM:SS)",
"name": "string",
"url": "string",
"status": "string"
}
],
"company_industries": [
{
"code4": "string",
"standard": "string",
"code3": "string",
"code2": "string",
"activity_priority": "long",
"priority": "long",
"code6": "string",
"code5": "string",
"name6": "string",
"name5": "string",
"name4": "string",
"name3": "string",
"id": "string",
"name2": "string"
}
],
"contact_first_name": "string",
"job_title": "string",
"start_date": "string (YYYY-MM-DD HH:MM:SS.SSS)",
"contact_country": "string"
}
}
],
"pagination": {
"current": "integer",
"last_page": "integer",
"next_page": "integer"
},
"transaction_detail": {
"id": "string",
"account_number": "string",
"account_type": "string",
"product_name": "string",
"endpoint": "string",
"contact_record_credits_used": "integer",
"contact_record_credits_available": "integer",
"execute_at": "string (YYYY-MM-DD HH:MM:SS)",
"total_time_taken": "float"
}
}
{
"query": {
"reveal_all_data": "boolean",
"page_size": "integer",
"page_number": "integer",
"parameters": {
}
},
"counts": {
"companies_total_results": "integer",
"companies_total_returned": "integer",
"offices_total_results": "integer",
"offices_total_returned": "integer",
"technologies_total_results": "integer",
"technologies_total_returned": "integer",
"profiles_total_results": "integer",
"profiles_total_returned": "integer",
"contacts_total_results": "integer",
"contacts_total_returned": "integer"
},
"results": [
{
"position": "integer",
"contact_data": {
"company_logo_url": "string",
"office_type": "string",
"contact_emails": [
{
"email": "string",
"reason": "string",
"type": "string"
}
],
"company_revenue_in_usd": "long",
"office_phones": [
{
"carrier": "string",
"ddi": "boolean",
"dnc": "boolean",
"phone": "string",
"priority": "long",
"score": "long",
"status": "string",
"status_last_verification_date": "string (yyyy-MM-dd HH:mm:ss.SSS Z)",
"type": "string"
}
],
"office_industries": [
{
"code4": "string",
"standard": "string",
"code3": "string",
"code2": "string",
"activity_priority": "integer",
"priority": "long",
"code6": "string",
"code5": "string",
"name6": "string",
"name5": "string",
"name4": "string",
"name3": "string",
"id": "string",
"name2": "string"
}
],
"contact_id": "string",
"contact_languages": [
"string"
],
"company_address": {
"continent": "string",
"statistical_area": {
"cbsa_name": "string",
"cbsa_code": "string"
},
"country": "string",
"street_address": "string",
"formatted_address": "string",
"city": "string",
"county": "string",
"accuracy": "string",
"last_modified_date": "string (YYYY-MM-DD HH:MM:SS)",
"score": "float",
"premise": "string",
"street": "string",
"state": "string",
"lat": "float",
"place_id": "string",
"postal_town": "string",
"lng": "float",
"locality": "string",
"sublocality": "string",
"establishment": "string",
"subpremise": "string",
"quality": "string",
"country_code": "string",
"administrative_area_level_2": "string",
"administrative_area_level_3": "string",
"administrative_area_level_1": "string",
"confidence_score": "float",
"street_number": "string",
"administrative_area_level_4": "string",
"administrative_area_level_5": "string",
"postal_code": "string",
"region": "string",
"state_code": "string"
},
"company_financials": [
{
"yearly_growth": {
"score": "string",
"code": "string",
"year": "long",
"percentage": "float",
"type": "string"
},
"yearly_revenue": {
"reported_date": "string (YYYY-MM-DD)",
"score": "string",
"revenue": "float",
"code": "string",
"year": "long",
"currency": "string",
"type": "string"
},
"priority": "integer"
}
],
"contact_last_modified_date": "string (YYYY-MM-DD HH:MM:SS)",
"office_id": "string",
"company_domain": "string",
"contact_last_name": "string",
"contact_social_links": [
{
"status_last_verification_date": "string (yyyy-MM-dd HH:mm:ss.SSS Z)",
"name": "string",
"url": "string",
"status": "string"
}
],
"company_industries": [
{
"code4": "string",
"standard": "string",
"code3": "string",
"code2": "string",
"activity_priority": "integer",
"priority": "integer",
"code6": "string",
"code5": "string",
"name6": "string",
"name5": "string",
"name4": "string",
"name3": "string",
"id": "string",
"name2": "string"
}
],
"contact_address": {
"continent": "string",
"statistical_area": {
"cbsa_name": "string",
"cbsa_code": "string"
},
"country": "string",
"street_address": "string",
"formatted_address": "string",
"city": "string",
"county": "string",
"accuracy": "string",
"last_modified_date": "string (YYYY-MM-DD HH:MM:SS)",
"score": "float",
"premise": "string",
"street": "string",
"state": "string",
"lat": "float",
"place_id": "string",
"postal_town": "string",
"lng": "float",
"locality": "string",
"sublocality": "string",
"establishment": "string",
"subpremise": "string",
"quality": "string",
"country_code": "string",
"administrative_area_level_2": "string",
"administrative_area_level_3": "string",
"administrative_area_level_1": "string",
"confidence_score": "float",
"street_number": "string",
"administrative_area_level_4": "string",
"administrative_area_level_5": "string",
"postal_code": "string",
"region": "string",
"state_code": "string"
},
"contact_first_name": "string",
"job_title": "string",
"contact_phones": [
{
"carrier": "string",
"phone": "string",
"ddi": "boolean",
"dnc": "boolean",
"priority": "long",
"type": "string"
}
],
"start_date": "string (yyyy-MM-dd HH:mm:ss.SSS)",
"summary": "string",
"company_id": "string",
"company_revenue_in_usd_code": "string",
"job_seniority": {
"job_level": "string"
},
"contact_still_at_company_status": "string",
"job_functions": [
{
"level1": {
"code": "string",
"confidence_score": "float",
"name": "string"
},
"priority": "long",
"level3": {
"code": "string",
"confidence_score": "float",
"name": "string"
},
"level2": {
"code": "string",
"confidence_score": "float",
"name": "string"
}
}
],
"company_phones": [
{
"carrier": "string",
"phone": "string",
"ddi": "boolean",
"dnc": "boolean",
"priority": "long",
"type": "string"
}
],
"priority": "long",
"company_social_links": {
"crunchbase": {
"url": "string",
},
"youtube": {
"url": "string",
},
"twitter": {
"url": "string",
},
"facebook": {
"url": "string",
},
"yelp": {
"url": "string",
},
"instagram": {
"url": "string",
},
"linkedin": {
"url": "string",
}
},
"company_employees": {
"number_of_employees": "long",
"number_of_employees_max": "long",
"number_of_employees_min": "long",
"number_of_employees_code": "string"
},
"company_industry": "string",
"company_web_address": {
"rank": "long",
"url": "string"
},
"contact_tags": [
"string"
],
"office_address": {
"continent": "string",
"statistical_area": {
"cbsa_name": "string",
"cbsa_code": "string"
},
"country": "string",
"street_address": "string",
"formatted_address": "string",
"city": "string",
"county": "string",
"accuracy": "string",
"last_modified_date": "string (YYYY-MM-DD HH:MM:SS)",
"score": "float",
"premise": "string",
"street": "string",
"state": "string",
"lat": "float",
"place_id": "string",
"postal_town": "string",
"lng": "float",
"locality": "string",
"sublocality": "string",
"establishment": "string",
"subpremise": "string",
"quality": "string",
"country_code": "string",
"administrative_area_level_2": "string",
"administrative_area_level_3": "string",
"administrative_area_level_1": "string",
"confidence_score": "float",
"street_number": "string",
"administrative_area_level_4": "string",
"administrative_area_level_5": "string",
"postal_code": "string",
"region": "string"
},
"profile_id": "string",
"company_name": "string",
"raw_location": "string",
"job_title_details": {
"normalized_job_title": {
"id": "long",
"job_title": "string"
},
"raw_job_title": {
"language_code": "string",
"language_detection_confidence_score": "float",
"job_title": "string"
},
"raw_translated_job_title": {
"language_code": "string",
"job_title": "string"
}
},
"contact_country": "string"
}
}
],
"pagination": {
"current": "integer",
"last_page": "integer",
"next_page": "integer"
},
"transaction_detail": {
"id": "string",
"account_number": "string",
"account_type": "string",
"product_name": "string",
"endpoint": "string",
"contact_record_credits_used": "integer",
"contact_record_credits_available": "integer",
"execute_at": "string (YYYY-MM-DD HH:MM:SS)",
"total_time_taken": "float"
}
}
Updated 9 days ago