logo

API Introduction

The Companywell API is a RESTful interface, allowing you to programmatically access all of our data. It provides predictable URLs for accessing resources, and uses built-in HTTP features to receive commands and return responses. This makes it easy to communicate with from a wide variety of environments.

All responses and errors are provided in a JSON format.

Our API currently has the following end points:

Authentication

We authenticate every call via an API key. You can find this API key within your account by going to the API tab. Your API gives direct access to all of your credits so please keep the key in a secure place.

Every Companywell user has their own unique API key even if you’re a teammate on a larger team. A teammate’s API call will deduct credits from the team’s pool of credits.

If you need a new API key at any time please contact support.

Error

Sometimes a request to our API is not succesfull. Companywell’s API uses standard HTTP success or error status codes. Please find our standard error responses below.

Code Meaning Description
200 Success The request was a success.
201 Created A record was successfully created.
400 Bad Request This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.
401 Unauthorized A valid authentication token was not provided with the request, so the API could not associate a user with the request.
403 Forbidden You have reached the rate limit.
404 Not Found The requested resource cannot be found.
429 Too Many Requests The account is out of credits. Upgrade your plan to receive more credits.
451 Unavailable For Legal Reasons This request was blocked for legal reasons, commonly caused by a person omitted out of our datasets.
500 Server Error There was a problem on Companywell’s end.
EXAMPLE 401 ERROR
{
    "unauthorized": "No valid API key was provided."
}

People Miner

Our People Miner API let’s you build a list of prospects. Using our extensive query filters you can build a list of prospects that contains name, email address, phone numbers, etc..

Input a query and we will return a list. One credit is deducted for every person that is fetched. Each page returns 15 people, unless the query is less than 15 people total.

Query Perameters

To make a proper API call you need to provide your API key and at least one query perameter.

Attribute Description
api_key*string Your API key to authenticate the request
pagenumber The page number for pagination.Example: &page=3 would start the results on page 3.
limitnumber The number of contacts to return per page. The default is 15.
known_datastring Filter for people that only have a specific types contact information available in our datasets. Options are:company_emailpersonal_emailhq_phoneoffice_phonepersonal_phonelinkedintwitterfacebookgithubmailing_address
titlestring A fuzzy match search by job title
keywordstring A fuzzy match search by keyword across a person’s personal bio.
account_basedstring Filter for people at a specific company. You can enter a company name or domain name. Example: &account_based=asana.comor& account_based=Asana will only search for people who work at Asana.
departmentstring Filter for people within a specific department. View the field values for possible values.
skillsstring Filter for people that have a specific skill. View the field values for possible values.
senioritystring Filter for people with a select seniorty level. Possible options arec_levelvp_leveldirector_levelmanager_levelnon_manager_level
citystring Filter for people that are located in a specific city. View the field values for possible values. This is also a fuzzy match search.
statestring Filter for people that are located in a specific state. View the field values for possible values. This is also a fuzzy match search.
postal_codestring Filter for people that are located in a specific zip code / postal code. If you only use this query it will act as an exact match.
postal_radiusnumber Used in conjunction with the postal_code query, filter for contacts within a specific miles radius. For example: &postal_code=10075&postal_radius=10 would search within a 10 mile radius of the 10075 zip code area.
countrystring Filter for people that are located in a specific country code. View the field values for possible values.
time_in_rolenumber Filter people that have been in their current position a minimum number of years. The number should be between 0 and 20. 0 would be they have been in their current role less than 1 year. Example: &time_in_role=2 would be the person has been in their position at least 2 years or more.
educationstring Filter for people who went to a specific school. You can enter a company name or domain name. View field values for all possible values.
past_employersstring Filter for people who used to work at a specific company. You can enter a company name or domain name.Example: &past_employers=paypal.comor&past_employers=PayPal will filter for people who used to work at PayPal.
company_typestring Filter for contacts that only work at a certain type of company. The options are PublicPrivatePersonalEducationNonprofitPartnershipSole ProprietorshipGovernment
company_descriptionstring A fuzzy match search across the company’s description. For example: &company_description=health would only find people at companies that describe themselves as a “health” company
industrystring Filter for people that work in a specific industry. View our field values for possible values.
Created with Lunacy employeesnumber Filter by the company’s exact employee count. The employees query is used for an exact match, where the employees_gt and employees_lt queries are used to filter for “greater than” or “less than” respectively.
employees_gtnumber A “less than” filter for the company’s employee count. For example: &employees_lt=105 would filter for people who work at companies that have less than 105 employees
employees_ltnumber A “less than” filter for the company’s employee count. For example: &employees_lt=105 would filter for people who work at companies that have less than 105 employees
employee_rangenumber Filter for people who work at companies within a specific employee range bucket. The input is bucketed into a flat number. Options are:
1 0-1 Employees
10 1-10 Employees
50 11-50 Employees
200 51-200 Employees
500 201-500 Employees
1000 501-1000 Employees
5000 1001-5000 Employees
10000 5001-10000 Employees
10001 10000+ Employees
Example: &employee_range=10 would return people at companies that have between 1-10 employees
Created with Lunacy estimated_revenue number Filter for people who work at companies that make a specific estimated revenue. The estimated_revenue query is used for an exact match, where the estimated_revenue_gtestimated_revenue_it queries are used to filter for “greater than” or “less than” respectively.
estimated_revenue_gtnumber A “more than” filter for the company’s estimated revenue. For example: &estimated_revenue_gt=500000 would filter for people who work at companies that make more than $500,000 estimated revenue
estimated_revenue_ltnumber A “less than” filter for the company’s estimated revenue. For example: &estimated_revenue_lt=500000 would filter for people who work at companies that make less than $500,000 estimated revenue
Created with Lunacy alexa_rank number A “more than” filter for the company’s alexa ranking. For example: &alexa_rank_gt=100000 would filter for people who work at companies where their alexa rating is more than 100,000.
alexa_rank_gtnumber A “less than” filter for the company’s alexa ranking. For example: &alexa_rank_it=100000 would filter for people who work at companies where their alexa rating is less than 100,000.
alexa_rank_ltnumber A “less than” filter for the company’s alexa ranking. For example: &alexa_rank_lt=100000would filter for people who work at companies where their alexa rating is less than 100,000.
techstring Filter for people who work at companies that have a specific tag filter. View field values for possible values. For example: would filter for people who work at companies &tags=travel that have to do with travel.
tagsstring Filter for people who work at companies that use a specific technology. View field values for possible values. For example: &tech=Google Adwords would filter for people who work at companies that use Google Adwords.
company_citystring Filter for people where their headquaters is in a specific state. View field values for possible values. This is also a fuzzy match search.
company_postal_codestring Filter for people where their headquaters is in a specific postal code. This acts as an exact match filter.
company_postal_radiusnumber Used in conjunction with the company_postal_code query, filter for contacts within a specific miles radius. For example: &company_postal_code=“10075”&postal_radius=10 would search within a 10 mile radius of the 10075 zip code area.
company_countrystring Filter for people where their headquaters is in a specific country. View field values for all possible values. This is also a fuzzy match search.
Created with Lunacy location_count number Filter for people who work at companies that have a specific number of locations or offices. The location_count query is used for an exact match, where the location_count_gtlocation_count_lt and queries are used to filter for greater than or less than respectively.
location_count_gtnumber A “greater than” filter for the company’s location count. For example: &location_count_gt=3 would filter for people who work at companies where they have more than 3 offices/locations.
location_count_ltnumber A “less than” filter for the company’s location count. For example: &location_count_lt=3 would filter for people who work at companies where they have less than 3 offices/locations.
Created with Lunacy year_founded number Filter for people who work at companies that were founded in X year. The year_founded query is used for an exact match, where the year_founded_gtyear_founded_lt and queries are used to filter for greater than or less than respectively.
year_founded_gtnumber A “greater than” filter for the company’s year founded date. For example: &year_founded_gt=2000 would filter for people who work at companies where they were started in the year 2000 or later.
year_founded_ltnumber A “less than” filter for the company’s year founded date. For example: &year_founded_gt=2000 would filter for people who work at companies where they were started in the year 2000 or earlier.
Created with Lunacy funding_rounds number Filter for people who work at companies that have raised X number of funding rounds. The funding_rounds query is used for an exact match, where the funding_rounds_gtfunding_rounds_lt and queries are used to filter for greater than or less than respectively.
funding_rounds_gtnumber A “greater than” filter for the company’s funding round count. For example: &funding_rounds_gt=0 would filter for people who work at companies where they have at least raised 1 round of funding.
funding_rounds_ltnumber A “less than” filter for the company’s funding round count. For example: &funding_rounds_it=0 would filter for people who work at companies where they have at raised less than 3 rounds of funding.
Created with Lunacy funding_total number Filter for people who work at companies that have raised X number of dollars. The funding_total query is used for an exact match, where the funding_total_gtfunding_total_lt and queries are used to filter for greater than or less than respectively.
funding_total_gtnumber A “greater than” filter for the company’s funding amount. For example: &funding_total_gt=200000 would filter for people who work at companies where they have raised more than $200,000.
funding_total_ltnumber A “less than” filter for the company’s funding amount. For example: &funding_total_lt=200000 would filter for people who work at companies where they have raised less than $200,000.
last_funding_typestring The last type of funding the company has raised. You can view all funding options in the field values section
Created with Lunacy last_funding_date number Filter for people who work at companies that last raised money on a specific date. The last_funding_date query is used for an exact match, where the last_funding_date_gtlast_funding_date_lt and queries are used to filter for greater than or less than respectively. This field is in a unix timestamp.
last_funding_date_gtnumber A “greater than” filter for the last date the company was funded. For example: &last_funding_date_gt=1514764800 would filter for people who work at companies where they have raised money betweeen now and 01/01/2018.
last_funding_date_ltnumber A “less than” filter for the last date the company was funded. For example: &last_funding_date_lt=1514764800 would filter for people who work at companies where the last time they raised money was before 01/01/2018.
Created with Lunacy twitter_followers number Filter for people who work at companies that have X number of Twitter followers. The twitter_followers query is used for an exact match, where the twitter_followers_gtandtwitter_followers_lt queries are used to filter for greater than or less than respectively.
twitter_followers_gtnumber A “greater than” filter for the company’s Twitter follower count. For example: &twitter_followers_gt=750 would filter for people who work at companies where the company has more than 750 Twitter followers.
twitter_followers_ltnumber A “less than” filter for the company’s Twitter follower count. For example: &twitter_followers_lt=750 would filter for people who work at companies where the company has less than 750 Twitter followers.
Created with Lunacy facebook_followers number Filter for people who work at companies that have X number of Facebook followers. The facebook_followers query is used for an exact match, where the facebook_followers_gtfacebook_followers_lt and queries are used to filter for greater than or less than respectively.
facebook_followers_gtnumber A “greater than” filter for the company’s Facebook follower count. For example: &facebook_followers_gt=750 would filter for people who work at companies where the company has more than 750 Facebook followers.
facebook_followers_ltnumber A “less than” filter for the company’s twitter follower count. For example: &facebook_followers_lt=750 would filter for people who work at companies where the company has less than 750 Facebook followers.
Created with Lunacy instagram_followers number Filter for people who work at companies that have X number of Instagram followers. The instagram_followers query is used for an exact match, where the instagram_followers_gtinstagram_followers_lt and queries are used to filter for greater than or less than respectively.
instagram_followers_gtnumber A “greater than” filter for the company’s Instagram follower count. For example: &instagram_followers_gt=750 would filter for people who work at companies where the company has more than 750 Instagram followers.
instagram_followers_ltnumber A “less than” filter for the company’s Instagram follower count. For example: &facebook_followers_lt=750 would filter for people who work at companies where the company has less than 750 Instagram followers.
actively_hiringboolean If true then we only filter for people who work at companies that are actively hiring in the last 90 days.
* Required attribute

People Miner

get
https://api.companywell.co/people_miner
REQUEST https://api.companywell.co/people_miner?api_key={your_api_key}&{queries} EXAMPLE: “Fetch CEOs in New York State” https://api.companywell.co/people_miner?api_key={your_api_key}&title=CEO&state=NY

AND, NOT, OR Queries

To clarify queries you can use AND, NOT or OR operators. Note that you can have more than 1 AND, NOT, OR query within an API call.

Attribute Examples & Explination
and &and=(title:engineering,title:sales) Find people who’s title contains engineer and sales &and=(twitter_followers_gt:10000,facebook_followers_gt:10000) Find people who work at companies that have over 10,000 followers on Twitter and Facebook
not &title=marketing&not=(title:sales) Find people who have marketing in their title, but not the word sales.
or &title=president&or=(title:marketing,title:sales) Find presidents who’s title either contactins marketing or sales. &or=(twitter_followers_gt:10000,facebook_followers_gt:10000) Find people who work at companies that have over 10,000 followers on Twitter or Facebook

Response Schema

Attribute Description
query_resultsnumber The total number of possible people within your query
pagenumber The current page number that you are on
page_countnumber How many people are shown on this page
credits_usednumber The number of credits deducted from your account for the API call.
datanumber An array of people that matched your query.

Sorting

We sort our search results in order of the best match to your query. By &sort={attribute} using you can sort the results in the order for your choice.

Attribute Description
domain_ascend Sort by the domainfield in ascending order
domain_descend Sort by the domainfield in descending order
alexa_ascend Sort by the alexa_rankfield in ascending order
alexa_descend Sort by the alexa_rankfield in descending order
employees_ascend Sort by the employeesfield in ascending order
employees_descend Sort by the employeesfield in descending order
funding_ascend Sort by the funding_totalfield in ascending order
funding_descend Sort by the funding_totalfield in descending order

Field Values

Some of our datasets are too large to list out every possible outcome so we created end points for you to list and query possible options. Each query will auto sort by the title that has the highest count within our database.

Titles

https://api.companywell.co/filters/{api_key}/titles?q={query}

Industries

https://api.companywell.co/filters/{api_key}/industries?q={query}

You may also view an excel version of this list here.

Seniority

https://api.companywell.co/filters/{api_key}/seniority

You may also view an excel version of this list here.

Departments

https://api.companywell.co/filters/{api_key}/departments

You may also view an excel version of this list here.

Skills

https://api.companywell.co/filters/{api_key}/skills?q={query}

Education

https://api.companywell.co/filters/{api_key}/education?q={query}

Last Funding Type

https://api.companywell.co/filters/{api_key}/last_funding_type

You may also view an excel version of this list here.

Tags

https://api.companywell.co/filters/{api_key}/tags?q={query}

City

https://api.companywell.co/filters/{api_key}/city

State

https://api.companywell.co/filters/{api_key}/state

Country

https://api.companywell.co/filters/{api_key}/country

You may also view an excel version of this list here.

200 RESPONSE

{
    "query_results": 108,
    "page": 1,
    "page_count": 8,
    "credits_used": 15,
    "data": [
        {
            "id": "5e810c145414710007fffe0f",
            "email": "[email protected]",
            "personal_email": null,
            "domain": "spotify.com",
            "full_name": "Daniel Ek",
            "first_name": "Daniel",
            "last_name": "Ek",
            "bio": “Daniel Ek (born 21 February 1983) is a Swedish billionaire entrepreneur and technologist. Ek is best known as the co-founder and CEO of the music streaming service Spotify.”,
            "image": "https://profiles-logo.s3.amazonaws.com/5e810c145414710007fffe0f.png",
            "title": "Chairman & CEO",
            "department": "executive",
            "seniority": "c_level",
            "role_duration_anchor": 1143849600,
            "address": {
                "street_number": null,
                "street_name": null,
                "secondary": null,
                "secondary_type": null,
                "city": "New York",
                "state": "NY",
                "postal_code": "10007",
                "country": "United States",
                "country_code": "USA",
                "county": "New York",
                "district": null,
                "longitude": -74.00714,
                "latitude": 40.71455,
                "long_form": "New York, NY, United States"
            },
            "linkedin_handle": "daniel-ek-1b52093a",
            "twitter_handle": "eldsjal",
            "facebook_handle": null,
            "github_handle": null,
            "office_phone": null,
            "personal_phone": null,
            "past_employers": [],
            "education": [],
            "skills": [
                "startups",
                "digitalmedia",
                "mobiledevices",
                "entrepreneurship",
                "digitalstrategy",
                "ecommerce",
                "userexperience",
                "productmanagement",
                "scalability",
                "onlineadvertising",
                "digitalmarketing",
                "softwaredevelopment",
                "businessstrategy",
                "agilemethodologies",
                "scrum",
                "businessdevelopment",
                "systemarchitecture",
                "python",
                "strategicpartnerships",
                "monetization"
            ],
            "last_updated": 1585515537,
            "company": {
                "domain": "spotify.com",
                "name": “Spotify”,
                //..
            }
        }
        //14 More Results
    ]
}

Company Miner

Our Company Miner API let’s you build a list of companies. Using our extensive query filters you can build a list of companies.

Input a query and we will return a list. One credit is deducted for every person that is fetched. Each page returns 15 people, unless the query is less than 15 people total.

Query Perameters

To make a proper API call you need to provide your API key and at least one query perameter.

Attribute Description
api_key* string Your API key to authenticate the request
page number The page number for pagination. Example: &page=3 would start the results on page 3.
limit number The number of companies to return per page. The default is 15.
name string A fuzzy match across the company_name attribute
type string Filter for companies that are a certain type. The options are PublicPrivatePersonalEducationNonprofitPartnershipSole ProprietorshipGovernment
description string A fuzzy match search across the company’s description. For example: &description=health would only find people at companies that describe themselves as a “health” company
address string A fuzzy match across the full address of the company.
city string Filter for companies that are located in a specific city. View the field values for all possible values. This is also a fuzzy match search.
state string Filter for companies that are located in a specific state. View the field values for all possible values. This is also a fuzzy match search.
postal_code string Filter for people that are located in a specific zip code / postal code.
country string Filter for companies that are located in a specific country. View the field values for all possible values.
industry string Filter for companies that work in a specific industry. View the field values for all possible values.
Created with Lunacy employees number Filter by the company’s exact employee count. The employees query is used for an exact match, where the employees_gt and employees_lt queries are used to filter for “greater than” or “less than” respectively.
employees_gt number A “greater than” filter for the company’s employee count. For example: &employees_gt=105 would filter for companies who have more than 105 employees.
employees_lt number A “less than” filter for the company’s employee count. For example: &employees_lt=105 would filter for companies who have less than 105 employees.
employee_rangenumber Filter for companies within a specific employee range bucket. The input is bucketed into a flat number. Options are:
1 0-1 Employees
10 1-10 Employees
50 11-50 Employees
200 51-200 Employees
500 201-500 Employees
1000 501-1000 Employees
5000 1001-5000 Employees
10000 5001-10000 Employees
10001 10000+ Employees
Example: &employee_range=10 would return companies that have between 1-10 employees
Created with Lunacy estimated_revenue number Filter for companies that make a specific estimated revenue. The estimated_revenue query is used for an exact match, where the estimated_revenue_gt and estimated_revenue_lt queries are used to filter for “greater than” or “less than” respectively.
estimated_revenue_gt number A “more than” filter for the company’s estimated revenue. For example: &estimated_revenue_gt=500000 would filter for companies that make more than $500,000 estimated revenue
estimated_revenue_lt number A “less than” filter for the company’s estimated revenue. For example: &estimated_revenue_lt=500000 would filter for people who work at companies that make less than $500,000 estimated revenue
Created with Lunacy alexa_rank number Filter for companies that have a specific alexa ranking. The alexa_rank query is used for an exact match, where alexa_rank_gtalexa_rank_gt the and queries are used to filter for greater than or less than respectively.
alexa_rank_gt number A “more than” filter for the company’s alexa ranking. For example: &alexa_rank_gt=100000 would filter for companies where their alexa rating is more than 100,000.
alexa_rank_lt number A “less than” filter for the company’s alexa ranking. For example: &alexa_rank_lt=100000 would filter for companies where their alexa rating is less than 100,000.
tech string Filter for companies that use a specific technology. View the field values section for all possible values. For example: &tech=Google Adwords would filter for people who work at companies that use Google Adwords.
tags string Filter for companies that have a specific tag filter. View the field values for all possible values. For example: &tags=travel would filter for people who work at companies that have to do with travel.
Created with Lunacy location_count number Filter for ompanies that have a specific number of locations or offices. The location_count query is used for an exact match, where the location_count_gtlocation_count_lt and queries are used to filter for greater than or less than respectively.
location_count_gt number A “greater than” filter for the company’s location count. For example: &location_count_gt=3 would filter for companies that have more than 3 offices/locations.
location_count_lt number A “less than” filter for the company’s location count. For example: &location_count_lt=3 would filter for companies that have less than 3 offices/locations.
Created with Lunacy year_founded number Filter for companies that were founded in X year. The year_founded/a> query is used for an exact match, where the year_founded_gt and year_founded_lt queries are used to filter for greater than or less than respectively.
year_founded_gt number A “greater than” filter for the company’s year founded date. For example: &year_founded_gt=2000 would filter for companies that started in the year 2000 or later.
year_founded_lt number A “less than” filter for the company’s year founded date. For example: &year_founded_gt=2000 would filter for companies that started in the year 2000 or earlier.
Created with Lunacy funding_rounds number Filter companies that have raised X number of funding rounds. The funding_rounds query is used for an exact match, where the funding_rounds_gt and funding_rounds_lt queries are used to filter for greater than or less than respectively.
funding_rounds_gt number A “greater than” filter for the company’s funding round count. For example: &funding_rounds_gt=0 would filter for companies that have raised at least 1 round of funding or more.
funding_rounds_lt number A “less than” filter for the company’s funding round count. For example: &funding_rounds_lt=3 would filter for companies that have raised less than 3 rounds of funding.
Created with Lunacy funding_total number Filter for companies that have raised X number of dollars. The funding_total query is used for an exact match, where the funding_total_gt and funding_total_lt queries are used to filter for greater than or less than respectively.
funding_total_gt number A “greater than” filter for the company’s funding amount. For example: &funding_total_gt=200000 would filter for companies that have raised more than $200,000.
funding_total_lt number A “less than” filter for the company’s funding amount. For example: &funding_total_lt=200000 would filter for companies that have raised less than $200,000.
last_funding_type string The last type of funding the company has raised. View the field values for all possible values.
Created with Lunacy last_funding_date number Filter for companies that last raised money on a specific date. The last_funding_date query is used for an exact match, where the last_funding_date_gt and last_funding_date_lt queries are used to filter for greater than or less than respectively. This field is in a unix timestamp.
last_funding_date_gt number A “greater than” filter for the last date the company was funded. For example: &last_funding_date_gt=1514764800 would filter for companies that have raised money betweeen now and 01/01/2018.
last_funding_date_lt number A “less than” filter for the last date the company was funded. For example: &last_funding_date_lt=1514764800 would filter for companies where the last time they raised money was before 01/01/2018.
linkedin_handle string Search for a company by their LinkedIn handle.
twitter_handle string Search for a company by their Twitter handle.
facebook_handle string Search for a company by their Facebook handle.
instagram_handle string Search for a company by their Instagram handle.
Created with Lunacy twitter_followers number Filter for companies that have X number of Twitter followers. The twitter_followers query is used for an exact match, where the twitter_followers_gt and twitter_followers_lt queries are used to filter for greater than or less than respectively.
twitter_followers_gt number A “greater than” filter for the company’s Twitter follower count. For example: &twitter_followers_gt=750 would filter for companies that have more than 750 Twitter followers.
twitter_followers_lt number A “less than” filter for the company’s Twitter follower count. For example: &twitter_followers_lt=750 would filter for companies that have less than 750 Twitter followers.
Created with Lunacy facebook_followers number Filter for companies that have X number of Facebook followers. The facebook_followers query is used for an exact match, where the facebook_followers_gt and facebook_followers_lt queries are used to filter for greater than or less than respectively.
facebook_followers_gt number A “greater than” filter for the company’s Facebook follower count. For example: &facebook_followers_gt=750 would filter for companies that have more than 750 Facebook followers.
facebook_followers_lt number A “less than” filter for the company’s twitter follower count. For example: &facebook_followers_lt=750 would filter for companies that have less than 750 Facebook followers.
Created with Lunacy instagram_followers number Filter for companies that have X number of Instagram followers. The instagram_followers query is used for an exact match, where the instagram_followers_gt and instagram_followers_lt queries are used to filter for greater than or less than respectively.
instagram_followers_gt number A “greater than” filter for the company’s Instagram follower count. For example: &instagram_followers_gt=750 would filter for companies that have more than 750 Instagram followers.
instagram_followers_lt number A “less than” filter for the company’s Instagram follower count. For example: &facebook_followers_lt=750 would filter for companies that have less than 750 Instagram followers.
phone_number boolean If set to true then we will only return companies who have a phone number
actively_hiring boolean If set to true then we only filter for people who work at companies that are actively hiring in the last 90 days.
lookalike string Filter for companies that are either in the same space, have the same interests, or people view in the same light. The input is a domain name. Example: &lookalike=shopify.com would return companies within the same space as Shopfiy.
competitors string Filter for direct competitors to the company. The input is a domain name. Example: &competitors=ebay.comwould return companies that are competitors to eBay.
ip_address boolean If you are looking for a company with a specific IP address use this filter. Example: &ip_address=132.555.15.242
* Required attribute

Company Miner

get
https://api.companywell.co/company_miner
REQUEST https://api.companywell.co/company_miner?api_key={your_api_key}&{queries} EXAMPLE: “Fetch Retail Companies in Texas” https://api.companywell.co/company_miner?api_key={your_api_key}&industry=Retail&city=TX

AND, NOT, OR Queries

To clarify queries you can use AND, NOT or OR operators. Note that you can have more than 1 AND, NOT, OR query within an API call.

Attribute Examples & Explination
and &and=(tags:retail,tags:clothing) Find companies who focus on retail and clothing &and=(twitter_followers_gt:10000,facebook_followers_gt:10000) Find companies who have over 10,000 followers on Twitter and Facebook
not &tech=Google Adwords&not=(tech:AdRoll)Find companies who use Google Adwords, but NOT AdRoll.
or &industry=Retail&or=(state:TX,state:CT) Find companies in Retail where their headquaters are in either Texas or Connecticut &or=(twitter_followers_gt:10000,facebook_followers_gt:10000) Find companies who have over 10,000 followers on Twitter or Facebook

Sorting

We sort our search results in order of the best match to your query. By using &sort={attribute} you can sort the results in the order for your choice.

Attribute Description
domain_ascend Sort by the domainfield in ascending order
domain_descend Sort by the domainfield in descending order
alexa_ascend Sort by the alexa_rankfield in ascending order
alexa_descend Sort by the alexa_rankfield in descending order
employees_ascend Sort by the employeesfield in ascending order
employees_descend Sort by the employeesfield in descending order
funding_ascend Sort by the funding_totalfield in ascending order
funding_descend Sort by the funding_totalfield in descending order

Response Schema

Attribute Response Schema
query_results number The total number of possible companies within your query
page number The current page number that you are on
page_count number How many companies are shown on this page
credits_used number The number of credits deducted from your account for the API call.
data array An array of companies that matched your query. To understand all the company attributes that are returned please see the Company Enrichment Response Schema.

Pagination

By default, we return 15 companies per page. You can paginate through the data by using the &page={number}query.

Field Values

Some of our datasets are too large to list out every possible outcome so we created end points for you to list and query possible options. Each query will auto sort by the title that has the highest count within our database.

Education

https://api.companywell.co/filters/{api_key}/education?q={query}

Last Funding Type

https://api.companywell.co/filters/{api_key}/last_funding_type

You may also view an excel version of this list here.

Tags

https://api.companywell.co/filters/{api_key}/tags?q={query}

City

https://api.companywell.co/filters/{api_key}/city

State

https://api.companywell.co/filters/{api_key}/state

Country

https://api.companywell.co/filters/{api_key}/country

You may also view an excel version of this list here.

200 RESPONSE

{
    "query_results": 5102,
    "page": 1,
    "page_count": 15,
    "credits_used": 15,
    "data": [
        {
            "domain": "harrys.com",
            "name": "Harry's, Inc.",
            "legal_name": "Harry's, Inc.",
            "parent": null,
            "domain_aliases": [],
            "type": "Private",
            "ticker_symbol": null,
            "description": "Harry's is an American company that manufactures and sells shaving equipment and men's personal care products via online and retail channels.",
            "year_founded": 2012,
            "industry": "Consumer Goods",
            "estimated_revenue": 600000000,
            "funding_rounds": 7,
            "funding_total": 375200000,
            "last_funding_date": 1512086400,
            "last_funding_type": "series_d",
            "tech": [
                "Android",
                "Bugsnag",
                "Express",
                "Heap",
                "Instagram",
                "ios",
                "Optimizely",
                "Stripe",
                "Workable",
                "Tout",
                "Rollbar",
                "Segment",
                "Zendesk",
                "Zopim",
                "Vimeo"
            ],
            "address": {
                "street_number": "75",
                "street_name": "Varick St",
                "secondary": "9th",
                "secondary_type": "Floor",
                "city": "New York",
                "state": "NY",
                "postal_code": "10013",
                "country": "United States",
                "country_code": "USA",
                "county": "New York",
                "district": "Soho",
                "longitude": -74.0064,
                "latitude": 40.72329,
                "long_form": "75 Varick St, New York, NY 10013, United States"
            },
            "places": [
                "75 Varick Street, 9th Floor, New York, NY, 10013, US",
                "Seeweg 4 98673, Eisfeld, Thuringia, DE",
                "101 St Martin's Lane, 5th Floor, London, England, WC2N 4AZ, GB"
            ],
            "location_count": 3,
            "phone_number": "+18882126855",
            "phone_numbers": [
                "+18882126855",
                "+18882126855"
            ],
            "email_addresses": [
                "[email protected]",
                "[email protected]",
                "[email protected]"
            ],
            "employees": 446,
            "employee_range": 500,
            "logo": "https://company-well-companies-logo.s3.us-east-1.amazonaws.com/logos/harrys.com.png",
            "linkedin_handle": "harry's-grooming",
            "twitter_handle": "harrys",
            "facebook_handle": "hapostrophe",
            "instagram_handle": "harrys",
            "crunchbase_handle": "harrys",
            "angellist_handle": "harrys",
            "wikipedia_handle": "Harry's",
            "twitter_metrics": {
                "tweet_count": 29890,
                "follower_count": 32339,
                "following_count": 1211,
                "like_count": 13761,
                "join_year": 2010
            },
            "facebook_metrics": {
                "follower_count": 302388,
                "checkin_count": null,
                "like_count": 304977,
                "review_count": 2394,
                "rating": 4
            },
            "instagram_metrics": {
                "follower_count": 82070,
                "following_count": 983,
                "post_count": 2241,
                "average_like_count": 399,
                "average_comment_count": 10,
                "tags": []
            },
            "tags": [
                "razors",
                "shavingproducts",
                "grooming",
                "ecommerce",
                "design",
                "userexperience",
                "consumerproducts",
                "personalcare",
                "fashion",
                "lifestyle",
                "pricecomparison",
                "consumerpackagedgoods",
                "productservice"
            ],
            "lookalike": [
		"warbyparker.com",
		"awaytravel.com",
		"shopflamingo.com"
			],
            "competitors": [
                "gillette.com",
                "comfortableclub.com",
                "angelshaveclub.com"
            ],
            "actively_hiring": true,
            "alexa_rank": 28775,
            "identifiers": {
                "ein": null,
                "isin": null,
                "sic": 3352,
                "naics": 335210,
                "nace": null
            },
            "ip_addresses": [
                "151.101.66.217"
            ],
            "email_pattern": “{first}”,
            "legal_omit": false,
            "last_updated": 1579018675
        },
        //...
    ]
}

Person Enrichment

Our Person Enrichment API delivers an abundance of information about any person. We actively crawl the internet for relevant information about people and compile it into a digestiable format which you can access through this API.

One credit is deducted from your credit bank for every API call. If we can’t find a record we will return a 404 resonse and no credits will be deducted from your credit bank.

Query Perameters

Attribute Description
email_Address*string Required Your API key to authenticate the request
api_key*string Required The email address of the person that you want to enruch.

Response Schema

Attribute Description
email string The business email address of the person
personal_email string The personal email address of the person. This is found through publicly listed sources.
full_name string The full name of the person
first_name string The first name of the person
last_name string The last name of the person
bio string A summary or biography of the person
image string The public image of the person
title string The current job title or job position of the person
department string The department that the person works in. View the People Miner Field Values section for all possible values.
seniority string The seniority level of the person. View the People Miner Field Values section for all possible values.
role_duration_anchor number A Unix timestamp of when their started their current role.
Created with Lunacy address object An object of data points for the company’s headquaters address
address.street_number string The street name of the company’s headquaters
address.secondary string The secondary number of the company’s headquaters
address.secondary_type string The secondary type of the company’s headquaters.
address.city string The city of the company’s headquaters
address.state string The state of the company’s headquaters
address.postal_code string The postal code / zip code of the company’s headquaters
address.country string The country of the company’s headquaters
address.country_code string The country code of the company’s headquaters
address.county string The county of the company’s headquaters
address.district string The district of the company’s headquaters
address.longitude number The longitude of the company’s headquaters
address.latitude number The latitude of the company’s headquaters
address.long_form string The full long form formatted address of the company’s headquaters.
linkedin_handle string The LinkedIn handle of the person. To build a LinkedIn Url, simply put www.linkedin.com/in/ in front of the handle.
twitter_handle string The Twitter handle of the person. To build a Twitter Url, simply put www.twitter.com/ in front of the handle.
facebook_handle string The Facebook handle of the person. To build a Facebook Url, simply put www.facebook.com/ in front of the handle.
github_handle string The Github handle of the person. To build a Github Url, simply put www.github.com/ in front of the handle.
office_phone string The direct dial office phone number of the person.
personal_phone string The direct personal phone number of the person, this is typically their personal cell phone that has been publicly listed.
past_employers string An array of companies that previously employed the person.
education string An array of schools the person has attended. View the People Miner Field Values section for all possible values.
skills string An array of skills that the person has claimed to have. View the People Miner Field Values section for all possible values.
last_updated string A Unix timestamp the last time we have updated their record.
company object An object provided valuble data on their current company. See our Company Enrichment API to understand more about all the data outputs.

Person Enrichment

get
https://api.companywell.co/person_enrich
REQUEST https://api.companywell.co/person_enrich/{email_address}/{your_api_key} EXAMPLE https://api.companywell.co/person_enrich/[email protected]/{your_api_key} 200 RESPONSE

{
    "email": "[email protected]",
    "personal_email": null,
    "domain": "spotify.com",
    "full_name": "Daniel Ek",
    "first_name": "Daniel",
    "last_name": "Ek",
    "bio": "Daniel Ek (born 21 February 1983) is a Swedish billionaire entrepreneur and technologist. Ek is best known as the co-founder and CEO of the music streaming service Spotify.",
    "image": "https://profiles-logo.s3.amazonaws.com/5e810c145414710007fffe0f.png",
    "title": "Chairman & CEO",
    "department": "executive",
    "seniority": "c_level",
    "role_duration_anchor": 1143849600,
    "address": {
        "street_number": null,
        "street_name": null,
        "secondary": null,
        "secondary_type": null,
        "city": "New York",
        "state": "NY",
        "postal_code": "10007",
        "country": "United States",
        "country_code": "USA",
        "county": "New York",
        "district": null,
        "longitude": -74.00714,
        "latitude": 40.71455,
        "long_form": "New York, NY, United States"
    },
    "linkedin_handle": "daniel-ek-1b52093a",
    "twitter_handle": "eldsjal",
    "facebook_handle": null,
    "github_handle": null,
    "office_phone": null,
    "personal_phone": null,
    "past_employers": [],
    "education": [],
    "skills": [
        "startups",
        "digitalmedia",
        "mobiledevices",
        "entrepreneurship",
        "digitalstrategy",
        "ecommerce",
        "userexperience",
        "productmanagement",
        "scalability",
        "onlineadvertising",
        "digitalmarketing",
        "softwaredevelopment",
        "businessstrategy",
        "agilemethodologies",
        "scrum",
        "businessdevelopment",
        "systemarchitecture",
        "python",
        "strategicpartnerships",
        "monetization"
    ],
    "last_updated": 1585515537,
    "company": {
    "domain": "spotify.com",
    "name": "Spotify",
    "legal_name": "Spotify Technology S.A."
    //…
    }
}

Company Enrichment

Our Company Enrichment API delivers an abundance of information about any company. We actively crawl the internet for relevant information about companies and compile it into a digestiable format which you can access through this API.

One credit is deducted from your credit bank for every API call regardless if you have requested the company in the past. If we can’t find a record, we will return a 404 resonse and no credits will be deducted from your credit bank.

You can also pass through an email address in replacement of {domain} if you would like.

Query Perameters

Attribute Description
api_key*string Required Your API key to authenticate the request
domain*string Required The domain name of the company that you want to query. You must input a stripped down domain name (ex: “asana.com”) and not a website url (ex: “https://www.asana.com”).You may pass through an email address if you would like.

Response Schema

Attribute Description
domain string The active domain name of the company’s website
name string Name of the company
legal_name string Legal name of the company
parent string If the company is owned by another company then the domain of the parent company will appear here.
domain_aliases array If any website we visit redirects to the domain then it will be listed in this field.
type string What type of structure the company is. The options are , , PublicPrivatePersonalEducationNonprofitSole ProprietorshipGovernmentPartnership
ticker_symbol string If the company is publicly traded then we will list their ticker symbol
description string A summary of what the company does
year_founded number The year that the company was founded
industry string Using our industry fields we bucket a company into a specific industry vertical.
estimated_revenue number The estimated revenue of the company. If it’s a publicly traded company then the actual revenue will appear in this field as well.
funding_rounds number The number of “rounds” that the company has raised in their lifetime.
funding_total number The total amount of money the company has raised in their lifetime.
last_funding_date number A Unix timestamp of the last time the company announced that they raised money.
last_funding_type string The last type of funding the company has raised. You can view all funding options in our data point documentation
tech array An active list of technologies that company is using on their website. Here’s the full list of technologies we track.
Created with Lunacy address object An object of data points for the company’s headquaters address
address.street_number string The street number of the company’s headquaters
address.street_name string The street name of the company’s headquaters
address.secondary string The secondary type of the company’s headquaters.
address.city string The city of the company’s headquaters
address.state string The state of the company’s headquaters
address.postal_code string The postal code / zip code of the company’s headquaters
address.country string The country of the company’s headquaters
address.country_code string The country code of the company’s headquaters
address.district string The district of the company’s headquaters
address.latitude number The latitude of the company’s headquaters
address.long_form string The full long form formatted address of the company’s headquaters.
places array An array of any address that is associated with the company
location_count number The number of locations the company has.
phone_number string The main phone number for the company
phone_numbers array Any phone number publicly listed that is associated with the company
email_addresses array If email address that is publicly listed on the company’s website
employees number The employee count that we have found across the internet.
employee_rangenumber The self categorized employee range that companies list on social profiles. This is bucketed into a flat number. Options are:
1 0-1 Employees
10 1-10 Employees
50 11-50 Employees
200 51-200 Employees
500 201-500 Employees
1000 501-1000 Employees
5000 1001-5000 Employees
10000 5001-10000 Employees
10001 10000+ Employees
Example: &employee_range=10 would return people at companies that have between 1-10 employees
logo string The url to the company’s logo
linkedin_handle string The handle for the company’s LinkedIn profile. To get the url put “linkedin.com/in/“ in front of the handle.
twitter_handle string The handle for the company’s Twitter profile. To get the url put “twitter.com/“ in front of the handle.
facebook_handle string The handle for the company’s Facebook profile. To get the url put “facebook.com/“ in front of the handle.
instagram_handle string The handle for the company’s Instagram profile. To get the url put “instagram.com/“ in front of the handle.
crunchbase_handle string The handle for the company’s Crunchbase profile. To get the url put “crunchbase.com/organization/“ in front of the handle.
angellist_handle string The handle for the company’s Angellist profile. To get the url put “angel.co/company/“ in front of the handle.
wikipedia_handle string The handle for the company’s Wikipedia profile. To get the url put “wikipedia.com/wiki/“ in front of the handle.
Created with Lunacy twitter_metrics object An object for the company’s Twitter account metrics
twitter_metrics. tweet_count number The number of tweets the company has maderr
twitter_metrics. follower_count number The number of Twitter followers the company has
twitter_metrics. following_count number The number of Twitter accounts the company follows
twitter_metrics. like_count number The number of likes the company has given to other Twitter posts.
twitter_metrics. join_year number The year that the company joined Twitter
Created with Lunacy facebook_metrics object An object for the company’s Facebook account metrics
facebook_metrics. follower_count number The number of Facebook followers the company has
facebook_metrics. checkin_count number The number of Facebook check-ins the company has
facebook_metrics. like_count number The number of Facebook likes the company has
facebook_metrics. review_count number The number of Facebook reviews the company has
facebook_metrics. rating number The company’s rating on Facebook. The scale is from 0 through 5.
Created with Lunacy instagram_metrics object An object for the company’s Instagram account metrics
instagram_metrics.follower_count number The number of Instagram followers the company has
instagram_metrics. following_count number The number of accounts the company is following on Instagram
instagram_metrics. post_count number The number of posts the company has made on Instagram
instagram_metrics. avgerage_like_count number The average number of likes the company gets on each Instagram post
instagram_metrics. average_comment_count number The average number of comments the company gets on each Instagram post
instagram_metrics. tags array Important tag keywords extracted out of the company’s profile. Examples can be or
tags array An active list of tags that we have marked on the company.
lookalike array Companies that are either in the same space, have the same interests, or people view in the same light
competitors array Direct competitors to the company
actively_hiring boolean If true then we have found an active job listing for the company within the last 90 days
alexa_rank number The company’s Alexa rating
Created with Lunacy identifiers object An object for any unique identifer for the company
identifiers.ein string A 9 digit number assigned by the IRS to business entities for the purpose of identification
identifiers.isin string A 12 character long code of digits and characters that destinctly identifies securities.
identifiers.sic string A 4 digit representation of businesses and industries.
identifiers.naics string A 6 digit classification code within the North American Industry Classification System.
identifiers.nace string A European stastical classification of economic activites.
ip_addresses array Any known IP addresses associated with the company
email_pattern string The most email pattern for the company
last_updated number A unix timestamp for the last time we have updated a field

Company Enrichment

get
https://api.companywell.co/company_enrich
REQUEST https://api.companywell.co/company_enrich/{domain}/{your_api_key} EXAMPLE https://api.companywell.co/company_enrich/asana.com/{your_api_key} 200 RESPONSE

{
    "domain": "asana.com",
    "name": "Asana",
    "legal_name": "Asana, Inc.",
    "parent": null,
    "domain_aliases": [],
    "type": "Private",
    "ticker_symbol": null,
    "description": "It was founded in 2008 by Facebook co-founder Dustin Moskovitz and ex-Google-and-Facebook engineer Justin Rosenstein, who both worked on improving the productivity of employees at Facebook.",
    "year_founded": 2008,
    "industry": "Computer Software",
    "estimated_revenue": 125000000,
    "funding_rounds": 7,
    "funding_total": 213200000,
    "last_funding_date": 1543449600,
    "last_funding_type": "series_e",
    "tech": [
        "Android",
        "Bugsnag",
        "Instagram",
        "ios",
        "Wistia",
		//… 
    ],
    "address": {
        "street_number": "1550",
        "street_name": "Bryant St",
        "secondary": "200",
        "secondary_type": "Suite",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94103",
        "country": "United States",
        "country_code": "USA",
        "county": "San Francisco",
        "district": "Mission",
        "longitude": -122.41114,
        "latitude": 37.76756,
        "long_form": "1550 Bryant St, San Francisco, CA 94103, United States"
    },
    "places": [
        "1550 Bryant St, Suite 200, San Francisco, California, 94103, US",
        "4 World Trade Center, Suite 2918, New York, NY, 10007, US",
        "333 Seymour St, 8th floor, Vancouver, British Columbia, V6B, CA",
        "383 George Street, Office # 01-113, Sydney, New South Whales, 2000, AU",
        "Three Park Place, Hatch Street Upper, Saint Kevin's, Dublin, County Dublin, 8PMQ+GQ, IE"
    ],
    "location_count": 5,
    "phone_number": "+14155253888",
    "phone_numbers": [
        "+14154847702"
    ],
    "email_addresses": [
        "[email protected]",
        "[email protected]",
        "[email protected]",
        "[email protected]",
        "[email protected]",
        "[email protected]",
        "[email protected]"
    ],
    "employees": 500,
    "employee_range": 500,
    "logo": "https://company-well-companies-logo.s3.us-east-1.amazonaws.com/logos/asana.com.png",
    "linkedin_handle": "asana",
    "twitter_handle": "asana",
    "facebook_handle": "asana",
    "instagram_handle": null,
    "crunchbase_handle": "asana",
    "angellist_handle": "asana",
    "wikipedia_handle": "Asana_(software)",
    "twitter_metrics": {
        "tweet_count": null,
        "follower_count": null,
        "following_count": null,
        "like_count": null,
        "join_year": null
    },
    "facebook_metrics": {
        "follower_count": 270010,
        "checkin_count": null,
        "like_count": 268265,
        "review_count": null,
        "rating": null
    },
    "instagram_metrics": {
        "follower_count": null,
        "following_count": null,
        "post_count": null,
        "average_like_count": null,
        "average_comment_count": null,
        "tags": []
    },
    "tags": [
        "workmanagement",
        "productivity",
        "collaboration",
        "enterprisesoftware",
        "mobileapps",
        "publishing",
        "software",
        "taskmanagement",
        "productivitysoftware",
        "projectmanagement",
        "teamcollaboration"
    ],
    "lookalike": [],
    "competitors": [
        "wrike.com",
        "basecamp.com",
        "slack.com"
    ],
    "actively_hiring": false,
    "alexa_rank": 1071,
    "identifiers": {
        "ein": 263912448,
        "isin": null,
        "sic": 6513,
        "naics": 531110,
        "nace": null
    },
    "ip_addresses": [
        "151.101.1.184"
    ],
    "email_pattern": “{first}”,
    "last_updated": 1579025575
}

Company Name to Domain

Our Company Name to Domain API converts any company name to a company’s domain name name (also know as website).

One credit is deducted from your credit bank for every API call regardless if you have requested the company in the past. If we can’t find a record, we will return a 404 resonse and no credits will be deducted from your credit bank.

Query Perameters

Attribute Description
api_key*string Required Your API key to authenticate the request
company_name*string Required The name of the company that you want converted to a domain name.

Response Schema

Attribute Description
domain string The domain name of the queried company name

Company Name to Domain

get
https://api.companywell.co/domain
REQUEST https://api.companywell.co/domain/{company_name}/{your_api_key} EXAMPLE https://api.companywell.co/domain/Spotify/{your_api_key} 200 RESPONSE
{
    "domain": "spotify.com"
}