Partner with ReachStream using Reach API
Reach API provides advance search capability focused on people, companies, and their relationships. It allows you to integrate ReachStream’s functionality and data into your developer ecosystem, including your CRM (Customer Relationship Management), MA tool (Marketing Automation), or other data system (cloud-based tools).
The contact and company data available via the Reach API is the same data accessible within the ReachStream platform. This means the API’s data undergo the same scrutiny of accuracy, standardization, and verification that our customers are used to on the ReachStream online platform.
The Reach API is available as REST web service calls via HTTP requests. To meet the demands of data for your organization our Business Development representative will discuss the needs and suggest a set of APIs as part of a solution package. All API’s are available in a developer portal, where the user can browse the schemas (models) for each API, read the documentation, and are given the ability to ‘Try out’ APIs.
Contact us now to get started on integrating with highly accurate contact leads to take your business to the next level.
Reach API Overview-
The Reach API is a set of REST oriented web services that provide access to information via HTTP requests. Our API has predictable resource-oriented URLs, accepts standard headers, accepts and returns JSON responses, and uses standard HTTP response codes, authentication, and verbs.
The Reach API also describes it’s JSON payloads using well-formed schema to provide a deterministic programming experience.
Reach API requests or calls are made through properly formed URLs. The URLs are created manually or programmatically. There are several elements to the URL that need to be composed correctly to request to succeed and return data. This article’s remainder provides an overview of the Reach API, onboarding, usage, and other details to get started.
Subscribe to Reach API announce mailing list for updates.
Developer Portal
- Log in using secure credentials to view available APIs.
- Read the developer documentation for each API.
- View the schema (models) for each API.
- ‘Try out’ each API interactively to test and grasp the usage of each API.
- Access their developer API key to authenticate each request.
- Observe the remaining quota for each API.
- Provide feedback and ask support questions.
Categories of Reach APIs
Contact ReachID APIs
These APIs returns individual contacts, given the Contacts unique ReachID. This API is used when you have a Contact ReachID. The Reach API includes two types of API, one showing the availability of information for a contact, and the second giving all data for a contact.
Contact ReachID Query
This API will return the fields available for a Contact ReachID. The availability of the data field is shown, and the data is masked.
QUERY EXAMPLE
curl -X GET
“https://yourcompany-api.reachstream.com/reach_id_query?reach_id=123”
-H “accept: application/json”
-H “x-api-key: XXXXXXXXXX”
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Available”,
“country_name”: “Available”,
“region”: “Available”,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“contact_company”: {
“acquisition_amount”: “Available”,
“acquisition_company_name”: “Available”,
“acquisition_date”: “Available”,
“annual_revenue_amount”: “Available”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Available”,
“country_name”: “Available”,
“region”: null,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “Available”,
“company_social_media”: “Available”,
“created_at”: “Available”,
“created_by”: “Available”,
“description”: “Available”,
“employee_size”: “Available”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “Available”,
“projected_revenue_amount”: “Available”,
“projected_revenue_period_in_years”: “Available”,
“public_status”: null,
“sic_code”: “Available”,
“tech_keywords”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”,
“website”: “Available”
},
“contact_emails”: [
{
“email”: “******@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “Available”,
“created_by”: “Available”,
“end_date”: “Available”,
“job_dept”: “Available”,
“job_function”: “Available”,
“job_role”: “Available”,
“job_title”: “Available”,
“job_title_level”: “Available”,
“reporting_authority”: “Available”,
“start_date”: “Available”,
“updated_at”: “Available”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “Available”,
“contact_social_media”: [],
“created_at”: “Available”,
“created_by”: “Available”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”
}
],
“totalResultsCount”: 1
}
curl -X GET
“https://yourcompany-api.reachstream.com/reach_id_query?reach_id=123”
-H “accept: application/json”
-H “x-api-key: XXXXXXXXXX”
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Available”,
“country_name”: “Available”,
“region”: “Available”,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“contact_company”: {
“acquisition_amount”: “Available”,
“acquisition_company_name”: “Available”,
“acquisition_date”: “Available”,
“annual_revenue_amount”: “Available”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Available”,
“country_name”: “Available”,
“region”: null,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “Available”,
“company_social_media”: “Available”,
“created_at”: “Available”,
“created_by”: “Available”,
“description”: “Available”,
“employee_size”: “Available”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “Available”,
“projected_revenue_amount”: “Available”,
“projected_revenue_period_in_years”: “Available”,
“public_status”: null,
“sic_code”: “Available”,
“tech_keywords”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”,
“website”: “Available”
},
“contact_emails”: [
{
“email”: “******@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “Available”,
“created_by”: “Available”,
“end_date”: “Available”,
“job_dept”: “Available”,
“job_function”: “Available”,
“job_role”: “Available”,
“job_title”: “Available”,
“job_title_level”: “Available”,
“reporting_authority”: “Available”,
“start_date”: “Available”,
“updated_at”: “Available”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “Available”,
“contact_social_media”: [],
“created_at”: “Available”,
“created_by”: “Available”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”
}
],
“totalResultsCount”: 1
}
RESPONSE TEMPLATE
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “123 Main Street”,
“zip_code”: “60610”
},
“contact_company”: {
“acquisition_amount”: “$3,000,000”,
“acquisition_company_name”: “FooBar LLC”,
“acquisition_date”: “December 1, 2019”,
“annual_revenue_amount”: “$1,000,000”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “456 Main Street”,
“zip_code”: “60610”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “456”,
“company_social_media”: [
“https://twitter.com/foobarLLC”
],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“description”: “Industry leader in XYZ”,
“employee_size”: “50-100”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “53”,
“projected_revenue_amount”: “$600,000”,
“projected_revenue_period_in_years”: “5”,
“public_status”: null,
“sic_code”: “8742”,
“tech_keywords”: [
“Java”,
“Kafka”,
“Oracle”
],
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”,
“website”: “yournextcustomer.org”
},
“contact_emails”: [
{
“email”: “john.smith@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“end_date”: null,
“job_dept”: “Engineering”,
“job_function”: “Research”,
“job_role”: “Scientist”,
“job_title”: “Software Engineer”,
“job_title_level”: “Senior”,
“reporting_authority”: “Manager”,
“start_date”: “December 1, 2019”,
“updated_at”: “December 1, 2019”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “555-555-5656”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “123”,
“contact_social_media”: [],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Mike”,
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”
}
],
“totalResultsCount”: 1
}
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “123 Main Street”,
“zip_code”: “60610”
},
“contact_company”: {
“acquisition_amount”: “$3,000,000”,
“acquisition_company_name”: “FooBar LLC”,
“acquisition_date”: “December 1, 2019”,
“annual_revenue_amount”: “$1,000,000”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “456 Main Street”,
“zip_code”: “60610”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “456”,
“company_social_media”: [
“https://twitter.com/foobarLLC”
],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“description”: “Industry leader in XYZ”,
“employee_size”: “50-100”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “53”,
“projected_revenue_amount”: “$600,000”,
“projected_revenue_period_in_years”: “5”,
“public_status”: null,
“sic_code”: “8742”,
“tech_keywords”: [
“Java”,
“Kafka”,
“Oracle”
],
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”,
“website”: “yournextcustomer.org”
},
“contact_emails”: [
{
“email”: “john.smith@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“end_date”: null,
“job_dept”: “Engineering”,
“job_function”: “Research”,
“job_role”: “Scientist”,
“job_title”: “Software Engineer”,
“job_title_level”: “Senior”,
“reporting_authority”: “Manager”,
“start_date”: “December 1, 2019”,
“updated_at”: “December 1, 2019”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “555-555-5656”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “123”,
“contact_social_media”: [],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Mike”,
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”
}
],
“totalResultsCount”: 1
}
Contact ReachID Data
This API will return the full unmasked information for a Contact ReachID. The contact information can directly be used by the user’s business organization.
QUERY EXAMPLE
curl -X GET
“https://yourcompany-api.reachstream.com/reach_id_data?reach_id=123”
-H “accept: application/json”
-H “x-api-key: XXXXXXXXXX”
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Available”,
“country_name”: “Available”,
“region”: “Available”,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“contact_company”: {
“acquisition_amount”: “Available”,
“acquisition_company_name”: “Available”,
“acquisition_date”: “Available”,
“annual_revenue_amount”: “Available”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Available”,
“country_name”: “Available”,
“region”: null,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “Available”,
“company_social_media”: “Available”,
“created_at”: “Available”,
“created_by”: “Available”,
“description”: “Available”,
“employee_size”: “Available”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “Available”,
“projected_revenue_amount”: “Available”,
“projected_revenue_period_in_years”: “Available”,
“public_status”: null,
“sic_code”: “Available”,
“tech_keywords”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”,
“website”: “Available”
},
“contact_emails”: [
{
“email”: “******@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “Available”,
“created_by”: “Available”,
“end_date”: “Available”,
“job_dept”: “Available”,
“job_function”: “Available”,
“job_role”: “Available”,
“job_title”: “Available”,
“job_title_level”: “Available”,
“reporting_authority”: “Available”,
“start_date”: “Available”,
“updated_at”: “Available”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “Available”,
“contact_social_media”: [],
“created_at”: “Available”,
“created_by”: “Available”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”
}
],
“totalResultsCount”: 1
}
curl -X GET
“https://yourcompany-api.reachstream.com/reach_id_data?reach_id=123”
-H “accept: application/json”
-H “x-api-key: XXXXXXXXXX”
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Available”,
“country_name”: “Available”,
“region”: “Available”,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“contact_company”: {
“acquisition_amount”: “Available”,
“acquisition_company_name”: “Available”,
“acquisition_date”: “Available”,
“annual_revenue_amount”: “Available”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Available”,
“country_name”: “Available”,
“region”: null,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “Available”,
“company_social_media”: “Available”,
“created_at”: “Available”,
“created_by”: “Available”,
“description”: “Available”,
“employee_size”: “Available”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “Available”,
“projected_revenue_amount”: “Available”,
“projected_revenue_period_in_years”: “Available”,
“public_status”: null,
“sic_code”: “Available”,
“tech_keywords”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”,
“website”: “Available”
},
“contact_emails”: [
{
“email”: “******@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “Available”,
“created_by”: “Available”,
“end_date”: “Available”,
“job_dept”: “Available”,
“job_function”: “Available”,
“job_role”: “Available”,
“job_title”: “Available”,
“job_title_level”: “Available”,
“reporting_authority”: “Available”,
“start_date”: “Available”,
“updated_at”: “Available”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “Available”,
“contact_social_media”: [],
“created_at”: “Available”,
“created_by”: “Available”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”
}
],
“totalResultsCount”: 1
}
RESPONSE TEMPLATE
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “123 Main Street”,
“zip_code”: “60610”
},
“contact_company”: {
“acquisition_amount”: “$3,000,000”,
“acquisition_company_name”: “FooBar LLC”,
“acquisition_date”: “December 1, 2019”,
“annual_revenue_amount”: “$1,000,000”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “456 Main Street”,
“zip_code”: “60610”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “456”,
“company_social_media”: [
“https://twitter.com/foobarLLC”
],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“description”: “Industry leader in XYZ”,
“employee_size”: “50-100”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “53”,
“projected_revenue_amount”: “$600,000”,
“projected_revenue_period_in_years”: “5”,
“public_status”: null,
“sic_code”: “8742”,
“tech_keywords”: [
“Java”,
“Kafka”,
“Oracle”
],
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”,
“website”: “yournextcustomer.org”
},
“contact_emails”: [
{
“email”: “john.smith@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“end_date”: null,
“job_dept”: “Engineering”,
“job_function”: “Research”,
“job_role”: “Scientist”,
“job_title”: “Software Engineer”,
“job_title_level”: “Senior”,
“reporting_authority”: “Manager”,
“start_date”: “December 1, 2019”,
“updated_at”: “December 1, 2019”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “555-555-5656”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “123”,
“contact_social_media”: [],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Mike”,
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”
}
],
“totalResultsCount”: 1
}
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “123 Main Street”,
“zip_code”: “60610”
},
“contact_company”: {
“acquisition_amount”: “$3,000,000”,
“acquisition_company_name”: “FooBar LLC”,
“acquisition_date”: “December 1, 2019”,
“annual_revenue_amount”: “$1,000,000”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “456 Main Street”,
“zip_code”: “60610”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “456”,
“company_social_media”: [
“https://twitter.com/foobarLLC”
],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“description”: “Industry leader in XYZ”,
“employee_size”: “50-100”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “53”,
“projected_revenue_amount”: “$600,000”,
“projected_revenue_period_in_years”: “5”,
“public_status”: null,
“sic_code”: “8742”,
“tech_keywords”: [
“Java”,
“Kafka”,
“Oracle”
],
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”,
“website”: “yournextcustomer.org”
},
“contact_emails”: [
{
“email”: “john.smith@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“end_date”: null,
“job_dept”: “Engineering”,
“job_function”: “Research”,
“job_role”: “Scientist”,
“job_title”: “Software Engineer”,
“job_title_level”: “Senior”,
“reporting_authority”: “Manager”,
“start_date”: “December 1, 2019”,
“updated_at”: “December 1, 2019”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “555-555-5656”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “123”,
“contact_social_media”: [],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Mike”,
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”
}
],
“totalResultsCount”: 1
}
Contact APIs
These APIs operate using filters that target a specific contact details. For example, you may be looking for a contact with a specific email address or a job title. The Contact API’s make use of contact-oriented filters to narrow down potential contacts.
Contact API Query
The Contact API Query performs a search using contact details such as name and job title and returns a set of matching contacts. The user can apply a comprehensive set of filters to narrow down to a well-defined list of contacts, or a specific contact. This will enable for subsequential API calls using the Contact ReachID Data to obtain a full and comprehensive set of contact information.
| Parameter | Description |
|---|---|
|
first_names |
List of first names to query against. - String |
|
last_names |
List of last names to query against. - String |
|
job_titles |
List of job titles to query against. This is a pre-defined filter with a normalized list of search words. - String |
|
emails |
List of email addresses to query against. - String |
|
phones |
List of phone numbers to query against. - String |
|
company_names |
List of company names to query against. - String |
|
pageNumber |
minimum: 1 Response back paginated with 20 records per page, and this parameter sets the page to receive. Note: The search result for a filter query can have max 10,000 records, and the page number starts at 1 and continue till max 500 (500*20). – Integer |
QUERY EXAMPLE
curl -X GET
“https://yourcompany-api.reachstream.com/contact_query”
-H “accept: application/json”
-H “x-api-key: XXXXXXXXXX”
-H “Content-Type: application/json”
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Available”,
“country_name”: “Available”,
“region”: “Available”,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“contact_company”: {
“acquisition_amount”: “Available”,
“acquisition_company_name”: “Available”,
“acquisition_date”: “Available”,
“annual_revenue_amount”: “Available”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Available”,
“country_name”: “Available”,
“region”: null,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “Available”,
“company_social_media”: “Available”,
“created_at”: “Available”,
“created_by”: “Available”,
“description”: “Available”,
“employee_size”: “Available”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “Available”,
“projected_revenue_amount”: “Available”,
“projected_revenue_period_in_years”: “Available”,
“public_status”: null,
“sic_code”: “Available”,
“tech_keywords”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”,
“website”: “Available”
},
“contact_emails”: [
{
“email”: “******@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “Available”,
“created_by”: “Available”,
“end_date”: “Available”,
“job_dept”: “Available”,
“job_function”: “Available”,
“job_role”: “Available”,
“job_title”: “Available”,
“job_title_level”: “Available”,
“reporting_authority”: “Available”,
“start_date”: “Available”,
“updated_at”: “Available”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “Available”,
“contact_social_media”: [],
“created_at”: “Available”,
“created_by”: “Available”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”
}
],
“totalResultsCount”: 200
}
curl -X GET
“https://yourcompany-api.reachstream.com/contact_query”
-H “accept: application/json”
-H “x-api-key: XXXXXXXXXX”
-H “Content-Type: application/json”
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Available”,
“country_name”: “Available”,
“region”: “Available”,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“contact_company”: {
“acquisition_amount”: “Available”,
“acquisition_company_name”: “Available”,
“acquisition_date”: “Available”,
“annual_revenue_amount”: “Available”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Available”,
“country_name”: “Available”,
“region”: null,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “Available”,
“company_social_media”: “Available”,
“created_at”: “Available”,
“created_by”: “Available”,
“description”: “Available”,
“employee_size”: “Available”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “Available”,
“projected_revenue_amount”: “Available”,
“projected_revenue_period_in_years”: “Available”,
“public_status”: null,
“sic_code”: “Available”,
“tech_keywords”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”,
“website”: “Available”
},
“contact_emails”: [
{
“email”: “******@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “Available”,
“created_by”: “Available”,
“end_date”: “Available”,
“job_dept”: “Available”,
“job_function”: “Available”,
“job_role”: “Available”,
“job_title”: “Available”,
“job_title_level”: “Available”,
“reporting_authority”: “Available”,
“start_date”: “Available”,
“updated_at”: “Available”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “Available”,
“contact_social_media”: [],
“created_at”: “Available”,
“created_by”: “Available”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”
}
],
“totalResultsCount”: 200
}
RESPONSE TEMPLATE
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “123 Main Street”,
“zip_code”: “60610”
},
“contact_company”: {
“acquisition_amount”: “$3,000,000”,
“acquisition_company_name”: “FooBar LLC”,
“acquisition_date”: “December 1, 2019”,
“annual_revenue_amount”: “$1,000,000”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “456 Main Street”,
“zip_code”: “60610”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “456”,
“company_social_media”: [
“https://twitter.com/foobarLLC”
],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“description”: “Industry leader in XYZ”,
“employee_size”: “50-100”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “53”,
“projected_revenue_amount”: “$600,000”,
“projected_revenue_period_in_years”: “5”,
“public_status”: null,
“sic_code”: “8742”,
“tech_keywords”: [
“Java”,
“Kafka”,
“Oracle”
],
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”,
“website”: “yournextcustomer.org”
},
“contact_emails”: [
{
“email”: “john.smith@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“end_date”: null,
“job_dept”: “Engineering”,
“job_function”: “Research”,
“job_role”: “Scientist”,
“job_title”: “Software Engineer”,
“job_title_level”: “Senior”,
“reporting_authority”: “Manager”,
“start_date”: “December 1, 2019”,
“updated_at”: “December 1, 2019”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “555-555-5656”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “123”,
“contact_social_media”: [],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Mike”,
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”
}
],
“totalResultsCount”: 200
}
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “123 Main Street”,
“zip_code”: “60610”
},
“contact_company”: {
“acquisition_amount”: “$3,000,000”,
“acquisition_company_name”: “FooBar LLC”,
“acquisition_date”: “December 1, 2019”,
“annual_revenue_amount”: “$1,000,000”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “456 Main Street”,
“zip_code”: “60610”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “456”,
“company_social_media”: [
“https://twitter.com/foobarLLC”
],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“description”: “Industry leader in XYZ”,
“employee_size”: “50-100”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “53”,
“projected_revenue_amount”: “$600,000”,
“projected_revenue_period_in_years”: “5”,
“public_status”: null,
“sic_code”: “8742”,
“tech_keywords”: [
“Java”,
“Kafka”,
“Oracle”
],
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”,
“website”: “yournextcustomer.org”
},
“contact_emails”: [
{
“email”: “john.smith@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“end_date”: null,
“job_dept”: “Engineering”,
“job_function”: “Research”,
“job_role”: “Scientist”,
“job_title”: “Software Engineer”,
“job_title_level”: “Senior”,
“reporting_authority”: “Manager”,
“start_date”: “December 1, 2019”,
“updated_at”: “December 1, 2019”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “555-555-5656”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “123”,
“contact_social_media”: [],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Mike”,
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”
}
],
“totalResultsCount”: 200
}
Contact API Data
The Contact API Data performs a search using contact details such as name and job title and returns a set of matching contacts. The user can apply a comprehensive set of filters to narrow down to a well-defined list of contacts, or a specific contact. This query gives the full information on all the contacts returned.
| Parameter | Description |
|---|---|
|
first_names |
List of first names to query against. - String |
|
last_names |
List of last names to query against. - String |
|
job_titles |
List of job titles to query against. This filter uses a pre-defined and normalized list of job titles. - string |
|
emails |
List of email addresses to query against. - String |
|
phones |
List of phone numbers to query against. - String |
|
company_names |
List of company names to query against. - String |
|
pageNumber |
minimum: 1 Response back paginated with 20 records per page, and this parameter sets the page to receive. Note: The search result for a filter query can have max 10,000 records, and the page number starts at 1 and continue till max 500 (500*20). – Integer |
QUERY EXAMPLE
curl -X GET
“https://yourcompany-api.reachstream.com/contact_data”
-H “accept: application/json”
-H “x-api-key: XXXXXXXXXX”
-H “Content-Type: application/json”
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Available”,
“country_name”: “Available”,
“region”: “Available”,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“contact_company”: {
“acquisition_amount”: “Available”,
“acquisition_company_name”: “Available”,
“acquisition_date”: “Available”,
“annual_revenue_amount”: “Available”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Available”,
“country_name”: “Available”,
“region”: null,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “Available”,
“company_social_media”: “Available”,
“created_at”: “Available”,
“created_by”: “Available”,
“description”: “Available”,
“employee_size”: “Available”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “Available”,
“projected_revenue_amount”: “Available”,
“projected_revenue_period_in_years”: “Available”,
“public_status”: null,
“sic_code”: “Available”,
“tech_keywords”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”,
“website”: “Available”
},
“contact_emails”: [
{
“email”: “******@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “Available”,
“created_by”: “Available”,
“end_date”: “Available”,
“job_dept”: “Available”,
“job_function”: “Available”,
“job_role”: “Available”,
“job_title”: “Available”,
“job_title_level”: “Available”,
“reporting_authority”: “Available”,
“start_date”: “Available”,
“updated_at”: “Available”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “Available”,
“contact_social_media”: [],
“created_at”: “Available”,
“created_by”: “Available”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”
}
],
“totalResultsCount”: 200
}
curl -X GET
“https://yourcompany-api.reachstream.com/contact_data”
-H “accept: application/json”
-H “x-api-key: XXXXXXXXXX”
-H “Content-Type: application/json”
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Available”,
“country_name”: “Available”,
“region”: “Available”,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“contact_company”: {
“acquisition_amount”: “Available”,
“acquisition_company_name”: “Available”,
“acquisition_date”: “Available”,
“annual_revenue_amount”: “Available”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Available”,
“country_name”: “Available”,
“region”: null,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “Available”,
“company_social_media”: “Available”,
“created_at”: “Available”,
“created_by”: “Available”,
“description”: “Available”,
“employee_size”: “Available”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “Available”,
“projected_revenue_amount”: “Available”,
“projected_revenue_period_in_years”: “Available”,
“public_status”: null,
“sic_code”: “Available”,
“tech_keywords”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”,
“website”: “Available”
},
“contact_emails”: [
{
“email”: “******@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “Available”,
“created_by”: “Available”,
“end_date”: “Available”,
“job_dept”: “Available”,
“job_function”: “Available”,
“job_role”: “Available”,
“job_title”: “Available”,
“job_title_level”: “Available”,
“reporting_authority”: “Available”,
“start_date”: “Available”,
“updated_at”: “Available”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “Available”,
“contact_social_media”: [],
“created_at”: “Available”,
“created_by”: “Available”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”
}
],
“totalResultsCount”: 200
}
RESPONSE TEMPLATE
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “123 Main Street”,
“zip_code”: “60610”
},
“contact_company”: {
“acquisition_amount”: “$3,000,000”,
“acquisition_company_name”: “FooBar LLC”,
“acquisition_date”: “December 1, 2019”,
“annual_revenue_amount”: “$1,000,000”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “456 Main Street”,
“zip_code”: “60610”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “456”,
“company_social_media”: [
“https://twitter.com/foobarLLC”
],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“description”: “Industry leader in XYZ”,
“employee_size”: “50-100”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “53”,
“projected_revenue_amount”: “$600,000”,
“projected_revenue_period_in_years”: “5”,
“public_status”: null,
“sic_code”: “8742”,
“tech_keywords”: [
“Java”,
“Kafka”,
“Oracle”
],
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”,
“website”: “yournextcustomer.org”
},
“contact_emails”: [
{
“email”: “john.smith@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“end_date”: null,
“job_dept”: “Engineering”,
“job_function”: “Research”,
“job_role”: “Scientist”,
“job_title”: “Software Engineer”,
“job_title_level”: “Senior”,
“reporting_authority”: “Manager”,
“start_date”: “December 1, 2019”,
“updated_at”: “December 1, 2019”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “555-555-5656”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “123”,
“contact_social_media”: [],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Mike”,
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”
}
],
“totalResultsCount”: 200
}
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “123 Main Street”,
“zip_code”: “60610”
},
“contact_company”: {
“acquisition_amount”: “$3,000,000”,
“acquisition_company_name”: “FooBar LLC”,
“acquisition_date”: “December 1, 2019”,
“annual_revenue_amount”: “$1,000,000”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “456 Main Street”,
“zip_code”: “60610”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “456”,
“company_social_media”: [
“https://twitter.com/foobarLLC”
],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“description”: “Industry leader in XYZ”,
“employee_size”: “50-100”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “53”,
“projected_revenue_amount”: “$600,000”,
“projected_revenue_period_in_years”: “5”,
“public_status”: null,
“sic_code”: “8742”,
“tech_keywords”: [
“Java”,
“Kafka”,
“Oracle”
],
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”,
“website”: “yournextcustomer.org”
},
“contact_emails”: [
{
“email”: “john.smith@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“end_date”: null,
“job_dept”: “Engineering”,
“job_function”: “Research”,
“job_role”: “Scientist”,
“job_title”: “Software Engineer”,
“job_title_level”: “Senior”,
“reporting_authority”: “Manager”,
“start_date”: “December 1, 2019”,
“updated_at”: “December 1, 2019”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “555-555-5656”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “123”,
“contact_social_media”: [],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Mike”,
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”
}
],
“totalResultsCount”: 200
}
Segment APIs
With these APIs a user can apply a comprehensive set of segment-oriented filters to narrow down a well-defined set of contacts.
Segment API Query
With the Segment API Query a user can apply a comprehensive set of segment-oriented filters, and by this narrow down to an exact and well-defined list of contacts. This query gives the availability of information on all the contacts returned. Subsequential API calls using the Contact ReachID Data can be used to obtain a full and comprehensive set of contact information.
| Parameter | Description |
|---|---|
|
regions |
List of regions to query against. This filter uses a pre-defined and normalized list of world regions. - String |
|
countries |
A list of countries to query against. This filter uses a pre-defined and normalized list of countries. - String |
|
states |
A list of states (in any country) to query against. This filter uses a pre-defined and normalized list of states. - String |
|
cities |
A list of cities to query against. - String |
|
jobTitles |
List of job titles to query against. This filter uses a pre-defined and normalized list of job titles. - string |
|
sicCodes |
List of SIC codes to query against. This filter uses a pre-defined and normalized list of SIC codes. - string |
|
naicsCodes |
List of NAICS codes to query against. This filter uses a pre-defined and normalized list of SIC codes. - string |
|
employeeSize |
List of number of companies to query against. This filter uses a set of pre-defined employee size ranges that shall be used in the query. - String |
|
revenueSize |
minimum: 1 Response back paginated with 20 records per page, and this parameter sets the page to receive. Note: The search result for a filter query can have max 10,000 records, and the page number starts at 1 and continue till max 500 (500*20). – Integer |
QUERY EXAMPLE
curl -X GET
“https://yourcompany-api.reachstream.com/segment_query”
-H “accept: application/json”
-H “x-api-key: XXXXXXXXXX”
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Available”,
“country_name”: “Available”,
“region”: “Available”,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“contact_company”: {
“acquisition_amount”: “Available”,
“acquisition_company_name”: “Available”,
“acquisition_date”: “Available”,
“annual_revenue_amount”: “Available”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Available”,
“country_name”: “Available”,
“region”: null,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “Available”,
“company_social_media”: “Available”,
“created_at”: “Available”,
“created_by”: “Available”,
“description”: “Available”,
“employee_size”: “Available”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “Available”,
“projected_revenue_amount”: “Available”,
“projected_revenue_period_in_years”: “Available”,
“public_status”: null,
“sic_code”: “Available”,
“tech_keywords”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”,
“website”: “Available”
},
“contact_emails”: [
{
“email”: “******@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “Available”,
“created_by”: “Available”,
“end_date”: “Available”,
“job_dept”: “Available”,
“job_function”: “Available”,
“job_role”: “Available”,
“job_title”: “Available”,
“job_title_level”: “Available”,
“reporting_authority”: “Available”,
“start_date”: “Available”,
“updated_at”: “Available”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “Available”,
“contact_social_media”: [],
“created_at”: “Available”,
“created_by”: “Available”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”
}
],
“totalResultsCount”: 500
}
curl -X GET
“https://yourcompany-api.reachstream.com/segment_query”
-H “accept: application/json”
-H “x-api-key: XXXXXXXXXX”
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Available”,
“country_name”: “Available”,
“region”: “Available”,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“contact_company”: {
“acquisition_amount”: “Available”,
“acquisition_company_name”: “Available”,
“acquisition_date”: “Available”,
“annual_revenue_amount”: “Available”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Available”,
“country_name”: “Available”,
“region”: null,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “Available”,
“company_social_media”: “Available”,
“created_at”: “Available”,
“created_by”: “Available”,
“description”: “Available”,
“employee_size”: “Available”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “Available”,
“projected_revenue_amount”: “Available”,
“projected_revenue_period_in_years”: “Available”,
“public_status”: null,
“sic_code”: “Available”,
“tech_keywords”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”,
“website”: “Available”
},
“contact_emails”: [
{
“email”: “******@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “Available”,
“created_by”: “Available”,
“end_date”: “Available”,
“job_dept”: “Available”,
“job_function”: “Available”,
“job_role”: “Available”,
“job_title”: “Available”,
“job_title_level”: “Available”,
“reporting_authority”: “Available”,
“start_date”: “Available”,
“updated_at”: “Available”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “Available”,
“contact_social_media”: [],
“created_at”: “Available”,
“created_by”: “Available”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”
}
],
“totalResultsCount”: 500
}
RESPONSE TEMPLATE
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “123 Main Street”,
“zip_code”: “60610”
},
“contact_company”: {
“acquisition_amount”: “$3,000,000”,
“acquisition_company_name”: “FooBar LLC”,
“acquisition_date”: “December 1, 2019”,
“annual_revenue_amount”: “$1,000,000”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “456 Main Street”,
“zip_code”: “60610”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “456”,
“company_social_media”: [
“https://twitter.com/foobarLLC”
],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“description”: “Industry leader in XYZ”,
“employee_size”: “50-100”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “53”,
“projected_revenue_amount”: “$600,000”,
“projected_revenue_period_in_years”: “5”,
“public_status”: null,
“sic_code”: “8742”,
“tech_keywords”: [
“Java”,
“Kafka”,
“Oracle”
],
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”,
“website”: “yournextcustomer.org”
},
“contact_emails”: [
{
“email”: “john.smith@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“end_date”: null,
“job_dept”: “Engineering”,
“job_function”: “Research”,
“job_role”: “Scientist”,
“job_title”: “Software Engineer”,
“job_title_level”: “Senior”,
“reporting_authority”: “Manager”,
“start_date”: “December 1, 2019”,
“updated_at”: “December 1, 2019”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “555-555-5656”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “123”,
“contact_social_media”: [],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Mike”,
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”
}
],
“totalResultsCount”: 500
}
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “123 Main Street”,
“zip_code”: “60610”
},
“contact_company”: {
“acquisition_amount”: “$3,000,000”,
“acquisition_company_name”: “FooBar LLC”,
“acquisition_date”: “December 1, 2019”,
“annual_revenue_amount”: “$1,000,000”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “456 Main Street”,
“zip_code”: “60610”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “456”,
“company_social_media”: [
“https://twitter.com/foobarLLC”
],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“description”: “Industry leader in XYZ”,
“employee_size”: “50-100”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “53”,
“projected_revenue_amount”: “$600,000”,
“projected_revenue_period_in_years”: “5”,
“public_status”: null,
“sic_code”: “8742”,
“tech_keywords”: [
“Java”,
“Kafka”,
“Oracle”
],
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”,
“website”: “yournextcustomer.org”
},
“contact_emails”: [
{
“email”: “john.smith@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“end_date”: null,
“job_dept”: “Engineering”,
“job_function”: “Research”,
“job_role”: “Scientist”,
“job_title”: “Software Engineer”,
“job_title_level”: “Senior”,
“reporting_authority”: “Manager”,
“start_date”: “December 1, 2019”,
“updated_at”: “December 1, 2019”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “555-555-5656”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “123”,
“contact_social_media”: [],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Mike”,
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”
}
],
“totalResultsCount”: 500
}
Segment API Data
With the Segment API Data a user can apply a comprehensive set of segment-oriented filters, and by this narrow down to an exact and well-defined list of contacts. This query gives the full information on all the contacts returned.
| Parameter | Description |
|---|---|
|
regions |
List of regions to query against. This filter uses a pre-defined and normalized list of world regions. - String |
|
countries |
A list of countries to query against. This filter uses a pre-defined and normalized list of countries. - String |
|
states |
A list of states (in any country) to query against. This filter uses a pre-defined and normalized list of states. - String |
|
cities |
A list of cities to query against. - String |
|
jobTitles |
List of job titles to query against. This filter uses a pre-defined and normalized list of job titles. - string |
|
sicCodes |
List of SIC codes to query against. This filter uses a pre-defined and normalized list of SIC codes. - string |
|
naicsCodes |
List of NAICS codes to query against. This filter uses a pre-defined and normalized list of SIC codes. - string |
|
employeeSize |
List of number of companies to query against. This filter uses a set of pre-defined employee size ranges that shall be used in the query. - String |
|
revenueSize |
minimum: 1 Response back paginated with 20 records per page, and this parameter sets the page to receive. Note: The search result for a filter query can have max 10,000 records, and the page number starts at 1 and continue till max 500 (500*20). – Integer |
QUERY EXAMPLE
curl -X GET
“https://yourcompany-api.reachstream.com/segment_data”
-H “accept: application/json”
-H “x-api-key: XXXXXXXXXX”
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Available”,
“country_name”: “Available”,
“region”: “Available”,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“contact_company”: {
“acquisition_amount”: “Available”,
“acquisition_company_name”: “Available”,
“acquisition_date”: “Available”,
“annual_revenue_amount”: “Available”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Available”,
“country_name”: “Available”,
“region”: null,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “Available”,
“company_social_media”: “Available”,
“created_at”: “Available”,
“created_by”: “Available”,
“description”: “Available”,
“employee_size”: “Available”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “Available”,
“projected_revenue_amount”: “Available”,
“projected_revenue_period_in_years”: “Available”,
“public_status”: null,
“sic_code”: “Available”,
“tech_keywords”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”,
“website”: “Available”
},
“contact_emails”: [
{
“email”: “******@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “Available”,
“created_by”: “Available”,
“end_date”: “Available”,
“job_dept”: “Available”,
“job_function”: “Available”,
“job_role”: “Available”,
“job_title”: “Available”,
“job_title_level”: “Available”,
“reporting_authority”: “Available”,
“start_date”: “Available”,
“updated_at”: “Available”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “Available”,
“contact_social_media”: [],
“created_at”: “Available”,
“created_by”: “Available”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”
}
],
“totalResultsCount”: 500
}
curl -X GET
“https://yourcompany-api.reachstream.com/segment_data”
-H “accept: application/json”
-H “x-api-key: XXXXXXXXXX”
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Available”,
“country_name”: “Available”,
“region”: “Available”,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“contact_company”: {
“acquisition_amount”: “Available”,
“acquisition_company_name”: “Available”,
“acquisition_date”: “Available”,
“annual_revenue_amount”: “Available”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Available”,
“country_name”: “Available”,
“region”: null,
“state_name”: “Available”,
“street_name”: “Available”,
“zip_code”: “Available”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “Available”,
“company_social_media”: “Available”,
“created_at”: “Available”,
“created_by”: “Available”,
“description”: “Available”,
“employee_size”: “Available”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “Available”,
“projected_revenue_amount”: “Available”,
“projected_revenue_period_in_years”: “Available”,
“public_status”: null,
“sic_code”: “Available”,
“tech_keywords”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”,
“website”: “Available”
},
“contact_emails”: [
{
“email”: “******@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “Available”,
“created_by”: “Available”,
“end_date”: “Available”,
“job_dept”: “Available”,
“job_function”: “Available”,
“job_role”: “Available”,
“job_title”: “Available”,
“job_title_level”: “Available”,
“reporting_authority”: “Available”,
“start_date”: “Available”,
“updated_at”: “Available”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “4********”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “Available”,
“contact_social_media”: [],
“created_at”: “Available”,
“created_by”: “Available”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Available”,
“updated_at”: “Available”,
“updated_by”: “Available”
}
],
“totalResultsCount”: 500
}
RESPONSE TEMPLATE
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “123 Main Street”,
“zip_code”: “60610”
},
“contact_company”: {
“acquisition_amount”: “$3,000,000”,
“acquisition_company_name”: “FooBar LLC”,
“acquisition_date”: “December 1, 2019”,
“annual_revenue_amount”: “$1,000,000”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “456 Main Street”,
“zip_code”: “60610”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “456”,
“company_social_media”: [
“https://twitter.com/foobarLLC”
],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“description”: “Industry leader in XYZ”,
“employee_size”: “50-100”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “53”,
“projected_revenue_amount”: “$600,000”,
“projected_revenue_period_in_years”: “5”,
“public_status”: null,
“sic_code”: “8742”,
“tech_keywords”: [
“Java”,
“Kafka”,
“Oracle”
],
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”,
“website”: “yournextcustomer.org”
},
“contact_emails”: [
{
“email”: “john.smith@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“end_date”: null,
“job_dept”: “Engineering”,
“job_function”: “Research”,
“job_role”: “Scientist”,
“job_title”: “Software Engineer”,
“job_title_level”: “Senior”,
“reporting_authority”: “Manager”,
“start_date”: “December 1, 2019”,
“updated_at”: “December 1, 2019”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “555-555-5656”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “123”,
“contact_social_media”: [],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Mike”,
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”
}
],
“totalResultsCount”: 500
}
{
“results”: [
{
“contact_addresses”: {
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “123 Main Street”,
“zip_code”: “60610”
},
“contact_company”: {
“acquisition_amount”: “$3,000,000”,
“acquisition_company_name”: “FooBar LLC”,
“acquisition_date”: “December 1, 2019”,
“annual_revenue_amount”: “$1,000,000”,
“company_addresses”: {
“address_type”: null,
“city_name”: “Chicago”,
“country_name”: “United States of America”,
“region”: “North America”,
“state_name”: “Illinois”,
“street_name”: “456 Main Street”,
“zip_code”: “60610”
},
“company_emails”: [],
“company_name”: “Your Next Customer Inc”,
“company_phones”: [
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
{
“is_active”: true,
“phone”: “555-555-5555”,
“phone_ext”: null,
“phone_type”: null
},
],
“company_reach_id”: “456”,
“company_social_media”: [
“https://twitter.com/foobarLLC”
],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“description”: “Industry leader in XYZ”,
“employee_size”: “50-100”,
“fax”: null,
“fiscal_year_end_month”: null,
“founded_year”: null,
“industry_categories_list”: [
“Healthcare”
],
“investment_amount”: null,
“investment_company_name”: null,
“investment_description”: null,
“investment_end_date”: null,
“investment_round”: null,
“investment_started_date”: null,
“naics_code”: “53”,
“projected_revenue_amount”: “$600,000”,
“projected_revenue_period_in_years”: “5”,
“public_status”: null,
“sic_code”: “8742”,
“tech_keywords”: [
“Java”,
“Kafka”,
“Oracle”
],
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”,
“website”: “yournextcustomer.org”
},
“contact_emails”: [
{
“email”: “john.smith@yournextcustomer.org”,
“email_verified_status”: true
}
],
“contact_job”: {
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“end_date”: null,
“job_dept”: “Engineering”,
“job_function”: “Research”,
“job_role”: “Scientist”,
“job_title”: “Software Engineer”,
“job_title_level”: “Senior”,
“reporting_authority”: “Manager”,
“start_date”: “December 1, 2019”,
“updated_at”: “December 1, 2019”
},
“contact_phones”: [
{
“is_active”: true,
“phone”: “555-555-5656”,
“phone_ext”: null,
“phone_type”: null
}
],
“contact_reach_id”: “123”,
“contact_social_media”: [],
“created_at”: “December 1, 2019”,
“created_by”: “1234”,
“first_name”: “John”,
“last_name”: “Smith”,
“middle_name”: “Mike”,
“updated_at”: “December 1, 2019”,
“updated_by”: “1234”
}
],
“totalResultsCount”: 500
}
Request & Response Schema
The Reach API features well-formatted and strict schema for request and response payloads to provide a deterministic programming experience. This ensures that there is no ambiguity in the programming experience. There is a strict contract in all traffic so that bugs or confusion are eliminated during the development experience.
In the developer portal, the user can find the full JSON Schema for each Reach API.
Models are made available with the documentation for both request and response payloads. Developers are encouraged to take advantage of the various JSON schema utilities such as code generation to assist the development experience further:
Example Schema
JSON Schema
“$schema”: “http://json-schema.org/draft-07/schema#”,
“definitions”: {
“address”: {
“title”: “Address”,
“type”: “object”,
“properties”: {
“address_type”: {
“type”: “string”
},
“street_name”: {
“type”: “string”
},
“city_name”: {
“type”: “string”
},
“country_id”: {
“type”: “integer”
},
“country_name”: {
“type”: “string”
},
“region”: {
“type”: “string”
},
“state_name”: {
“type”: “string”
},
“zip_code”: {
“type”: “string”
}
}
},
“email”: {
“title”: “Email”,
“type”: “object”,
“properties”: {
“email”: {
“type”: “string”
},
“email_verified_status”: {
“type”: “boolean”
}
}
},
“phone”: {
“title”: “Phone”,
“type”: “object”,
“properties”: {
“is_active”: {
“type”: “boolean”
},
“phone”: {
“type”: “string”
},
“phone_ext”: {
“type”: “string”
},
“phone_type”: {
“type”: “string”
}
}
},
“social_media”: {
“title”: “Social Media”,
“type”: “object”,
“properties”: {
“is_active”: {
“type”: “boolean”
},
“url”: {
“type”: “string”
},
“social_media_type”: {
“type”: “string”
}
}
},
“contact_company”: {
“title”: “Company”,
“type”: “object”,
“properties”: {
“acquisition_amount”: {
“type”: “string”
},
“acquisition_company_name”: {
“type”: “string”
},
“acquisition_date”: {
“type”: “string”
},
“annual_revenue_amount”: {
“type”: “string”
},
“buzz_words”: {
“type”: “array”,
“items”: {
“type”: “string”
}
},
“company_addresses”: {
“$ref”: “#/definitions/address”
},
“company_emails”: {
“type”: “array”,
“items”: {
“$ref”: “#/definitions/email”
}
},
“company_phones”: {
“type”: “array”,
“items”: {
“$ref”: “#/definitions/phone”
}
},
“company_name”: {
“type”: “string”
},
“company_social_media”: {
“type”: “array”,
“items”: {
“$ref”: “#/definitions/social_media”
}
},
“company_type”: {
“type”: “string”
},
“company_type_id”: {
“type”: “string”
},
“created_at”: {
“type”: “string”
},
“created_by”: {
“type”: “string”
},
“description”: {
“type”: “string”
},
“employee_size”: {
“type”: “string”
},
“fax”: {
“type”: “string”
},
“fiscal_year_end_month”: {
“type”: “string”
},
“founded_year”: {
“type”: “string”
},
“id”: {
“type”: “string”
},
“industry_categories_list”: {
“type”: “array”,
“items”: {
“type”: “string”
}
},
“investment_amount”: {
“type”: “string”
},
“investment_company_name”: {
“type”: “string”
},
“investment_description”: {
“type”: “string”
},
“investment_end_date”: {
“type”: “string”
},
“investment_round”: {
“type”: “string”
},
“investment_started_date”: {
“type”: “string”
},
“naics_code”: {
“type”: “string”
},
“projected_revenue_amount”: {
“type”: “string”
},
“projected_revenue_period_in_years”: {
“type”: “string”
},
“public_status”: {
“type”: “string”
},
“sic_code”: {
“type”: “string”
},
“tech_keywords”: {
“type”: “array”,
“items”: {
“type”: “string”
}
},
“updated_at”: {
“type”: “string”
},
“updated_by”: {
“type”: “string”
},
“website”: {
“type”: “string”
}
}
},
“contact_job”: {
“title”: “Job”,
“type”: “object”,
“properties”: {
“company_id”: {
“type”: “string”
},
“contact_id”: {
“type”: “string”
},
“created_at”: {
“type”: “string”
},
“created_by”: {
“type”: “string”
},
“end_date”: {
“type”: “string”
},
“id”: {
“type”: “string”
},
“job_dept”: {
“type”: “string”
},
“job_function”: {
“type”: “string”
},
“job_role”: {
“type”: “string”
},
“job_title”: {
“type”: “string”
},
“job_title_level”: {
“type”: “string”
},
“reporting_authority”: {
“type”: “string”
},
“start_date”: {
“type”: “string”
},
“updated_at”: {
“type”: “string”
},
“updated_by”: {
“type”: “string”
}
}
}
},
“type”: “object”,
“title”: “Contact”,
“properties”: {
“contact_addresses”: {
“$ref”: “#/definitions/address”
},
“contact_company”: {
“$ref”: “#/definitions/contact_company”
},
“contact_emails”: {
“type”: “array”,
“items”: {
“$ref”: “#/definitions/email”
}
},
“contact_job”: {
“$ref”: “#/definitions/contact_job”
},
“contact_name”: {
“type”: “string”
},
“contact_phones”: {
“type”: “array”,
“items”: {
“$ref”: “#/definitions/phone”
}
},
“contact_social_media”: {
“type”: “array”,
“items”: {
“$ref”: “#/definitions/social_media”
}
},
“created_at”: {
“type”: “string”
},
“created_by”: {
“type”: “string”
},
“dob”: {
“type”: “string”
},
“first_name”: {
“type”: “string”
},
“gender”: {
“type”: “string”
},
“last_name”: {
“type”: “string”
},
“midddle_name”: {
“type”: “string”
},
“middle_name”: {
“type”: “string”
},
“reach_id”: {
“type”: “integer”
},
“suffix”: {
“type”: “string”
},
“updated_at”: {
“type”: “string”
},
“updated_by”: {
“type”: “string”
}
}
}
“$schema”: “http://json-schema.org/draft-07/schema#”,
“definitions”: {
“address”: {
“title”: “Address”,
“type”: “object”,
“properties”: {
“address_type”: {
“type”: “string”
},
“street_name”: {
“type”: “string”
},
“city_name”: {
“type”: “string”
},
“country_id”: {
“type”: “integer”
},
“country_name”: {
“type”: “string”
},
“region”: {
“type”: “string”
},
“state_name”: {
“type”: “string”
},
“zip_code”: {
“type”: “string”
}
}
},
“email”: {
“title”: “Email”,
“type”: “object”,
“properties”: {
“email”: {
“type”: “string”
},
“email_verified_status”: {
“type”: “boolean”
}
}
},
“phone”: {
“title”: “Phone”,
“type”: “object”,
“properties”: {
“is_active”: {
“type”: “boolean”
},
“phone”: {
“type”: “string”
},
“phone_ext”: {
“type”: “string”
},
“phone_type”: {
“type”: “string”
}
}
},
“social_media”: {
“title”: “Social Media”,
“type”: “object”,
“properties”: {
“is_active”: {
“type”: “boolean”
},
“url”: {
“type”: “string”
},
“social_media_type”: {
“type”: “string”
}
}
},
“contact_company”: {
“title”: “Company”,
“type”: “object”,
“properties”: {
“acquisition_amount”: {
“type”: “string”
},
“acquisition_company_name”: {
“type”: “string”
},
“acquisition_date”: {
“type”: “string”
},
“annual_revenue_amount”: {
“type”: “string”
},
“buzz_words”: {
“type”: “array”,
“items”: {
“type”: “string”
}
},
“company_addresses”: {
“$ref”: “#/definitions/address”
},
“company_emails”: {
“type”: “array”,
“items”: {
“$ref”: “#/definitions/email”
}
},
“company_phones”: {
“type”: “array”,
“items”: {
“$ref”: “#/definitions/phone”
}
},
“company_name”: {
“type”: “string”
},
“company_social_media”: {
“type”: “array”,
“items”: {
“$ref”: “#/definitions/social_media”
}
},
“company_type”: {
“type”: “string”
},
“company_type_id”: {
“type”: “string”
},
“created_at”: {
“type”: “string”
},
“created_by”: {
“type”: “string”
},
“description”: {
“type”: “string”
},
“employee_size”: {
“type”: “string”
},
“fax”: {
“type”: “string”
},
“fiscal_year_end_month”: {
“type”: “string”
},
“founded_year”: {
“type”: “string”
},
“id”: {
“type”: “string”
},
“industry_categories_list”: {
“type”: “array”,
“items”: {
“type”: “string”
}
},
“investment_amount”: {
“type”: “string”
},
“investment_company_name”: {
“type”: “string”
},
“investment_description”: {
“type”: “string”
},
“investment_end_date”: {
“type”: “string”
},
“investment_round”: {
“type”: “string”
},
“investment_started_date”: {
“type”: “string”
},
“naics_code”: {
“type”: “string”
},
“projected_revenue_amount”: {
“type”: “string”
},
“projected_revenue_period_in_years”: {
“type”: “string”
},
“public_status”: {
“type”: “string”
},
“sic_code”: {
“type”: “string”
},
“tech_keywords”: {
“type”: “array”,
“items”: {
“type”: “string”
}
},
“updated_at”: {
“type”: “string”
},
“updated_by”: {
“type”: “string”
},
“website”: {
“type”: “string”
}
}
},
“contact_job”: {
“title”: “Job”,
“type”: “object”,
“properties”: {
“company_id”: {
“type”: “string”
},
“contact_id”: {
“type”: “string”
},
“created_at”: {
“type”: “string”
},
“created_by”: {
“type”: “string”
},
“end_date”: {
“type”: “string”
},
“id”: {
“type”: “string”
},
“job_dept”: {
“type”: “string”
},
“job_function”: {
“type”: “string”
},
“job_role”: {
“type”: “string”
},
“job_title”: {
“type”: “string”
},
“job_title_level”: {
“type”: “string”
},
“reporting_authority”: {
“type”: “string”
},
“start_date”: {
“type”: “string”
},
“updated_at”: {
“type”: “string”
},
“updated_by”: {
“type”: “string”
}
}
}
},
“type”: “object”,
“title”: “Contact”,
“properties”: {
“contact_addresses”: {
“$ref”: “#/definitions/address”
},
“contact_company”: {
“$ref”: “#/definitions/contact_company”
},
“contact_emails”: {
“type”: “array”,
“items”: {
“$ref”: “#/definitions/email”
}
},
“contact_job”: {
“$ref”: “#/definitions/contact_job”
},
“contact_name”: {
“type”: “string”
},
“contact_phones”: {
“type”: “array”,
“items”: {
“$ref”: “#/definitions/phone”
}
},
“contact_social_media”: {
“type”: “array”,
“items”: {
“$ref”: “#/definitions/social_media”
}
},
“created_at”: {
“type”: “string”
},
“created_by”: {
“type”: “string”
},
“dob”: {
“type”: “string”
},
“first_name”: {
“type”: “string”
},
“gender”: {
“type”: “string”
},
“last_name”: {
“type”: “string”
},
“midddle_name”: {
“type”: “string”
},
“middle_name”: {
“type”: “string”
},
“reach_id”: {
“type”: “integer”
},
“suffix”: {
“type”: “string”
},
“updated_at”: {
“type”: “string”
},
“updated_by”: {
“type”: “string”
}
}
}
HTTP Return Codes
Reach API uses conventional HTTP response codes to indicate the success or failure of an API request.
Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Reach API servers (these are rare).
200 OK
Success.
400 Bad Request
This error indicates that the user’s request contains incorrect syntax. This could be due to the request URL or it’s payload (if applicable).
403 Forbidden
This error indicates that the server will not allow the caller to access the requested API – likely due to an invalid API key. Remember that all API calls must have “x-api-key” as a header for all requests.
404 Not Found
This error indicates that the server could not find the API endpoint that the caller requested. This commonly occurs when a URL is mistyped.
429 Too many requests
This error indicates that the client has exceeded quota. This could be due to too many requests within the last second (concurrency) or due to the monthly quota expired.
500 Internal Server Error
This error indicates that the server has faced a critical internal error. if this happens please reach out to us at support@reachstream.com
Reach API Classification
The Reach API operates with a rich set of filters as part of the request. These filters offer the ability to query based on country, job title, industry, SIC code, and much more.
The ease of use of these filters and their possible values are paramount to ensure an accurate experience for the applications built on the API. Reach API is proud to offer a rich classification system for certain API fields.
This means we have enumerated values possible for many of the filters within the APIs. This means, for example, there exists a finite set of possible values for filters such as industries, job titles, SIC codes, etc… No guesswork is needed when using our APIs.
Benefits include:
- A tightly coupled programming experience
- Results are returned match exactly what is intended by the query
- The contract on the data showcases exactly what possible values we support
- Overall, there is no ambiguity and explicit clarity on what we support
- The software that uses these APIs can allow a human user to choose from these enumeration values (like dropdowns in a web form) to ensure they get exactly what they desire.
Note that the enumerated classification (possible values for each filter) is given to users of the Reach API. We constantly refine our classification system, and when this happens, we proactively reach out to our users with updates.
Authentication
The Reach API uses an API key to authenticate requests. The API key is viewed and managed in the developer portal. Note that one API key is used for all APIs.
The API keys carry many privileges, so be sure to keep them secure! Do not share the private API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed by placing this API key as a header in the request. Details on the header name are available inside the developer portal.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Quota
Each APIs within the Reach API platform are offered with a quota per month. The quota is part of the Reach API package that has been agreed with the sales representatives.
The quota package and the status, used and remaining, can be monitored easily in the developer portal. Further quota can be added by reaching out to our support team.
Please note: When the quota is exceeded, an HTTP 429 is returned to the client.
Rate Limitations
Rate limits
A rate limiter on the number of requests received by the API within any given second.
Burst limits
A concurrency limiter on the number of active requests from a user at any given moment in time.
Both of these will be set up during the onboarding process. Violations of either of these will result in HTTP 429 error being returned.
Our APIs are built on top of the Amazon AWS API Gateway platform. More details on rate limits and burst limits can be found at:
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html
If higher queries per second or higher concurrency is needed, please reach out to your support staff so we can assist you in increasing these.