Get a Free API key

Overview

Introduction

API Endpoint

https://api.uplead.com/v2/

Welcome to UpLead’s API! You can use this API to access all our API endpoints.
Our main calls are:

Company API

Person API

Combined API

Prospector API

Prospector Pro API

Company Logo API

Company Name to Domain API

Quick Search API

Industries API

Preview API

Lists API

Authentication

To authorize, use this code:

curl "https://api.uplead.com/v2/api_endpoint_here"
  -H "Authorization: myapikey"

Authentication is made with your API Key which can be found in your account settings.

You will have to add your API Key to every call you make to our API. This parameter is always required. We'll return an error if the key is either missing or invalid.

Your API key is what identifies your account, so be sure to keep it secret! Please don’t share it with anyone outside of your organization.

Authorization: myapikey

Errors

Our API uses conventional HTTP response codes to indicate the success or failure of an API request.

In case of an error, we will return the correspondent error code.

HTTP Status codes

Error Code Meaning
400 Bad Request -- Your parameters are invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- Your account is on pause or you don't have a subscription.
429 Too Many Requests -- You're making too many requests.
50X Internal Server Error -- We had a problem with our server. Try again later.

Rate Limit

Example rate limit error response:

HTTP/1.1 429 Too Many Requests

X-RateLimit-Limit: 500
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1402010983
Retry-After: 50

Content-Type: application/json

{
    "error": {
          "type": "rate_limit",
          "message": "Rate limit exceeded. Limit is 500 requests per minute. Rate limit will be reset in 50 seconds."
    }
}

You can make 500 requests per minute to the API.

Check the returned HTTP headers of any API request to see your current rate limit status.

Header Name
X-RateLimit-Limit The maximum number of requests that the customer is permitted to make per minute.
X-RateLimit-Remaining The number of requests remaining in the current rate limit window.
X-RateLimit-Reset The time at which the current rate limit window resets in UTC epoch seconds.
Retry-After The number of seconds to wait until the rate limit window resets. Only sent when the rate limit.

Billing

One credit will be deducted for each contact or company record that you receive.

You will not be charged twice for the same contact/company record.

For contact records that include an email address: A credit will only be deducted for a contact if the response code comes back as “Valid” or “Accept All” (email_status).

Credits

Response:

{
    "data": {
        "email": "[email protected]",
        "credits": 100
    }
}

This endpoints allows you to get information about your remaining credits.

Example Request

GET/POST

https://api.uplead.com/v2/credits

Company API

Response:

{
    "data": {  
        "id": "9c7a4e17-9090-4293-a74b-05b0d0e34516",
        "company_name": "Amazon.com, Inc.",
        "domain": "amazon.com",
        "address": "410 Terry Ave N",
        "city": "Seattle",
        "state": "WA",
        "zip": "98109",
        "country": "United States",
        "county": "King",
        "phone_number": "2062661000",
        "fax_number": "3026365454",
        "employees": "10001+",
        "revenue": "1b+",
        "industry": "Retail",
        "sic_code": 5961,
        "sic_description": "Catalog and Mail-Order Houses",
        "naics_code": 45411,
        "naics_description": "Electronic Shopping and Mail-Order Houses",
        "description": "Amazon.com, Inc. offers a range of products and services through
its Websites. The Company operates through three segments: North America, 
International and Amazon Web Services (AWS). The Company's products include 
merchandise and content that it purchases for resale from vendors and those 
offered by third-party sellers. It also manufactures and sells electronic 
devices. The Company, through its subsidiary, Whole Foods Market, Inc., 
offers healthy and organic food and staples across its stores. 
The Company also offers a range of products like whole trade bananas, 
organic avocados, organic large brown eggs, organic responsibly-farmed 
salmon and tilapia, organic baby kale and baby lettuce, 
animal-welfare-rated 85% lean ground beef, creamy and crunchy almond 
butter, organic gala and fuji apples, organic rotisserie chicken.",
        "year_founded": 1994,
        "logo": "https://logo.uplead.com/amazon.com",
        "linkedin_url": "https://www.linkedin.com/company/amazon",
        "twitter_url": "https://twitter.com/amazon",
        "facebook_url": "https://www.facebook.com/Amazon",
        "youtube_url": "https://www.youtube.com/user/amazon",
        "crunchbase_url": "https://www.crunchbase.com/organization/amazon",
        "yelp_url": "",
        "instagram_url": "https://www.instagram.com/amazon/",
        "type": "Public",
        "ticker": "AMZN",
        "exchange": "Nasdaq",
        "alexa_rank": 10
    },
    "userInfo": {
        "availableCredits": 100
    }
}

Our Company API lets you lookup company data via a domain name or company name. You get a full overview of the company including size, location, social links, description, and more. For precise results it’s recommended to use a domain name.

Example Request

GET

https://api.uplead.com/v2/company-search?domain=amazon.com


POST

https://api.uplead.com/v2/company-search

Request JSON body:

{ "domain": "amazon.com" }

Parameters

Parameter Description
id Required if domain or company is not provided
internal company id (e.g – 9c7a4e17-9090-4293-a74b-05b0d0e34516).
string
domain Required if company or id is not provided
domain name (e.g – amazon.com).
string
company Required if domain or id is not provided
company name (e.g – amazon).
string

Attributes

Attribute Description
id string
internal company id.
company_name string
name of the company.
domain string
company website url.
address string
hq address.
city string
hq city name.
state string
hq state name.
county string
hq county name.
country string
hq country name.
zip string
hq zip code.
phone_number string
company phone number.
fax_number string
company fax number.
employees string
employees range (1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+).
revenue string
revenue range (0-1m, 1m-10m, 10m-50m, 50m-100m, 100m-200m, 200m-1b, 1b+).
industry string
company industry name.
sic_code integer
company sic code.
sic_description string
company sic code industry description.
naics_code integer
company naics code.
naics_description string
company naics code industry description.
description string
company description.
year_founded integer
company year founded.
logo string
company logo url.
linkedin_url string
company linkedin url.
twitter_url string
company twitter url.
facebook_url string
company facebook url.
youtube_url string
company youtube url.
crunchbase_url string
company crunchbase url.
yelp_url string
company yelp url.
instagram_url string
company instagram url.
type string
company type (private, public, education, government, non-profit).
ticker string
company stock ticker.
exchange string
company stock exchange.
alexa_rank integer
company website alexa ranking.

User Info Attributes

Attribute Description
availableCredits integer
user credits balance.

Person API

Response:

{
    "data": {
        "id": "d98e157e-c31d-40a0-9d98-b2fb8390797d",
        "first_name": "marc",
        "last_name": "benioff",
        "title": "ceo",
        "job_function": "",
        "job_sub_function": "",
        "management_level": "C",
        "gender": "male",
        "email": "[email protected]",
        "email_status": "valid",
        "phone_number": "4159017000",
        "mobile_directdial": "(415) 426-8562",
        "city": "San Francisco",
        "state": "CA",
        "county": "San Francisco",
        "country": "United States",
        "linkedin_url": "https://www.linkedin.com/in/marcbenioff/",
        "industry": "Internet",
        "domain": "salesforce.com",
        "company_name": "Salesforce.com, Inc."
    },
    "userInfo": {
        "availableCredits": 100
    }
}

Our Person API lets you lookup a person based on an email address OR based on a domain name + first name + last name. You get a full overview of the person including name, location, email, phone number, social links and more.

Example Request

GET

https://api.uplead.com/v2/[email protected]


POST

https://api.uplead.com/v2/person-search

Request JSON body:

{ "email": "[email protected]" }

Parameters

Parameter Description
id Required if first_name or last_name or domain or email is not provided
internal company id (e.g – c7d44d9a-b84a-459a-9003-75e10415f74a).
string
email Required if first name or last name or domain or id is not provided
email address (e.g – [email protected]).
string
first_name Required if email address is not provided
first name of the person (e.g – Marc).
string
last_name Required if email address is not provided
last name of the person (e.g – Benioff).
string
domain Required if email address is not provided
the domain name (e.g – salesforce.com).
string

Attributes

Attribute Description
id string
internal person id.
first_name string
person first name.
last_name string
person last name.
title string
person job title.
job_function string
person job function (Customer Service, Design, Education etc).
job_sub_function string
person job sub function (Customer Success, Support, Graphic Design etc).
management_level string
person management level (M, D, VP, C).
gender string
person gender.
email string
person email address.
email_status string
person email address status code.
phone_number string
company phone number.
mobile_directdial string
mobile direct dial number.
city string
person city.
state string
person state.
county string
person county.
country string
person country.
linkedin_url string
person linkedin url.
industry string
company industry name.
domain string
company domain url.
company_name string
company name.

User Info Attributes

Attribute Description
availableCredits integer
user credits balance.

Combined API

(Person + Company)

Response:

{
    "data": {
        "id": "d98e157e-c31d-40a0-9d98-b2fb8390797d",
        "first_name": "marc",
        "last_name": "benioff",
        "title": "ceo",
        "job_function": "",
        "job_sub_function": "",
        "management_level": "C",
        "gender": "male",
        "email": "[email protected]",
        "email_status": "valid",
        "mobile_directdial": "(415) 426-8562",
        "city": "San Francisco",
        "state": "CA",
        "county": "San Francisco",
        "country": "United States",
        "linkedin_url": "https://www.linkedin.com/in/marcbenioff/",
        "company": {
            "id": "c7d44d9a-b84a-459a-9003-75e10415f74a",
            "company_name": "Salesforce.com, Inc.",
            "domain": "salesforce.com",
            "address": "415 Mission Street, 3rd Floor",
            "city": "San Francisco",
            "state": "CA",
            "zip": 94105,
            "country": "United States",
            "county": "San Francisco",
            "phone_number": "4159017000",
            "fax_number": "4159017040",
            "employees": "10001+",
            "revenue": "1b+",
            "industry": "Internet",
            "sic_code": 7372,
            "sic_description": "Prepackaged Software",
            "naics_code": 518210,
            "naics_description": "Data Processing, Hosting, and Related Services",
            "description": "Salesforce.com, Inc. is an American cloud-based software 
company, headquartered in San Francisco, California. Though the bulk of its revenue 
comes from a customer relationship management (CRM) product, Salesforce also sells a 
complementary suite of enterprise applications focused on customer service, marketing 
automation, analytics and application development.",
            "year_founded": 1999,
            "logo": "https://logo.uplead.com/salesforce.com",
            "linkedin_url": "https://www.linkedin.com/company/salesforce",
            "twitter_url": "http://twitter.com/salesforce",
            "facebook_url": "https://www.facebook.com/salesforce",
            "youtube_url": "https://www.youtube.com/user/salesforce",
            "crunchbase_url": "https://www.crunchbase.com/organization/salesforce",
            "yelp_url": "https://www.yelp.com/biz/salesforce-san-francisco",
            "instagram_url": "https://instagram.com/salesforce/",
            "type": "Public",
            "ticker": "CRM",
            "exchange": "NYSE",
            "alexa_rank": 123
        } 
    }
}

Our Combined (Person + Company) API lets you lookup a person and company simultaneously based on an email address. The endpoint requires an email address and you get both the person and company information.

Example Request

GET

https://api.uplead.com/v2/[email protected]


POST

https://api.uplead.com/v2/combined-search

Request JSON body:

{ "email": "[email protected]" }

Parameters

Parameter Description
email Required
email address (e.g – [email protected])
string

Attributes

Attribute Description
id string
internal person id.
first_name string
person first name.
last_name string
person last name.
title string
person job title.
job_function string
person job function (Customer Service, Design, Education etc).
job_sub_function string
person job sub function (Customer Success, Support, Graphic Design etc).
management_level string
person management level (M, D, VP, C).
gender string
person gender.
email string
person email address.
email_status string
person email address status code.
mobile_directdial string
mobile direct dial number.
city string
person city.
state string
person state.
county string
person county.
country string
person country.
linkedin_url string
person linkedin url.
company object
company attributes

Company Attributes

Attribute Description
id string
internal company id.
company_name string
name of the company.
domain string
company website url.
address string
hq address.
city string
hq city name.
state string
hq state name.
zip string
hq zip code.
country string
hq country name.
county string
hq county name.
phone_number string
company phone number.
fax_number string
company fax number.
employees string
employees range (1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+).
revenue string
revenue range (0-1m, 1m-10m, 10m-50m, 50m-100m, 100m-200m, 200m-1b, 1b+).
industry string
company industry name.
sic_code integer
company sic code.
sic_description string
company sic code industry description.
naics_code integer
company naics code.
naics_description string
company naics code industry description.
description string
company description.
year_founded integer
company year founded.
logo string
company logo url.
linkedin_url string
company linkedin url.
twitter_url string
company twitter url.
facebook_url string
company facebook url.
youtube_url string
company youtube url.
crunchbase_url string
company crunchbase url.
yelp_url string
company yelp url.
instagram_url string
company instagram url.
type string
company type (private, public, education, government, non-profit).
ticker string
company stock ticker.
exchange string
company stock exchange.
alexa_rank integer
company website alexa ranking.

User Info Attributes

Attribute Description
availableCredits integer
user credits balance.

Prospector API

Response:

{
    "data": {
        "results": [
            {
                "id": "5f77c393-111f-4c57-9feb-cb777b02418d",
                "first_name": "mark",
                "last_name": "hawkins",
                "title": "president & cfo",
                "job_function": "finance",
                "job_sub_function": "",
                "management_level": "C",
                "gender": "male",
                "email": "[email protected]",
                "email_status": "valid",
                "phone_number": "4159017000",
                "mobile_directdial": "",
                "city": "San Francisco",
                "state": "CA",
                "county": "San Francisco",
                "country": "United States",
                "linkedin_url": "https://www.linkedin.com/in/markjhawkins/",
                "industry": "Internet",
                "domain": "salesforce.com",
                "company_name": "Salesforce.com, Inc."
            }
        ],
        "meta": {
            "total": 100,
            "page": 1,
            "next_page": 2,
            "previous_page": null,
            "first_page": true,
            "last_page": false
        }
    },
    "userInfo": {
        "availableCredits": 100
    }
}

Count Only Response:

{
    "data": {
        "count": 507
    },
    "userInfo": {
        "availableCredits": 2876
    }
}

Our Prospector API lets you find contacts and emails associated with a company, job title, job function, management level and location.

Example Request

GET

https://api.uplead.com/v2/prospector-search?domain=salesforce.com&job_function=finance


POST

https://api.uplead.com/v2/prospector-search

Request JSON body:

{ "domain": "salesforce.com", "job_function": "finance" }

Parameters

Parameter Description
domain Required
domain URL of the company you want to search against (e.g – amazon.com).
string
job_function Optional
person job function.
string
Allowed values:
  • Customer Service
  • Design
  • Education
  • Engineering
  • Finance
  • Health
  • Human Resources
  • Legal
  • Marketing
  • Media
  • Operations
  • Public Relations
  • Real Estate
  • Sales
  • Trades
job_sub_function Optional
person job sub function.
string
Allowed values:
  • Customer Success
  • Support
  • Graphic Design
  • Product Design
  • Web Design
  • Education Administration
  • Professor
  • Researcher
  • Data
  • Devops
  • Electrical
  • Mechanical
  • Network
  • Information Technology
  • Project Engineering
  • Quality Assurance
  • Security
  • Software
  • Systems
  • Web
  • Accounting
  • Investing
  • Tax
  • Dental
  • Fitness
  • Doctor
  • Nursing
  • Therapy
  • Wellness
  • Compensation
  • Employee Development
  • Recruiting
  • Lawyer
  • Paralegal
  • Judicial
  • Brand Marketing
  • Content Marketing
  • Product Marketing
  • Broadcasting
  • Editorial
  • Journalism
  • Video
  • Writing
  • Project Management
  • Office Management
  • Logistics
  • Product
  • Events
  • Media Relations
  • Property Management
  • Realtor
  • Accounts
  • Business Development
  • Pipeline
management_level Optional
person management level.
string
Allowed values:
  • M
  • D
  • VP
  • C
title Optional
person job title.
string
titles Optional
multiple person job titles.
array of strings
title_search_mode Optional
person title search mode.
string
Allowed values:
  • include
  • exact
city Optional
person city.
string
cities Optional
multiple person cities.
array of strings
state Optional
person state.
string
states Optional
multiple person states.
array of strings
country Optional
person country.
string
countries Optional
multiple person countries.
array of strings
regions Optional
multiple person regions (eg. ["AMER", "EMEA"]).
array of strings
name Optional
person name.
string
exclusion_list_names Optional
exclusion list names.
You must upload your lists first here
array of strings
email_status Optional
person email status.
string
Allowed values:
  • valid
  • invalid
  • accept_all
  • unknown
    count_only Optional
    show only number of results for this query (default is false).
    boolean
    page Optional
    which results page to show (default is 1).
    integer
    per_page Optional
    number of results returned (default is 25, max is 100).
    integer

    Attributes

    Attribute Description
    id string
    internal person id.
    first_name string
    person first name.
    last_name string
    person last name.
    title string
    person job title.
    job_function string
    person job function (Customer Service, Design, Education etc).
    job_sub_function string
    person job sub function (Customer Success, Support, Graphic Design etc).
    management_level string
    person management level (M, D, VP, C).
    gender string
    person gender.
    email string
    person email address.
    email_status string
    person email address status code.
    phone_number string
    company phone number.
    mobile_directdial string
    mobile direct dial number.
    city string
    person city.
    state string
    person state.
    county string
    person county.
    country string
    person country.
    linkedin_url string
    person linkedin url.
    industry string
    company industry name.
    domain string
    company domain url.
    company_name string
    company name.

    Meta Attributes

    Attribute Description
    total integer
    total number of records found.
    page integer
    number of current page.
    next_page integer
    number of next page to retrieve.
    previous_page integer
    number of previous page to retrieve.
    first_page boolean
    determine if current page is first.
    last_page boolean
    determine if current page is last.

    User Info Attributes

    Attribute Description
    availableCredits integer
    user credits balance.

    Prospector Pro API

    Response:

    {
    "data": {
        "results": [
            {
                "id": "5f77c393-111f-4c57-9feb-cb777b02418d",
                "first_name": "mark",
                "last_name": "hawkins",
                "title": "president & cfo",
                "job_function": "finance",
                "job_sub_function": "",
                "management_level": "C",
                "gender": "male",
                "email": "[email protected]",
                "email_status": "valid",
                "mobile_directdial": "",
                "city": "San Francisco",
                "state": "CA",
                "county": "San Francisco",
                "country": "United States",
                "linkedin_url": "https://www.linkedin.com/in/markjhawkins/",
                "company": {
                    "id": "c7d44d9a-b84a-459a-9003-75e10415f74a",
                    "company_name": "Salesforce.com, Inc.",
                    "domain": "salesforce.com",
                    "address": "415 Mission Street, 3rd Floor",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": 94105,
                    "county": "San Francisco",
                    "country": "United States",
                    "phone_number": "4159017000",
                    "fax_number": "4159017040",
                    "employees": "10001+",
                    "revenue": "1b+",
                    "industry": "Internet",
                    "sic_code": 7372,
                    "sic_description": "Prepackaged Software",
                    "naics_code": 518210,
                    "naics_description": "Data Processing, Hosting, and Related Services",
                    "description": "Salesforce.com, Inc. is an American cloud-based software
company, headquartered in San Francisco, California. Though the bulk of its revenue 
comes from a customer relationship management (CRM) product, Salesforce also sells a 
complementary suite of enterprise applications focused on customer service, marketing 
automation, analytics and application development."
                    "year_founded": 1999,
                    "logo": "https://logo.uplead.com/salesforce.com",
                    "linkedin_url": "https://www.linkedin.com/company/salesforce",
                    "twitter_url": "http://twitter.com/salesforce",
                    "facebook_url": "https://www.facebook.com/salesforce",
                    "youtube_url": "https://www.youtube.com/user/salesforce",
                    "crunchbase_url": "https://www.crunchbase.com/organization/salesforce",
                    "yelp_url": "https://www.yelp.com/biz/salesforce-san-francisco",
                    "instagram_url": "https://instagram.com/salesforce/",
                    "type": "Public",
                    "ticker": "CRM",
                    "exchange": "NYSE",
                    "alexa_rank": 123
                }
            }
        ],
        "meta": {
            "total": 100,
            "page": 1,
            "next_page": 2,
            "previous_page": null,
            "first_page": true,
            "last_page": false
        }
    },
    "userInfo": {
        "availableCredits": 100
    }
}

    Count Only Response:

    {
    "data": {
        "count": 507
    },
    "userInfo": {
        "availableCredits": 100
    }
}

    Our Prospector Pro API lets you find contacts and company details by searching in a similar manner to our web application including by job title, industry, location, and more. The Prospector Pro API is available on the Professional, Elite, and Enterprise plans only.

    Example Request

    GET

    https://api.uplead.com/v2/prospector-pro-search?domain=salesforce.com&job_functions[]=finance


    POST

    https://api.uplead.com/v2/prospector-pro-search

    Request JSON body:

    { "domain": "salesforce.com", "job_functions": ["finance"] }

    Parameters

    Parameter Description
    domain Optional
    company domain URL (e.g – amazon.com).
    string
    domains Optional
    company domain URLs (e.g – ["amazon.com", "google.com", "apple.com"]).
    array_of_strings
    name Optional
    person name.
    string
    job_functions Optional
    multiple person job functions.
    array of strings
    Allowed values:
    • Customer Service
    • Design
    • Education
    • Engineering
    • Finance
    • Health
    • Human Resources
    • Legal
    • Marketing
    • Media
    • Operations
    • Public Relations
    • Real Estate
    • Sales
    • Trades
    job_sub_functions Optional
    multiple person job sub functions.
    array of strings
    Allowed values:
    • Customer Success
    • Support
    • Graphic Design
    • Product Design
    • Web Design
    • Education Administration
    • Professor
    • Researcher
    • Data
    • Devops
    • Electrical
    • Mechanical
    • Network
    • Information Technology
    • Project Engineering
    • Quality Assurance
    • Security
    • Software
    • Systems
    • Web
    • Accounting
    • Investing
    • Tax
    • Dental
    • Fitness
    • Doctor
    • Nursing
    • Therapy
    • Wellness
    • Compensation
    • Employee Development
    • Recruiting
    • Lawyer
    • Paralegal
    • Judicial
    • Brand Marketing
    • Content Marketing
    • Product Marketing
    • Broadcasting
    • Editorial
    • Journalism
    • Video
    • Writing
    • Project Management
    • Office Management
    • Logistics
    • Product
    • Events
    • Media Relations
    • Property Management
    • Realtor
    • Accounts
    • Business Development
    • Pipeline
    management_levels Optional
    multiple person management levels.
    array of strings
    Allowed values:
    • M
    • D
    • VP
    • C
    titles Optional
    multiple job titles.
    array of strings
    title_search_mode Optional
    search mode for titles (default is "exact").
    string
    Allowed values:
    • include
    • exact
    cities Optional
    multiple person cities.
    array of strings
    states Optional
    multiple person states.
    array of strings
    countries Optional
    multiple person countries.
    array of strings
    regions Optional
    multiple person regions.
    array of strings
    Allowed values:
    • AMER
    • APAC
    • EMEA
    • LATAM
    location_target Optional
    location entity (default is "company").
    string
    Allowed values:
    • contact
    • company
    business_types Optional
    multiple person business types.
    array of strings
    Allowed values:
    • education
    • government
    • non_profit
    • public
    • private
    • subsidiary
    industries Optional
    multiple industries.
    array of strings
    industries_ids Optional
    multiple industry ids (e.g - ["15", "01", "17"]).
    array of strings
    sic_codes Optional
    multiple sic codes.
    array of strings
    naics_codes Optional
    multiple naics codes.
    array of strings
    employees Optional
    multiple employee ranges.
    array of strings
    Allowed values:
    • 1-10
    • 11-50
    • 51-200
    • 201-500
    • 501-1000
    • 1001-5000
    • 5001-10000
    • 10001+
    revenues Optional
    multiple revenues.
    array of strings
    Allowed values:
    • 0-1m
    • 1m-10m
    • 10m-50m
    • 50m-100m
    • 100m-200m
    • 200m-1b
    • 1b+
    exclude_eu Optional
    exclude EU contacts (default: "false").
    boolean
    exclusion_list_names Optional
    exclusion list names.
    You must upload your lists first here
    array of strings
    count_only Optional
    show only number of results for this query (default is false).
    boolean
    page Optional
    which results page to show (default is 1).
    integer
    per_page Optional
    number of results returned (default is 25, max is 100).
    integer

    Attributes

    Attribute Description
    id string
    internal person id.
    first_name string
    person first name.
    last_name string
    person last name.
    title string
    person job title.
    job_function string
    person job function (Customer Service, Design, Education etc).
    job_sub_function string
    person job sub function (Customer Success, Support, Graphic Design etc).
    management_level string
    person management level (M, D, VP, C).
    gender string
    person gender.
    email string
    person email address.
    email_status string
    person email.
    mobile_directdial string
    mobile direct dial number.
    city string
    person city.
    state string
    person state.
    county string
    person county.
    country string
    person country.
    linkedin_url string
    person linkedin url.

    Company Attributes

    Attribute Description
    id string
    internal company id.
    company_name string
    name of the company.
    domain string
    company website url.
    address string
    hq address.
    city string
    hq city name.
    state string
    hq state name.
    zip string
    hq zip code.
    country string
    hq country name.
    county string
    hq county name.
    phone_number string
    company phone number.
    fax_number string
    company fax number.
    employees string
    employees range (1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+).
    revenue string
    revenue range (0-1m, 1m-10m, 10m-50m, 50m-100m, 100m-200m, 200m-1b, 1b+).
    industry string
    company industry name.
    sic_code integer
    company sic code.
    sic_description string
    company sic code industry description.
    naics_code integer
    company naics code.
    naics_description string
    company naics code industry description.
    description string
    company description.
    year_founded integer
    company year founded.
    logo string
    company logo url.
    linkedin_url string
    company linkedin url.
    twitter_url string
    company twitter url.
    facebook_url string
    company facebook url.
    youtube_url string
    company youtube url.
    crunchbase_url string
    company crunchbase url.
    yelp_url string
    company yelp url.
    instagram_url string
    company instagram url.
    type string
    company type (private, public, education, government, non-profit).
    ticker string
    company stock ticker.
    exchange string
    company stock exchange.
    alexa_rank integer
    company website alexa ranking.

    Meta Attributes

    Attribute Description
    total integer
    total number of records found.
    page integer
    number of current page.
    next_page integer
    number of next page to retrieve.
    previous_page integer
    number of previous page to retrieve.
    first_page boolean
    determine if current page is first.
    last_page boolean
    determine if current page is last.

    User Info Attributes

    Attribute Description
    availableCredits integer
    user credits balance.

    Company Name to Domain API

    Response:

    {
    "data": {
        "company_name": "Amazon.com, Inc.",
        "domain": "amazon.com",
        "logo": "https://logo.uplead.com/amazon.com"
    },
    "userInfo": {
        "availableCredits": 100
    }
}

    Our Company Name to Domain API lets you convert the name of a company to its website domain and logo. The match is based on exact company name and returns the most important company (based on website traffic). Please note because not all company names are unique, there may be some inaccuracy in the results.

    Example Request

    GET

    https://api.uplead.com/v2/company-name-to-domain?company_name=amazon


    POST

    https://api.uplead.com/v2/company-name-to-domain

    Request JSON body:

    { "company_name": "amazon" }

    Parameters

    Parameter Description
    company_name Required
    company name.
    string

    Attributes

    Attribute Description
    company_name string
    company name.
    domain string
    company website url.
    logo string
    company logo url.

    User Info Attributes

    Attribute Description
    availableCredits integer
    user credits balance.

    Quick Search API

    Contacts Response:

    {
    "data": {
        "type": "contact",
        "results": [
            {
                "id": "d98e157e-c31d-40a0-9d98-b2fb8390797d",
                "first_name": "marc",
                "last_name": "benioff",
                "title": "ceo",
                "job_function": "",
                "job_sub_function": "",
                "management_level": "C",
                "gender": "male",
                "email": "[email protected]",
                "email_status": "valid",
                "phone_number": "4159017000",
                "mobile_directdial": "(415) 426-8562",
                "city": "San Francisco",
                "state": "CA",
                "county": "San Francisco",
                "country": "United States",
                "linkedin_url": "https://www.linkedin.com/in/marcbenioff/",
                "industry": "Internet",
                "domain": "salesforce.com", 
                "company": {
                    "id": "c7d44d9a-b84a-459a-9003-75e10415f74a",
                    "company_name": "Salesforce.com, Inc.",
                    "domain": "salesforce.com",
                    "address": "415 Mission Street, 3rd Floor",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip": 94105,
                    "county": "San Francisco",
                    "country": "United States",
                    "phone_number": "4159017000",
                    "fax_number": "4159017040",
                    "employees": "10001+",
                    "revenue": "1b+",
                    "industry": "Internet",
                    "sic_code": 7372,
                    "sic_description": "Prepackaged Software",
                    "naics_code": 518210,
                    "naics_description": "Data Processing, Hosting, and Related Services",
                    "description": "Salesforce.com, Inc. is an American cloud-based software
company, headquartered in San Francisco, California. Though the bulk of its revenue
comes from a customer relationship management (CRM) product, Salesforce also sells a
complementary suite of enterprise applications focused on customer service, marketing
automation, analytics and application development."
                    "year_founded": 1999,
                    "logo": "https://logo.uplead.com/salesforce.com",
                    "linkedin_url": "https://www.linkedin.com/company/salesforce",
                    "twitter_url": "http://twitter.com/salesforce",
                    "facebook_url": "https://www.facebook.com/salesforce",
                    "youtube_url": "https://www.youtube.com/user/salesforce",
                    "crunchbase_url": "https://www.crunchbase.com/organization/salesforce",
                    "yelp_url": "https://www.yelp.com/biz/salesforce-san-francisco",
                    "instagram_url": "https://instagram.com/salesforce/",
                    "type": "Public",
                    "ticker": "CRM",
                    "exchange": "NYSE",
                    "alexa_rank": 123
                }
            }
        ]
    },
    "userInfo": {
        "availableCredits": 100
    }
}

    Companies Response:

    {
    "data": {
        "type": "company",
        "results": [
            {
                "id": "c7d44d9a-b84a-459a-9003-75e10415f74a",
                "company_name": "Salesforce.com, Inc.",
                "domain": "salesforce.com",
                "address": "415 Mission Street, 3rd Floor",
                "city": "San Francisco",
                "state": "CA",
                "zip": 94105,
                "county": "San Francisco",
                "country": "United States",
                "phone_number": "4159017000",
                "fax_number": "4159017040",
                "employees": "10001+",
                "revenue": "1b+",
                "industry": "Internet",
                "sic_code": 7372,
                "sic_description": "Prepackaged Software",
                "naics_code": 518210,
                "naics_description": "Data Processing, Hosting, and Related Services",
                "description": "Salesforce.com, Inc. is an American cloud-based software
company, headquartered in San Francisco, California. Though the bulk of its revenue
comes from a customer relationship management (CRM) product, Salesforce also sells a
complementary suite of enterprise applications focused on customer service, marketing
automation, analytics and application development."
                "year_founded": 1999,
                "logo": "https://logo.uplead.com/salesforce.com",
                "linkedin_url": "https://www.linkedin.com/company/salesforce",
                "twitter_url": "http://twitter.com/salesforce",
                "facebook_url": "https://www.facebook.com/salesforce",
                "youtube_url": "https://www.youtube.com/user/salesforce",
                "crunchbase_url": "https://www.crunchbase.com/organization/salesforce",
                "yelp_url": "https://www.yelp.com/biz/salesforce-san-francisco",
                "instagram_url": "https://instagram.com/salesforce/",
                "type": "Public",
                "ticker": "CRM",
                "exchange": "NYSE",
                "alexa_rank": 123
            }
        ],
        "meta": {
            "total": 100,
            "page": 1,
            "next_page": 2,
            "previous_page": null,
            "first_page": true,
            "last_page": false
        }
    },
    "userInfo": {
        "availableCredits": 100
    }
}

    Contact Count Only Response:

    {
    "data": {
        "count": 507
    },
    "userInfo": {
        "availableCredits": 2876
    }
}

    The Quick Search API is available on the Professional, Elite, and Enterprise plans only.

    Example Request:

    GET

    https://api.uplead.com/v2/quick-search?type=contact&text=salesforce&job_functions[]=finance

    POST

    https://api.uplead.com/v2/quick-search

    Request JSON body:

    { "type": "contact", "text": "salesforce" "job_functions": ["finance"] }

    Parameters

    Parameter Description
    type Required
    type of entity.
    string
    Allowed values:
    • contact
    • company
    text Optional
    query string.
    string
    domain Optional
    company domain URL (e.g – amazon.com).
    string
    domains Optional
    company domain URLs (e.g – ["amazon.com", "google.com", "apple.com"]).
    array_of_strings
    name Optional
    person name.
    string
    job_functions Optional
    multiple person job functions.
    array of strings
    Allowed values:
    • Customer Service
    • Design
    • Education
    • Engineering
    • Finance
    • Health
    • Human Resources
    • Legal
    • Marketing
    • Media
    • Operations
    • Public Relations
    • Real Estate
    • Sales
    • Trades
    job_sub_functions Optional
    multiple person job sub functions.
    array of strings
    Allowed values:
    • Customer Success
    • Support
    • Graphic Design
    • Product Design
    • Web Design
    • Education Administration
    • Professor
    • Researcher
    • Data
    • Devops
    • Electrical
    • Mechanical
    • Network
    • Information Technology
    • Project Engineering
    • Quality Assurance
    • Security
    • Software
    • Systems
    • Web
    • Accounting
    • Investing
    • Tax
    • Dental
    • Fitness
    • Doctor
    • Nursing
    • Therapy
    • Wellness
    • Compensation
    • Employee Development
    • Recruiting
    • Lawyer
    • Paralegal
    • Judicial
    • Brand Marketing
    • Content Marketing
    • Product Marketing
    • Broadcasting
    • Editorial
    • Journalism
    • Video
    • Writing
    • Project Management
    • Office Management
    • Logistics
    • Product
    • Events
    • Media Relations
    • Property Management
    • Realtor
    • Accounts
    • Business Development
    • Pipeline
    management_levels Optional
    multiple person management levels.
    array of strings
    Allowed values:
    • M
    • D
    • VP
    • C
    titles Optional
    multiple job titles.
    array of strings
    title_search_mode Optional
    search mode for titles (default is "exact").
    string
    Allowed values:
    • include
    • exact
    cities Optional
    multiple person cities.
    array of strings
    states Optional
    multiple person states.
    array of strings
    countries Optional
    multiple person countries.
    array of strings
    regions Optional
    multiple person regions.
    array of strings
    Allowed values:
    • AMER
    • APAC
    • EMEA
    • LATAM
    location_target Optional
    location entity (default is "company").
    string
    Allowed values:
    • contact
    • company
    business_types Optional
    multiple person business types.
    array of strings
    Allowed values:
    • education
    • government
    • non_profit
    • public
    • private
    • subsidiary
    industries Optional
    multiple industries.
    array of strings
    industries_ids Optional
    multiple industry ids (e.g - ["15", "01", "17"]).
    array of strings
    sic_codes Optional
    multiple sic codes.
    array of strings
    naics_codes Optional
    multiple naics codes.
    array of strings
    employees Optional
    multiple employee ranges.
    array of strings
    Allowed values:
    • 1-10
    • 11-50
    • 51-200
    • 201-500
    • 501-1000
    • 1001-5000
    • 5001-10000
    • 10001+
    revenues Optional
    multiple revenues.
    array of strings
    Allowed values:
    • 0-1m
    • 1m-10m
    • 10m-50m
    • 50m-100m
    • 100m-200m
    • 200m-1b
    • 1b+
    exclude_eu Optional
    exclude EU contacts (default: "false").
    boolean
    exclusion_list_names Optional
    exclusion list names.
    You must upload your lists first here
    array of strings
    count_only Optional
    show only number of results for this query (default is false).
    boolean
    page Optional
    which results page to show (default is 1).
    integer
    per_page Optional
    number of results returned (default is 25, max is 100).
    integer

    Attributes

    Attribute Description
    id string
    internal person id.
    first_name string
    person first name.
    last_name string
    person last name.
    title string
    person job title.
    job_function string
    person job function (Customer Service, Design, Education etc).
    job_sub_function string
    person job sub function (Customer Success, Support, Graphic Design etc).
    management_level string
    person management level (M, D, VP, C).
    gender string
    person gender.
    email string
    person email address.
    email_status string
    person email.
    mobile_directdial string
    mobile direct dial number.
    city string
    person city.
    state string
    person state.
    county string
    person county.
    country string
    person country.
    linkedin_url string
    person linkedin url.

    Company Attributes

    Attribute Description
    id string
    internal company id.
    company_name string
    name of the company.
    domain string
    company website url.
    address string
    hq address.
    city string
    hq city name.
    state string
    hq state name.
    zip string
    hq zip code.
    country string
    hq country name.
    county string
    hq county name.
    phone_number string
    company phone number.
    fax_number string
    company fax number.
    employees string
    employees range (1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+).
    revenue string
    revenue range (0-1m, 1m-10m, 10m-50m, 50m-100m, 100m-200m, 200m-1b, 1b+).
    industry string
    company industry name.
    sic_code integer
    company sic code.
    sic_description string
    company sic code industry description.
    naics_code integer
    company naics code.
    naics_description string
    company naics code industry description.
    description string
    company description.
    year_founded integer
    company year founded.
    logo string
    company logo url.
    linkedin_url string
    company linkedin url.
    twitter_url string
    company twitter url.
    facebook_url string
    company facebook url.
    youtube_url string
    company youtube url.
    crunchbase_url string
    company crunchbase url.
    yelp_url string
    company yelp url.
    instagram_url string
    company instagram url.
    type string
    company type (private, public, education, government, non-profit).
    ticker string
    company stock ticker.
    exchange string
    company stock exchange.
    alexa_rank integer
    company website alexa ranking.

    Meta Attributes

    Attribute Description
    total integer
    total number of records found.
    page integer
    number of current page.
    next_page integer
    number of next page to retrieve.
    previous_page integer
    number of previous page to retrieve.
    first_page boolean
    determine if current page is first.
    last_page boolean
    determine if current page is last.

    User Info Attributes

    Attribute Description
    availableCredits integer
    user credits balance.

    Industries API

    Response:

    {
  "data": {
    "results": [
      {
        "id": "91",
        "industry_name": "Executive, Legislative & General Government, Except Finance"
      },
      {
        "id": "93",
        "industry_name": "Public Finance, Taxation & Monetary Policy"
      }
    ],
    "total": 2
  }
}

    The Industries Search API is available on the Professional, Elite, and Enterprise plans only.

    Example Request

    GET

    https://api.uplead.com/v2/industries?text=finance


    POST

    https://api.uplead.com/v2/industries

    Request JSON body:

    { "text": "finance" }

    Parameters

    Parameter Description
    text Optional
    industry name (returns a list of all industries if the text parameter is missing).
    string

    Attributes

    Attribute Description
    id string
    internal industry id.
    industry_name string
    industry name.
    total string
    total number of industries found.

    Preview API

    Response:

    {
  "data": {
      "results": [
          {
              "id": "d98e157e-c31d-40a0-9d98-b2fb8390797d",
              "first_name": "marc",
              "last_name": "benioff",
              "title": "ceo",
              "company": {
                  "id": "c7d44d9a-b84a-459a-9003-75e10415f74a",
                  "name": "Salesforce.com, Inc.",
                  "logo_url": "https://logo.uplead.com/salesforce.com"
              }
          }
      ]
  }
}

    Count Only Response:

    {
    "data": {
        "count": 507
    }
}

    Only for resellers.

    Example Request

    GET

    https://api.uplead.com/v2/prospector-preview?domain=salesforce.com&job_function=finance


    POST

    https://api.uplead.com/v2/prospector-preview

    Request JSON body:

    { "domain": "salesforce.com", "job_function": "finance" }

    Parameters

    Parameter Description
    domain Optional
    company domain URL (e.g – amazon.com).
    string
    domains Optional
    company domain URLs (e.g – ["amazon.com", "google.com", "apple.com"]).
    array_of_strings
    name Optional
    person name.
    string
    job_functions Optional
    multiple person job functions.
    array of strings
    Allowed values:
    • Customer Service
    • Design
    • Education
    • Engineering
    • Finance
    • Health
    • Human Resources
    • Legal
    • Marketing
    • Media
    • Operations
    • Public Relations
    • Real Estate
    • Sales
    • Trades
    job_sub_functions Optional
    multiple person job sub functions.
    array of strings
    Allowed values:
    • Customer Success
    • Support
    • Graphic Design
    • Product Design
    • Web Design
    • Education Administration
    • Professor
    • Researcher
    • Data
    • Devops
    • Electrical
    • Mechanical
    • Network
    • Information Technology
    • Project Engineering
    • Quality Assurance
    • Security
    • Software
    • Systems
    • Web
    • Accounting
    • Investing
    • Tax
    • Dental
    • Fitness
    • Doctor
    • Nursing
    • Therapy
    • Wellness
    • Compensation
    • Employee Development
    • Recruiting
    • Lawyer
    • Paralegal
    • Judicial
    • Brand Marketing
    • Content Marketing
    • Product Marketing
    • Broadcasting
    • Editorial
    • Journalism
    • Video
    • Writing
    • Project Management
    • Office Management
    • Logistics
    • Product
    • Events
    • Media Relations
    • Property Management
    • Realtor
    • Accounts
    • Business Development
    • Pipeline
    management_levels Optional
    multiple person management levels.
    array of strings
    Allowed values:
    • M
    • D
    • VP
    • C
    titles Optional
    multiple job titles.
    array of strings
    title_search_mode Optional
    search mode for titles (default is "exact").
    string
    Allowed values:
    • include
    • exact
    cities Optional
    multiple person cities.
    array of strings
    states Optional
    multiple person states.
    array of strings
    countries Optional
    multiple person countries.
    array of strings
    regions Optional
    multiple person regions.
    array of strings
    Allowed values:
    • AMER
    • APAC
    • EMEA
    • LATAM
    location_target Optional
    location entity (default is "company").
    string
    Allowed values:
    • contact
    • company
    business_types Optional
    multiple person business types.
    array of strings
    Allowed values:
    • education
    • government
    • non_profit
    • public
    • private
    • subsidiary
    industries Optional
    multiple industries.
    array of strings
    sic_codes Optional
    multiple sic codes.
    array of strings
    naics_codes Optional
    multiple naics codes.
    array of strings
    employees Optional
    multiple employee ranges.
    array of strings
    Allowed values:
    • 1-10
    • 11-50
    • 51-200
    • 201-500
    • 501-1000
    • 1001-5000
    • 5001-10000
    • 10001+
    revenues Optional
    multiple revenues.
    array of strings
    Allowed values:
    • 0-1m
    • 1m-10m
    • 10m-50m
    • 50m-100m
    • 100m-200m
    • 200m-1b
    • 1b+
    exclude_eu Optional
    exclude EU contacts (default: "false").
    boolean
    exclusion_list_names Optional
    exclusion list names.
    You must upload your lists first here
    array of strings
    count_only Optional
    show only number of results for this query (default is false).
    boolean
    num_results Optional
    limit of contacts in search results, value between 1 and 500 (default is 100).
    integer
    ids Optional
    multiple person internal IDs.
    array of strings

    Attributes

    Attribute Description
    id string
    internal person id.
    first_name string
    person first name.
    last_name string
    person last name.
    title string
    person job title.

    Company Attributes

    Attribute Description
    id string
    internal company id.
    name string
    name of the company.
    logo_url string
    company logo url.

    Lists API

    The Lists API is available on the Professional, Elite, and Enterprise plans only.

    Paginated lists response:

    {
  "data": {
    "results": [
      {
        "id": "f0b55257-415d-4b80-b265-5da92a9f9207",
        "name": "List 1",
        "contacts_count": 10
      },
      {
        "id": "044c1664-b674-4aaa-938c-b6fe80144afd",
        "name": "List 2",
        "contacts_count": 20
      },
      {
        "id": "1654d3d5-f72e-43bb-a4a3-6edf765b2724",
        "name": "List 3",
        "contacts_count": 30
      }
    ],
    "meta": {
      "total": 100,
      "page": 1,
      "next_page": 2,
      "previous_page": null,
      "first_page": true,
      "last_page": false
    }
  },
  "userInfo": {
    "availableCredits": 100
  }
}

    Retrieve a list / Create a list / Add contacts to list / Delete contacts from list response:

    {
  "data": {
    "id": "f0b55257-415d-4b80-b265-5da92a9f9207",
    "name": "List 1",
    "contacts_count": 0
  },
  "userInfo": {
    "availableCredits": 100
  }
}

    Delete list response:

    {
  "data": null,
  "userInfo": {
    "availableCredits": 100
  }
}

    Retrieve list contacts response:

    {
  "data": {
    "results": [
      {
        "id": "d98e157e-c31d-40a0-9d98-b2fb8390797d",
        "first_name": "marc",
        "last_name": "benioff",
        "title": "ceo",
        "company": {
          "id": "c7d44d9a-b84a-459a-9003-75e10415f74a",
          "name": "Salesforce.com, Inc.",
          "logo_url": "https://logo.uplead.com/salesforce.com"
        }
      }
    ],
    "meta": {
      "total": 100,
      "page": 1,
      "next_page": 2,
      "previous_page": null,
      "first_page": true,
      "last_page": false
    }
  },
  "userInfo": {
    "availableCredits": 100
  }
}

    Get paginated lists.

    GET

    https://api.uplead.com/v2/lists?text=list&page=1&per_page=3

    Parameters

    Parameter Description
    text Optional
    list name (returns a list of all lists by default).
    string
    page Optional
    which results page to show (default is 1).
    integer
    per_page Optional
    number of results returned (default is 15, max is 100).
    string

    Retrieve a list.

    GET

    https://api.uplead.com/v2/lists/f0b55257-415d-4b80-b265-5da92a9f9207

    Create a list.

    POST

    https://api.uplead.com/v2/lists

    JSON body:

    { "name": "New List" }

    Delete a list.

    DELETE

    https://api.uplead.com/v2/lists/f0b55257-415d-4b80-b265-5da92a9f9207

    Retrieve list contacts.

    GET

    https://api.uplead.com/v2/lists/f0b55257-415d-4b80-b265-5da92a9f9207/contacts

    Parameters

    Parameter Description
    text Optional
    contact name, company name or company URL (returns a list of all contacts by default).
    string
    page Optional
    which results page to show (default is 1).
    integer
    per_page Optional
    number of results returned (default is 15, max is 100).
    string

    Add contacts to list.

    POST

    https://api.uplead.com/v2/lists/f0b55257-415d-4b80-b265-5da92a9f9207/contacts/add

    JSON body:

    { "contact_ids": [ "d98e157e-c31d-40a0-9d98-b2fb8390797d" ] }

    Parameters

    Parameter Description
    contact_ids Required
    contact IDs.
    array of strings

    Delete contacts from list.

    DELETE

    https://api.uplead.com/v2/lists/f0b55257-415d-4b80-b265-5da92a9f9207/contacts/delete

    JSON body:

    { "contact_ids": [ "d98e157e-c31d-40a0-9d98-b2fb8390797d" ] }

    Parameters

    Parameter Description
    contact_ids Required
    contact IDs.
    array of strings