Introduction
6sense Revenue AI is a comprehensive platform that puts the power of AI, big data, and machine learning in every revenue team member's hands. With 6sense, revenue teams can capture anonymous buying signals throughout the buyer’s journey, target the right accounts at precisely the right time, and boost revenue performance with AI-driven recommendations for the channels and messages most likely to convert.
6sense curates the most relevant B2B dataset available, arming revenue teams with the right information to engage with the right accounts, with the right messages, at precisely the right time.
API Overview
The 6sense APIs are HTTP-based and allow programmatic communication between 6sense and other applications. Depending on the endpoint, the 6sense API requires different input data, and relevant data is provided in the response.
See below for descriptions of each API and the input and output data.
List of 6sense APIs
6senses APIs are used across customer systems like CRM, Marketing Automation Platform, and other technology commonly used to fill in data gaps ensuring revenue teams have the data necessary to make confident data driven GTM decisions. Responses are returned in JSON to support integration with common programming languages and development kits.
| API Name | Description |
|---|---|
| Company Identification API | Company Identification API (previously known as Company Details API) identifies anonymous website visitors by taking an IP address and matching it to an Account. Data returned from this API includes company firmographics, segments, and score data associated with that IP and company. Customers need the 6sense Platform to access this API. Know more about API Credits. |
| Company Firmographics API | Company Firmographics API (previously known as the Lead Enrichment API) delivers company firmographics and segments data attributes using the email id. Customers need 6sense Platform or Sales Intelligence package to access this API. Know more about API Credits. |
| Lead Scoring and Firmographics API | Lead Scoring and Firmographics API (previously known as Lead Enrichment and Scoring API) combines the responses from the Company Firmographics and Lead scoring APIs into a single response. This API is primarily designed for customers using Marketo and to access this API, customers need any 6sense Platform or Sales Intelligence package (for enrichment information) and need the Advanced package (for scoring information). Know more about API Credits. |
| Lead Scoring API | Lead Scoring API scores your net new leads using email id and returns predictive scores at the product level. Customers need 6sense Platform Advanced package to access the API. |
| People Enrichment API | Enrich contact level data using 6sense People Enrichment API directly in your rev-tech platforms (e.g.: CRM, MAP, BI, etc). This API delivers contact information and company firmographics attributes using the email id or LinkedIn URL or people ID. To access this API, customers need to purchase this API as add on and it will work with any 6sense Platform or Sales Intelligence package. Know more about API Credits. |
| People Search API | Easily search for people (or contacts or Leads) in an organisation to find the right one. People Search API delivers the list of profiles matching an account for a given domain. You can narrow down your search using filters like locations, Industries & job titles. This API returns whether or not 6sense has contact information details like Email, Phone, Mobile Number. To get actual contact details of the people using peopleID, use People Enrichment API. |
If your organization doesn’t have access to the 6sense ABM platform, click here to contact.
Types of API Credits
There are 2 types of API credits. These Credits are required to access the mentioned APIs. Please reach out to your CSM to get access to these APIs.
| API Credits | Description |
|---|---|
| Company Identification API Credits |
|
| Enrichment APIs Credit |
|
The same records exported from different APIs are counted toward API credits deduction. APIs like People Search and Lead Scoring don't deduct any API credits.
Best Practices
At 6sense, we are committed to the security and privacy of your data. Keeping that in mind, we recommend following best practices around API management.
- Give your API Token an appropriate name to help you track where it is being used. This can be the same as the integration for which the token is used.
- Do not assign the same API Token to more than one integration, unless necessary.
- Rotate your API tokens every 90 days.
- Migrate any “default_existing_token” as per guidance in the Migrate Existing Tokens section.
- Deactivate tokens that are not in use and delete tokens that you don’t plan to use anymore. Before deleting a token, if you need the token-related historical match rates and usage graph, follow instructions provided in Option 2 under the Migrate Existing Tokens section to save a copy.
- The API Token settings (Score and Segments Settings) are secure by default (does not return detailed information). Please adjust these settings as required to fetch information that is necessary for your use cases.
- For enrichment APIs as outlined above, please ensure that the API token is never exposed on any public domain. These APIs are designed for server-to-server communication.
Let’s start with the first step!
Get your API Token
A 6sense API token is an alphanumeric 40 character long key phrase randomly generated that gives you access to the APIs you purchased. 6sense recommends customers create unique API tokens per use case or integration to help track usage. For example, customers deploying the Company Identification API with Drift, PathFactory, and Google Analytics would create 3 unique API tokens – one for each system. This helps with usage tracking and troubleshooting.
Based on your API Credits purchase, you will be able to generate API tokens for all the APIs of the purchased credit type(s).
To generate a unique API token:
- You can go to the Settings >> API Token management page in the 6sense Platform.
- Click on Generate New API token.
- Select the API group and name your token.
- Select the Integrations.
- Add Allowed domains, if you want to restrict the usage of API on selected domains. This option is only available for Company Identification API.
- Copy your API token.
For generating API Token for Segments API, please reach out to 6sense support. Read more
HTTP Response Codes
6sense uses standard HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success; Codes in the 4xx or 5xx range indicate an error.
| Code | Description |
|---|---|
200 |
OK Successfully returned response. The response message varies, depending on the request method/endpoint and the requested data. |
201 |
Created The request has been fulfilled and has resulted in one or more new resources being created. |
204 |
No content The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. |
400 |
Bad request Required fields cannot be blank. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. |
401 |
Unauthorized Your API token is invalid or auth token is invalid or missing authorization header. |
402 |
Quota Exhausted Your allocated Quota is exhausted, please upgrade/top-up your API limit by reaching out to your CSM. |
403 |
Forbidden You do not have the appropriate user rights to access the request. Do not repeat the request. |
404 |
Not found The resource does not exist. |
422 |
Validation error A validation error occurred. |
429 |
Too Many Requests You have sent too many requests in a given amount of time ("rate limit"). Please try again later. |
50X |
Internal Server Error Something went wrong with the 6sense API. These errors are logged on our side. You can contact our team to resolve the issue. |
Error Responses
For each endpoint, errors are returned in the form of a JSON with a type and optional message.
| Type | Example |
|---|---|
| Required parameters are blank | {"status": "error", "message": "Email ID is mandatory and can’t be blank"} |
| No data found | {"status": "error", "message": "No data found. Please contact 6sense support, if you think this is an unexpected error."} |
Versioning
Each API will show the list of versions supported. You may receive timely notifications to upgrade the APIs to the latest stable version as we will deprecate the older versions which are no longer recommended to use.
| API | Current stable version |
|---|---|
| Company Identification API | v3 |
| Lead Scoring API | v2 |
| Company Firmographics API (previously known as the Lead Enrichment API) | v3 |
| Lead Scoring and Firmographics API | v2 |
| People Enrichment API | v1 |
API Rate Limit
All API requests are subject to rate limits. A rate limit is the number of API calls an app or user can make within a given time period. If this limit is exceeded or if CPU or total time limits are exceeded, the app or user may be throttled. API requests made by a throttled user or app will fail.
For our APIs we enforce a rate limit of 100 requests per minute interval, which is monitored for adjustment, if required, to ensure valid API requests are fulfilled successfully. In case you want to get this limit increased, please reach out to your CSM.
Company Identification API
Company Identification API identifies anonymous website visitors by taking an IP address and matching it to an Account. Data returned from this API includes company firmographics, segments, and score data associated with that IP and company. Customers need the 6sense RAIM Platform to access this API.
Client-side integration of this API is available within your Webtag configurations. Please use the same to turn ON this API.
For webtag, you do not need to create any API token. If you want to integrate this API outside of the webtag, then you need to create a new API token.
To create a new API token, follow the instructions within our knowledge base.
Company Identification API is designed for client-side implementation to unlock use cases like real time web visitor de-anonymization, website personalization, etc. where latency is a important. We do not recommend server side implementation of this API. If you have a complex use case, please talk to your CSM.
Please review the Version Information before using this API.
HTTP Request
Endpoint
GET
https://epsilon.6sense.com/v3/company/details
Headers
Sample Request
curl --location --request GET 'https://epsilon.6sense.com/v3/company/details' \
--header 'Authorization: Token {your_api_token}' \
--header 'X-6s-CustomID: {partner_name-partner_api_token}'
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://epsilon.6sense.com/v3/company/details");
xhr.setRequestHeader("Authorization", "Token {your_api_token}");
xhr.setRequestHeader("X-6s-CustomID", "{partner_name-partner_api_token}");
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://epsilon.6sense.com/v3/company/details',
'headers': {
'Authorization': 'Token {your_api_token}',
'X-6s-CustomID': '{partner_name-partner_api_token}'
}
};
request(options, function(error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "https://epsilon.6sense.com/v3/company/details"
payload = {}
headers = {
"Authorization": "Token {your_api_token}",
"X-6s-CustomID": "{partner_name-partner_api_token}"
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
{
"info": {
"name": "6signal",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "https://epsilon.6sense.com/v3/company/details",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"type": "text",
"value": "Token {your_api_token}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/x-www-form-urlencoded",
"disabled": true
},
{
"key": "EpsilonCookie",
"type": "text",
"value": "{optional cookie value}",
"disabled": true
},
{
"key": "X-6s-CustomID",
"type": "text",
"value": "{partner_name-partner_api_token}"
}
],
"url": {
"raw": "https://epsilon.6sense.com/v3/company/details",
"protocol": "https",
"host": [
"epsilon",
"6sense",
"com"
],
"path": [
"v3",
"company",
"details"
]
}
},
"response": []
}
]
}
| Header | Value |
|---|---|
| Authorization | Token <api_token> |
| EpsilonCookie(optional) |
If you are a Partner then, you must send this additional header for customer data identification.
| Header | Value |
|---|---|
| X-6s-CustomID |
|
Response Data
Sample Response
{
"company": {
"company_match": "Match",
"additional_comment": "Company name or domain match was found",
"companyId": "j776sdf7sdfh766777dsf",
"domain": "g.ucla.edu",
"name": "UCLA",
"region": "Northern America",
"country": "United States",
"state": "California",
"city": "Los Angeles",
"industry": "Education",
"country_iso_code": "US",
"address": "308 Charles E. Young Drive North A210 Fowler Building/Box 951510",
"zip": "90095",
"phone": "(310) 825-4321",
"employee_range": "10,000+",
"revenue_range": "$5B+",
"employee_count": "22000",
"annual_revenue": "7449000000",
"is_blacklisted": false,
"is_6qa": true,
"geoIP_country": "United States",
"geoIP_state": "California",
"geoIP_city": "San Jose",
"state_code": "CA",
"industry_v2": [
{
"industry": "Education",
"subindustry": "Colleges & Universities"
}
],
"sic_description": "",
"sic": "",
"naics": "6113",
"naics_description": "Colleges, Universities, and Professional Schools"
},
"scores": [
{
"is_6qa": true,
"product": "6sense",
"product_display_name": "6sense",
"intent_score": 63,
"buying_stage": "Consideration",
"profile_score": 9,
"profile_fit": "Weak"
}
],
"segments": {
"ids": [
4713,
28237,
218915,
53685
],
"names": [
"Net New Logo Website Engagement Last 30 Days",
"6s for 6s: Keyword_Sales Intelligence",
"Cvent: Researching Virtual Events",
"EY - Enterprise Accounts (DemandGen)"
],
"list": [
{
"name": "Net New Logo Website Engagement Last 30 Days",
"id": 4713
},
{
"name": "6s for 6s: Keyword_Sales Intelligence",
"id": 28237
},
{
"name": "Cvent: Researching Virtual Events",
"id": 218915
},
{
"name": "EY - Enterprise Accounts (DemandGen)",
"id": 53685
}
]
},
"confidence": "Very High"
}
| Parameters | |
|---|---|
| Account/company Level Variables |
Below are the list of company variables that will be available in the API response.
Below are sample values for these parameters.
|
| company_match |
String
Identifies if 6sense has matched an IP to an Account. Response could be "Match" or "Non-actionable Match" or "No Match"
"Match" or "Non-actionable Match" or "No Match"
|
| additional_comment |
String
Provides details into the company_match status and match reasons.
In case of "Match" it will return "Company name or domain match was found".
In case of "Non-actionable Match" it will return "There is no valid B2B use case as this was matched to something other than a company name/domain (i.e.: bot, host, noisy signal, etc.)". And In case of "No match" it will return "No company name or domain was found". |
| companyId |
String
6sense Unique ID of the Company or Account
78678as6d6as87d6as
|
| name |
String
Name of the company
6sense
|
| domain |
String
Website of the company
6sense .com
|
| industry |
String
Industry of the company
Software and Technology
|
| industry_v2 |
Object
Industry and Sub-Industry of the company
"industry": "Education","subindustry": "Colleges & Universities"
|
| country |
String
Country of the company’s Headquarter
United States
|
| address |
String
Address
450 Mission
|
| state |
String
State
California
|
| city |
String
City or Location
San Francisco
|
| zip |
String
Zip code
94107
|
| employee_count |
String
Approximate Employee count
201
|
| employee_range |
String
Employee Range
100 - 249
|
| annual_revenue |
String
Approximate Annual Revenue
$12,603,100
|
| revenue_range |
String
Annual Revenue Range
$10M - $25M
|
| sic |
String
Standard Industrial Classification Codes (SIC Codes) of the company
7372
|
| sic_description |
String
Additional details provided by SIC
Prepackaged Software
|
| naics |
String
North American Industry Classification System (NAICS)
5112
|
| naics_description |
String
Additional details provided by NAICS
Software Publishers
|
| region |
String
Geographic Region of the Headquarter
North America
|
| country_iso_code |
String
Country ISO code
US
|
| phone |
String
Company Phone Number
(415) 212-9225
|
| is_blacklisted |
True
|
| is_6qa |
Boolean
Account level 6QA (true when this account is considered as hot account by 6sense)
True
|
| geoIP_country |
String
geographical country of the visitor IP address
United States
|
| geoIP_state |
String
geographical state of the visitor IP address
California
|
| geoIP_city |
String
geographical city of the visitor IP address
San Jose
|
| Score for each product |
Predictive scores will be returned at the product level. If you have multiple product model, they API will return scores for each product category. To receive score information in the API you will need to enable this feature in the API Settings & Configurations. For more details on scoring and how scores are determined please visit the 6sense Knowledge Base in Rev City.
Below are sample values for these parameters.
|
| is_6qa |
Boolean
Account level 6QA (true when account is considered as hot account by 6sense for this product)
True
|
| product |
String
The name of the specific predictive model when a customer has more than one model. The product category values are the model names.
ace
|
| intent_score |
Number
The numerical intent score that is tied to a specific buying stage. The numerical range is 0-100.
81
|
| buying_stage |
String
A 6sense AI-derived in-market prediction of the likelihood to open an opportunity in the next 90 days for a particular product category. Response could be Purchase, Decision, Consideration, Awareness, Target.
Purchase
|
| profile_score |
Number
The numerical profile fit score that is tied to a specific profile fit. The numerical range is 0-100.
73
|
| profile_fit |
String
Profile fit identifies accounts based on ideal customer profile (ICP) by looking at historical firmographic data within the CRM. Response could be Strong, Moderate, Weak.
Strong
|
| product_display_name |
String
Name of your product displayed externally.
ace
|
| Segments | |
| ids |
Array
Id for single or multiple segments
12121 or 456456, 119900, 226688,
|
| names |
Array
This gives out the Segment Name. Visibility of Segment Name can be controlled in API Settings. To control these settings within the 6sense platform review the instructions here.
“Web Visitors Last 30 days”, “second”, “third”
|
| list |
Array
Combined response for Segment ID and Name. Visibility of Segment Name can be controlled in API Settings. To control these settings within the 6sense platform review the instructions here.
"name": "Web Visitors Last 30 days", "id": 123123
|
| confidence |
String
The 6sense's confidence in the accuracy of the identity of the account. Response could be Very High, High, Moderate, Low.
Very High
|
Response Codes
| Code | Definition |
|---|---|
200 |
OK Successfully returned response. The response message varies, depending on the request method/endpoint and the requested data. |
OTHERS |
Other common HTTP response codes Please see HTTP Response Codes to know more codes. |
Currently, we support only IPV4 IP addresses.In case of invalid IP Address, you will get blank data for each of these above mentioned variables.
If a field is not present, then we’ll return an empty list or null value for that field.
Company Firmographics API
The Company Firmographics API (previously known as Lead Enrichment API) delivers company firmographics data for the provided people (or lead or contact) email address. The response also includes segment information. Customers need 6sense Platform or Sales Intelligence package to access this API.
You would need Enrichment APIs Credit to access this API. If you want to create or delete these API tokens, please reach out to support. Read more
Please review the Version Information before using this API.
Version 3 (Latest)
HTTP Request
Endpoint
POSThttps://api.6sense.com/v1/enrichment/company
Headers
| Header | Value |
|---|---|
| Authorization | Token <api_token> |
| Content-Type | application/x-www-form-urlencoded |
Input Params
Sample Request
curl --location --request POST 'https://api.6sense.com/v1/enrichment/company' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cache-Control: no-cache' \
--header 'Authorization: Token {your_api_token}' \
--data-urlencode 'email=<user_name>@<domain>.com' \
--data-urlencode 'domain=<domain_value>' \
--data-urlencode 'country=<country_value>' \
--data-urlencode 'company=<company_value>' \
--data-urlencode 'industry=<industry_value>' \
--data-urlencode 'title=<title_value>' \
--data-urlencode 'role=<role_value>' \
--data-urlencode 'firstname=<firstname_value>' \
--data-urlencode 'lastname=<lastname_value>' \
--data-urlencode 'leadsource=<leadsource_value>'
var data = "email=<user_name>@<domain>.com &
domain = < domain_value >
&
country = < country_value >
&
company = < company_value >
&
industry = < industry_value >
&
title = < title_value >
&
role = < role_value >
&
firstname = < firstname_value >
&
lastname = < lastname_value >
&
leadsource = < leadsource_value >
";
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.6sense.com/v1/enrichment/company");
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("Cache-Control", "no-cache");
xhr.setRequestHeader("Authorization", "Token {your_api_token}");
xhr.send(data);
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://api.6sense.com/v1/enrichment/company',
'headers': {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
},
form: {
'email': '<user_name>@<domain>.com',
'domain': '<domain_value>',
'country': '<country_value>',
'company': '<company_value>',
'industry': '<industry_value>',
'title': '<title_value>',
'role': '<role_value>',
'firstname': '<firstname_value>',
'lastname': '<lastname_value>',
'leadsource': '<leadsource_value>'
}
};
request(options, function(error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "https://api.6sense.com/v1/enrichment/company"
payload=’email=<user_name>@<domain>.com
&domain=<domain_value>
&country=<country_value>
&company=<company_value>
&industry=<industry_value>
&title=<title_value>
&role=<role_value>
&firstname=<firstname_value>
&lastname=<lastname_value>
&leadsource=<leadsource_value>’
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
{
"info": {
"name": "sample_scribe",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "https://api.6sense.com/v1/enrichment/company",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
},
{
"key": "Cache-Control",
"value": "no-cache",
"type": "text"
},
{
"key": "Authorization",
"value": "Token {your_api_token}",
"type": "text"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "email",
"value": "<user_name>@<domain>.com\n",
"type": "text"
},
{
"key": "domain",
"value": "<domain_value>",
"type": "text"
},
{
"key": "country",
"value": "<country_value>",
"type": "text"
},
{
"key": "company",
"value": "<company_value>",
"type": "text"
},
{
"key": "industry",
"value": "<industry_value>",
"type": "text"
},
{
"key": "title",
"value": "<title_value>",
"type": "text"
},
{
"key": "role",
"value": "<role_value>",
"type": "text"
},
{
"key": "firstname",
"value": "<firstname_value>",
"type": "text"
},
{
"key": "lastname",
"value": "<lastname_value>",
"type": "text"
},
{
"key": "leadsource",
"value": "<leadsource_value>",
"type": "text"
}
]
},
"url": {
"raw": "https://api.6sense.com/v1/enrichment/company",
"protocol": "https",
"host": [
"api",
"6sense",
"com"
],
"path": [
"v1",
"enrichment",
"company"
],
"query": [
{
"key": "country",
"value": "",
"disabled": true
}
]
}
},
"response": []
}
]
}
| Parameters | |
|---|---|
|
StringMandatory only if domain is blank
If both email and domain are provided as input then, we should prioritize email for match and then fall back to domain
abc.xyz@6sense.com
|
|
| domain |
StringMandatory only if email is blank
If both email and domain are provided as input then, we should prioritize email for match and then fall back to domain.
6sense.com
|
| country |
Stringoptional
Used as filter along with the mandatory parameter
US
|
| company |
Stringoptional
Used as filter along with the mandatory parameter
Dell
|
| industry |
Stringoptional
Used as filter along with the mandatory parameter
Software and Technology
|
| title |
Stringoptional
Used as filter along with the mandatory parameter
Procurement Manager
|
| role |
Stringoptional
Used as filter along with the mandatory parameter
Procurement Manager
|
| firstname |
Stringoptional
Used as filter along with the mandatory parameter
ABC
|
| lastname |
Stringoptional
Used as filter along with the mandatory parameter
XYZ
|
| leadsource |
Stringoptional
Used as filter along with the mandatory parameter
Website form
|
Response Data
Sample Response
{
"company": {
"companyId": "j776sdf7sdfh766777dsf",
"domain": "6sense.com",
"name": "6sense",
"region": "Northern America",
"country": "United States",
"countryISOCode": "US",
"state": "California",
"city": "San Francisco",
"streetAddress": "450 Mission St,",
"postalCode": "94105",
"companyPhone": "415-212-9225",
"industry": "Software and Technology",
"employeeRange": "1,000 - 4,999",
"revenueRange": "$100M - $250M",
"employeeCount": "1192",
"annualRevenue": "104000000",
"titleLevel": "staff",
"titleFunction": "engineering",
"sicdescription": "Prepackaged Software",
"siccode": "7372",
"naicscode": "511210",
"naicsdescription": "Software Publishers"
},
"segments": {
"ids": [],
"names": [],
"list": []
}
}
Account/company Level Variables: Below are the data points that are available in the API response.
| Parameters | |
|---|---|
| companyId |
String
6sense Unique Id of the Company or Account
78678as6d6as87d6as
|
| domain |
String
Website of the company
6sense.com
|
| name |
String
Name of the company
6sense
|
| industry |
String
Industry of the company
Software and Technology
|
| country |
String
Country of the company’s Headquarter
United States
|
| streetAddress |
String
Address
450 Mission
|
| state |
String
State
California
|
| city |
String
City or Location
San Francisco
|
| postalCode |
String
Zip code
94107
|
| employeeCount |
String
Approximate Employee count
201
|
| employeeRange |
String
Employee Range
100 - 249
|
| annualRevenue |
String
Approximate Annual Revenue
$12,603,100
|
| titleLevel |
String
Title of the Org-structure level
staff
|
| titleFunction |
String
Function title
engineering
|
| revenueRange |
String
Annual Revenue Range
$10M - $25M
|
| siccode |
String
Standard Industrial Classification Codes (SIC Codes) of the company
7372
|
| sicdescription |
String
Additional details provided by SIC
Prepackaged Software
|
| naicscode |
String
North American Industry Classification System (NAICS)
5112
|
| naicsdescription |
String
Additional details provided by NAICS
Software Publishers
|
| region |
String
Geographic Region of the Headquarter
North America
|
| countryISOCode |
String
Country ISO code
US
|
| companyPhone |
String
Company Phone Number
(415) 212-9225
|
| Segments |
Segments published within the 6sense ABM platform will be available in the API response. Segments Name will be available only if enabled in API Settings. To control these settings within the 6sense platform review the instructions here.
Below are sample values for these parameters.
|
| ids |
Array
Id for single or multiple segments
12121 or 456456, 119900, 226688,
|
| names |
Array
This gives out the Segment Name. Visibility of Segment Name can be controlled in API Settings. To control these settings within the 6sense platform review the instructions here.
“Web Visitors Last 30 days”, “second”, “third”
|
| list |
Array
Combined response for Segment ID and Name. Visibility of Segment Name can be controlled in API Settings. To control these settings within the 6sense platform review the instructions here.
"name": "Web Visitors Last 30 days",
|
Response Codes
| Code | Definition |
|---|---|
200 |
OK Successfully returned response against an email address |
404 |
Not found Invalid email ID. Please make sure you have sent a valid email address in email field. |
OTHERS |
Other common HTTP response codes Please see HTTP Response Codes to know more codes. |
In case of invalid email Address, you will get blank data for each of these above mentioned variables.If a field is not present, then we’ll return an empty list or null value for that field.
Version 2
HTTP Request
Endpoint
POSThttps://scribe.6sense.com/v2/people/enrichment
Headers
| Header | Value |
|---|---|
| Authorization | Token <api_token> |
| Content-Type | application/x-www-form-urlencoded |
Input Params
Sample Request
curl --location --request POST 'https://scribe.6sense.com/v2/people/enrichment' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cache-Control: no-cache' \
--header 'Authorization: Token {your_api_token}' \
--data-urlencode 'email=<user_name>@<domain>.com' \
--data-urlencode 'country=<country_value>' \
--data-urlencode 'company=<company_value>' \
--data-urlencode 'website=<website_value>' \
--data-urlencode 'title=<title_value>' \
--data-urlencode 'leadsource=<leadsource_value>' \
--data-urlencode 'firstname=<firstname_value>' \
--data-urlencode 'lastname=<lastname_value>' \
--data-urlencode 'role=<role_value>' \
--data-urlencode 'industry=<industry_value>'
var data = "email=<user_name>@<domain>.com &
country = < country_value >
&
company = < company_value >
&
website = < website_value >
&
title = < title_value >
&
leadsource = < leadsource_value >
&
firstname = < firstname_value >
&
lastname = < lastname_value >
&
role = < role_value >
&
industry = < industry_value > ";
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://scribe.6sense.com/v2/people/enrichment");
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("Cache-Control", "no-cache");
xhr.setRequestHeader("Authorization", "Token {your_api_token}");
xhr.send(data);
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://scribe.6sense.com/v2/people/enrichment',
'headers': {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
},
form: {
'email': '<user_name>@<domain>.com',
'country': '<country_value>',
'company': '<company_value>',
'website': '<website_value>',
'title': '<title_value>',
'leadsource': '<leadsource_value>',
'firstname': '<firstname_value>',
'lastname': '<lastname_value>',
'role': '<role_value>',
'industry': '<industry_value>'
}
};
request(options, function(error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "https://scribe.6sense.com/v2/people/enrichment"
payload=’email=<user_name>@<domain>.com
&country=<country_value>
&company=<company_value>
&website=<website_value>
&title=<title_value>
&leadsource=<leadsource_value>
&firstname=<firstname_value>
&lastname=<lastname_value>
&role=<role_value>
&industry=<industry_value>’
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
{
"info": {
"name": "sample_scribe",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "https://scribe.6sense.com/v2/people/enrichment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
},
{
"key": "Cache-Control",
"value": "no-cache",
"type": "text"
},
{
"key": "Authorization",
"value": "Token {your_api_token}",
"type": "text"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "email",
"value": "<user_name>@<domain>.com\n",
"type": "text"
},
{
"key": "country",
"value": "<country_value>",
"type": "text"
},
{
"key": "company",
"value": "<company_value>",
"type": "text"
},
{
"key": "website",
"value": "<website_value>",
"type": "text"
},
{
"key": "title",
"value": "<title_value>",
"type": "text"
},
{
"key": "leadsource",
"value": "<leadsource_value>",
"type": "text"
},
{
"key": "firstname",
"value": "<firstname_value>",
"type": "text"
},
{
"key": "lastname",
"value": "<lastname_value>",
"type": "text"
},
{
"key": "role",
"value": "<role_value>",
"type": "text"
},
{
"key": "industry",
"value": "<industry_value>",
"type": "text"
}
]
},
"url": {
"raw": "https://scribe.6sense.com/v2/people/enrichment",
"protocol": "https",
"host": [
"scribe",
"6sense",
"com"
],
"path": [
"v2",
"people",
"enrichment"
],
"query": [
{
"key": "country",
"value": "",
"disabled": true
}
]
}
},
"response": []
}
]
}
| Parameters | |
|---|---|
|
Stringrequired
A Valid Email address for which you are requesting details.
xyz@acme.com
|
|
| country |
Stringoptional
Base country of the company/account
US
|
| website |
Stringoptional
Website of the company/account
acme.com
|
| company |
Stringoptional
Name of the company/account
Dell
|
| title |
Stringoptional
Designation of the Lead
Procurement Manager
|
| leadsource |
Stringoptional
Source of the lead as per your database
Website form
|
| firstname |
Stringoptional
First name of the Lead
ABC
|
| lastname |
Stringoptional
Last name of the Lead
XYZ
|
| role |
Stringoptional
Role of the Lead
Procurement Manager
|
| industry |
Stringoptional
Industry of the company
Software and Technology
|
Response Data
Sample Response
{
"company": {
"domain": "6sense.com",
"name": "6sense",
"region": "Northern America",
"country": "United States",
"countryISOCode": "US",
"state": "California",
"city": "San Francisco",
"streetAddress": "450 Mission St,",
"postalCode": "94105",
"companyPhone": "415-212-9225",
"industry": "Software and Technology",
"employeeRange": "1,000 - 4,999",
"revenueRange": "$100M - $250M",
"employeeCount": "1192",
"annualRevenue": "104000000",
"titleLevel": "staff",
"titleFunction": "engineering",
"sicdescription": "Prepackaged Software",
"siccode": "7372",
"naicscode": "511210",
"naicsdescription": "Software Publishers"
},
"segments": {
"ids": [],
"names": [],
"list": []
}
}
Account/company Level Variables: Below are the data points that are available in the API response.
| Parameters | |
|---|---|
| domain |
String
Website of the company
6sense.com
|
| name |
String
Name of the company
6sense
|
| industry |
String
Industry of the company
Software and Technology
|
| country |
String
Country of the company’s Headquarter
United States
|
| streetAddress |
String
Address
450 Mission
|
| state |
String
State
California
|
| city |
String
City or Location
San Francisco
|
| postalCode |
String
Zip code
94107
|
| employeeCount |
String
Approximate Employee count
201
|
| employeeRange |
String
Employee Range
100 - 249
|
| annualRevenue |
String
Approximate Annual Revenue
$12,603,100
|
| titleLevel |
String
Title of the Org-structure level
staff
|
| titleFunction |
String
Function title
engineering
|
| revenueRange |
String
Annual Revenue Range
$10M - $25M
|
| siccode |
String
Standard Industrial Classification Codes (SIC Codes) of the company
7372
|
| sicdescription |
String
Additional details provided by SIC
Prepackaged Software
|
| naicscode |
String
North American Industry Classification System (NAICS)
5112
|
| naicsdescription |
String
Additional details provided by NAICS
Software Publishers
|
| region |
String
Geographic Region of the Headquarter
North America
|
| countryISOCode |
String
Country ISO code
US
|
| companyPhone |
String
Company Phone Number
(415) 212-9225
|
| Segments |
Segments published within the 6sense ABM platform will be available in the API response. Segments Name will be available only if enabled in API Settings. To control these settings within the 6sense platform review the instructions here.
Below are sample values for these parameters.
|
| ids |
Array
Id for single or multiple segments
12121 or 456456, 119900, 226688,
|
| names |
Array
This gives out the Segment Name. Visibility of Segment Name can be controlled in API Settings. To control these settings within the 6sense platform review the instructions here.
“Web Visitors Last 30 days”, “second”, “third”
|
| list |
Array
Combined response for Segment ID and Name. Visibility of Segment Name can be controlled in API Settings. To control these settings within the 6sense platform review the instructions here.
"name": "Web Visitors Last 30 days",
|
Response Codes
| Code | Definition |
|---|---|
200 |
OK Successfully returned response against an email address |
404 |
Not found Invalid email ID. Please make sure you have sent a valid email address in email field. |
OTHERS |
Other common HTTP response codes Please see HTTP Response Codes to know more codes. |
In case of invalid email Address, you will get blank data for each of these above mentioned variables.If a field is not present, then we’ll return an empty list or null value for that field.
Lead Scoring and Firmographics API
Lead Scoring and Firmographics API (previously known as Lead Enrichment and Scoring API) combines the API responses for Company Firmographics API and Lead Scoring API. This API is specifically designed to unlock real-time enrichment and scoring use cases from marketing automation platforms like Marketo.
If configured from Marketo, the API will fire when a new lead is added to Marketo and matches based on the email address. It returns scores (based on the product category), company firmographics, and segment data.
To use this API, customers need a valid Platform subscription for enrichment use cases and an Advanced package for scoring. You would also need Enrichment APIs Credit to access this API. If you want to create or delete these API tokens, please reach out to support. Read more
Please review the Version Information before using this API.
HTTP Request
Endpoint
POSThttps://scribe.6sense.com/v2/people/full
Headers
| Header | Value |
|---|---|
| Authorization | Token <api_token> |
| Content-Type | application/x-www-form-urlencoded |
Input Params
Sample Request
curl --location --request POST 'https://scribe.6sense.com/v2/people/full' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cache-Control: no-cache' \
--header 'Authorization: Token {your_api_token}' \
--data-urlencode 'email=<user_name>@<domain>.com' \
--data-urlencode 'country=<country_value>' \
--data-urlencode 'company=<company_value>' \
--data-urlencode 'website=<website_value>' \
--data-urlencode 'title=<title_value>' \
--data-urlencode 'leadsource=<leadsource_value>' \
--data-urlencode 'firstname=<firstname_value>' \
--data-urlencode 'lastname=<lastname_value>' \
--data-urlencode 'role=<role_value>' \
--data-urlencode 'industry=<industry_value>'
var data = "email=<user_name>@<domain>.com &
country = < country_value >
&
company = < company_value >
&
website = < website_value >
&
title = < title_value >
&
leadsource = < leadsource_value >
&
firstname = < firstname_value >
&
lastname = < lastname_value >
&
role = < role_value >
&
industry = < industry_value > ";
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://scribe.6sense.com/v2/people/full");
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("Cache-Control", "no-cache");
xhr.setRequestHeader("Authorization", "Token {your_api_token}");
xhr.send(data);
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://scribe.6sense.com/v2/people/full',
'headers': {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
},
form: {
'email': '<user_name>@<domain>.com\n',
'country': '<country_value>',
'company': '<company_value>',
'website': '<website_value>',
'title': '<title_value>',
'leadsource': '<leadsource_value>',
'firstname': '<firstname_value>',
'lastname': '<lastname_value>',
'role': '<role_value>',
'industry': '<industry_value>'
}
};
request(options, function(error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "https://scribe.6sense.com/v2/people/full"
payload=’email=<user_name>@<domain>.com
&country=<country_value>
&company=<company_value>
&website=<website_value>
&title=<title_value>
&leadsource=<leadsource_value>
&firstname=<firstname_value>
&lastname=<lastname_value>
&role=<role_value>
&industry=<industry_value>’
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
{
"info": {
"name": "sample_scribe",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "https://scribe.6sense.com/v2/people/full",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
},
{
"key": "Cache-Control",
"value": "no-cache",
"type": "text"
},
{
"key": "Authorization",
"value": "Token {your_api_token}",
"type": "text"
},
{
"key": "X-Forwarded-For",
"value": "1.0.185.47",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "email",
"value": "<user_name>@<domain>.com\n",
"type": "text"
},
{
"key": "country",
"value": "<country_value>",
"type": "text"
},
{
"key": "company",
"value": "<company_value>",
"type": "text"
},
{
"key": "website",
"value": "<website_value>",
"type": "text"
},
{
"key": "title",
"value": "<title_value>",
"type": "text"
},
{
"key": "leadsource",
"value": "<leadsource_value>",
"type": "text"
},
{
"key": "firstname",
"value": "<firstname_value>",
"type": "text"
},
{
"key": "lastname",
"value": "<lastname_value>",
"type": "text"
},
{
"key": "role",
"value": "<role_value>",
"type": "text"
},
{
"key": "industry",
"value": "<industry_value>",
"type": "text"
}
]
},
"url": {
"raw": "https://scribe.6sense.com/v2/people/full",
"protocol": "https",
"host": [
"scribe",
"6sense",
"com"
],
"path": [
"v2",
"people",
"full"
],
"query": [
{
"key": "country",
"value": "",
"disabled": true
}
]
}
},
"response": []
}
]
}
| Parameters | |
|---|---|
|
Stringrequired
A Valid Email address for which you are requesting details.
xyz@acme.com
|
|
| country |
Stringrequired
Base country of the company/account
US
|
| website |
Stringoptional
Website of the company/account
acme.com
|
| company |
Stringoptional
Name of the company/account
Dell
|
| title |
Stringoptional
Designation of the Lead
Procurement Manager
|
| leadsource |
Stringoptional
Source of the lead as per your database
Website form
|
| firstname |
Stringoptional
First name of the Lead
ABC
|
| lastname |
Stringoptional
Last name of the Lead
XYZ
|
| role |
Stringoptional
Role of the Lead
Procurement Manager
|
| industry |
Stringoptional
Industry of the company
Software and Technology
|
Response Data
Sample Response
{
"company": {
"companyId": "j776sdf7sdfh766777dsf",
"domain": "6sense.com",
"name": "6sense",
"region": "Northern America",
"country": "United States",
"countryISOCode": "US",
"state": "California",
"city": "San Francisco",
"streetAddress": "450 Mission St,",
"postalCode": "94105",
"companyPhone": "415-212-9225",
"industry": "Software and Technology",
"employeeRange": "1,000 - 4,999",
"revenueRange": "$100M - $250M",
"employeeCount": "1192",
"annualRevenue": "104000000",
"titleLevel": "staff",
"titleFunction": "engineering",
"sicdescription": "Prepackaged Software",
"siccode": "7372",
"naicscode": "511210",
"naicsdescription": "Software Publishers"
},
"scores": [
{
"product": "6sense",
"company_intent_score": 0,
"company_buying_stage": "Target",
"company_profile_score": 81,
"company_profile_fit": "Strong",
"contact_intent_score": 0,
"contact_grade": "D",
"contact_profile_score": 58,
"contact_profile_fit": "Moderate"
}
],
"segments": {
"ids": [
4713,
28237,
218915,
53685
],
"names": [
"Net New Logo Website Engagement Last 30 Days",
"6s for 6s: Keyword_Sales Intelligence",
"Cvent: Researching Virtual Events",
"EY - Enterprise Accounts (DemandGen)"
],
"list": [
{
"name": "Net New Logo Website Engagement Last 30 Days",
"id": 4713
},
{
"name": "6s for 6s: Keyword_Sales Intelligence",
"id": 28237
},
{
"name": "Cvent: Researching Virtual Events",
"id": 218915
},
{
"name": "EY - Enterprise Accounts (DemandGen)",
"id": 53685
}
]
},
}
| Parameters | |
|---|---|
| Account/company Level Variables |
Below are the data points that are available in the API response.
Below are sample values for these parameters.
|
| companyId |
String
6sense Unique Id of the Company or Account
78678as6d6as87d6as
|
| name |
String
Name of the company
6sense
|
| domain |
String
Website of the company
6sense.com
|
| industry |
String
Industry of the company
Software and Technology
|
| country |
String
Country of the company’s Headquarter
United States
|
| address |
String
Address
450 Mission
|
| state |
String
State
California
|
| city |
String
City or Location
San Francisco
|
| zip |
String
Zip code
94107
|
| employee_count |
String
Approximate Employee count
201
|
| employee_range |
String
Employee Range
100 - 249
|
| annual_revenue |
String
Approximate Annual Revenue
$12,603,100
|
| titleLevel |
String
Title of the Org-structure level
staff
|
| titleFunction |
String
Function title
engineering
|
| revenue_range |
String
Annual Revenue Range
$10M - $25M
|
| sic |
String
Standard Industrial Classification Codes (SIC Codes) of the company
7372
|
| sic_description |
String
Additional details provided by SIC
Prepackaged Software
|
| naics |
String
North American Industry Classification System (NAICS)
5112
|
| naics_description |
String
Additional details provided by NAICS
Software Publishers
|
| region |
String
Geographic Region of the Headquarter
North America
|
| country_iso_code |
String
Country ISO code
US
|
| phone |
String
Company Phone Number
(415) 212-9225
|
| is_blacklisted |
True
|
| Score for each product |
Predictive scores will be returned at the product level. If you have multiple product model, they API will return scores for each product category. To receive score information in the API you will need to enable this feature in the API Settings & Configurations. For more details on scoring and how scores are determined, please visit the 6sense Knowledge Base in Rev City.
Below are sample values for these parameters.
|
| product |
String
The name of the specific predictive model when a customer has more than one model. The product category values are the model names.
ace
|
| company_intent_score |
Number
The numerical intent score that is tied to a specific buying stage. The numerical range is 0-100.
81
|
| company_buying_stage |
String
A 6sense AI-derived in-market prediction of the likelihood to open an opportunity in the next 90 days for a particular product category. Response could be Purchase, Decision, Consideration, Awareness, Target.
Purchase
|
| company_profile_score |
Number
The numerical profile fit score that is tied to a specific profile fit. The numerical range is 0-100.
73
|
| company_profile_fit |
String
Profile fit identifies accounts based on ideal customer profile (ICP) by looking at historical firmographic data within the CRM. Response could be Strong, Moderate, Weak.
Strong
|
| contact_intent_score |
Number
The numerical contact intent score that is tied to a specific contact intent grade. The numerical range is 0-100.
0
|
| contact_grade |
String
A measure of how engaged a person is with your first-party sales and marketing tactics, including any known activity of this type from the MAP or CRM (such as clicking on a website, responding to sales or marketing emails, attending events, and attending webinars). Response could be A, B, C, D.
D
|
| contact_profile_score |
String
The numerical contact profile fit score that is tied to a specific contact profile fit. The numerical range is 0-100.
51
|
| contact_profile_fit |
String
Contact profile fit identifies the fit of a person based on the historical CRM data of who you’ve sold to in the past. Response could be Strong, Moderate, Weak.
Moderate
|
| Segments |
Segments published within the 6sense ABM platform will be available in the API response. Segments Name will be available only if enabled in API Settings. To control these settings within the 6sense platform review the instructions here.
Below are sample values for these parameters.
|
| ids |
Array
Id for single or multiple segments
12121 or 456456, 119900, 226688,
|
| names |
Array
This gives out the Segment Name. Visibility of Segment Name can be controlled in API Settings. To control these settings within the 6sense platform review the instructions here.
“Web Visitors Last 30 days”, “second”, “third”
|
| list |
Array
Combined response for Segment ID and Name. Visibility of Segment Name can be controlled in API Settings. To control these settings within the 6sense platform review the instructions here.
"name": "Web Visitors Last 30 days",
"id": 123123 |
Response Codes
| Code | Definition |
|---|---|
200 |
OK Successfully returned response against an email address |
404 |
Not found Invalid email ID. Please make sure you have sent a valid email address in email field. |
OTHERS |
Other common HTTP response codes Please see HTTP Response Codes to know more codes. |
In case of invalid email Address, you will get blank data for each of these above mentioned variables.If a field is not present, then we’ll return an empty list or null value for that field.
Lead Scoring API
The Lead Scoring API allows customers to update people (or lead or contact) with 6sense Predictive Scores. The API matches based on the input email address and returns account and person-level scores by product category. Customers need the 6sense Advanced Package to have access to this API.
API Token for this API is auto-generated. If you want to create or delete these API tokens, please reach out to support. Read more
Please review the Version Information before using this API.
HTTP Request
Endpoint
POSThttps://scribe.6sense.com/v2/people/score
Headers
| Header | Value |
|---|---|
| Authorization | Token <api_token> |
| Content-Type | application/x-www-form-urlencoded |
Input Params
Sample Request
curl --location --request POST 'https://scribe.6sense.com/v2/people/score' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cache-Control: no-cache' \
--header 'Authorization: Token {your_api_token}' \
--data-urlencode 'email=<user_name>@<domain>.com' \
--data-urlencode 'country=<country_value>' \
--data-urlencode 'company=<company_value>' \
--data-urlencode 'website=<website_value>' \
--data-urlencode 'title=<title_value>' \
--data-urlencode 'leadsource=<leadsource_value>' \
--data-urlencode 'firstname=<firstname_value>' \
--data-urlencode 'lastname=<lastname_value>' \
--data-urlencode 'role=<role_value>' \
--data-urlencode 'industry=<industry_value>'
var data = "email=<user_name>@<domain>.com &
country = < country_value >
&
company = < company_value >
&
website = < website_value >
&
title = < title_value >
&
leadsource = < leadsource_value >
&
firstname = < firstname_value >
&
lastname = < lastname_value >
&
role = < role_value >
&
industry = < industry_value > ";
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://scribe.6sense.com/v2/people/score");
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("Cache-Control", "no-cache");
xhr.setRequestHeader("Authorization", "Token {your_api_token}");
xhr.send(data);
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://scribe.6sense.com/v2/people/score',
'headers': {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
},
form: {
'email': '<user_name>@<domain>.com\n',
'country': '<country_value>',
'company': '<company_value>',
'website': '<website_value>',
'title': '<title_value>',
'leadsource': '<leadsource_value>',
'firstname': '<firstname_value>',
'lastname': '<lastname_value>',
'role': '<role_value>',
'industry': '<industry_value>'
}
};
request(options, function(error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "https://scribe.6sense.com/v2/people/score"
payload=’email=<user_name>@<domain>.com
&country=<country_value>
&company=<company_value>
&website=<website_value>
&title=<title_value>
&leadsource=<leadsource_value>
&firstname=<firstname_value>
&lastname=<lastname_value>
&role=<role_value>
&industry=<industry_value>’
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
{
"info": {
"name": "sample_scribe",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "https://scribe.6sense.com/v2/people/score",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
},
{
"key": "Cache-Control",
"value": "no-cache",
"type": "text"
},
{
"key": "Authorization",
"value": "Token {your_api_token}",
"type": "text"
},
{
"key": "X-Forwarded-For",
"value": "1.0.185.47",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "email",
"value": "<user_name>@<domain>.com\n",
"type": "text"
},
{
"key": "country",
"value": "<country_value>",
"type": "text"
},
{
"key": "company",
"value": "<company_value>",
"type": "text"
},
{
"key": "website",
"value": "<website_value>",
"type": "text"
},
{
"key": "title",
"value": "<title_value>",
"type": "text"
},
{
"key": "leadsource",
"value": "<leadsource_value>",
"type": "text"
},
{
"key": "firstname",
"value": "<firstname_value>",
"type": "text"
},
{
"key": "lastname",
"value": "<lastname_value>",
"type": "text"
},
{
"key": "role",
"value": "<role_value>",
"type": "text"
},
{
"key": "industry",
"value": "<industry_value>",
"type": "text"
}
]
},
"url": {
"raw": "https://scribe.6sense.com/v2/people/score",
"protocol": "https",
"host": [
"scribe",
"6sense",
"com"
],
"path": [
"v2",
"people",
"score"
],
"query": [
{
"key": "country",
"value": "",
"disabled": true
}
]
}
},
"response": []
}
]
}
| Parameters | |
|---|---|
|
Stringrequired
A Valid Email address for which you are requesting details.
xyz@acme.com
|
|
| country |
Stringrequired
Base country of the company/account
US
|
| website |
Stringoptional
Website of the company/account
acme.com
|
| company |
Stringoptional
Name of the company/account
Dell
|
| title |
Stringoptional
Designation of the Lead
Procurement Manager
|
| leadsource |
Stringoptional
Source of the lead as per your database
Website form
|
| firstname |
Stringoptional
First name of the Lead
ABC
|
| lastname |
Stringoptional
Last name of the Lead
XYZ
|
| role |
Stringoptional
Role of the Lead
Procurement Manager
|
| industry |
Stringoptional
Industry of the company
Software and Technology
|
Response Data
Sample Response
{
"scores": [
{
"product": "6sense",
"company_intent_score": 0,
"company_buying_stage": "Target",
"company_profile_score": 81,
"company_profile_fit": "Strong",
"contact_intent_score": 0,
"contact_grade": "D",
"contact_profile_score": 58,
"contact_profile_fit": "Moderate"
}
]
}
Predictive scores will be returned at the product level. If you have multiple product model, they API will return scores for each product category. To receive score information in the API you will need to enable this feature in the API Settings & Configurations.
For more details on scoring and how scores are determined, please visit the 6sense Knowledge Base in Rev City.
| Parameters | |
|---|---|
| product |
String
The name of the specific predictive model when a customer has more than one model. The product category values are the model names.
ace
|
| company_intent_score |
Number
The numerical intent score that is tied to a specific buying stage. The numerical range is 0-100.
81
|
| company_buying_stage |
String
A 6sense AI-derived in-market prediction of the likelihood to open an opportunity in the next 90 days for a particular product category. Response could be Purchase, Decision, Consideration, Awareness, Target.
Purchase
|
| company_profile_score |
Number
The numerical profile fit score that is tied to a specific profile fit. The numerical range is 0-100.
73
|
| company_profile_fit |
String
Profile fit identifies accounts based on ideal customer profile (ICP) by looking at historical firmographic data within the CRM. Response could be Strong, Moderate, Weak.
Strong
|
| contact_intent_score |
Number
The numerical contact intent score that is tied to a specific contact intent grade. The numerical range is 0-100.
0
|
| contact_grade |
String
A measure of how engaged a person is with your first-party sales and marketing tactics, including any known activity of this type from the MAP or CRM (such as clicking on a website, responding to sales or marketing emails, attending events, and attending webinars). Response could be A, B, C, D.
D
|
| contact_profile_score |
Number
The numerical contact profile fit score that is tied to a specific contact profile fit. The numerical range is 0-100.
51
|
| contact_profile_fit |
String
Contact profile fit identifies the fit of a person based on the historical CRM data of who you’ve sold to in the past. Response could be Strong, Moderate, Weak.
Moderate
|
Response Codes
| Code | Definition |
|---|---|
200 |
OK Successfully returned response against an email address |
404 |
Not found Invalid email ID. Please make sure you have sent a valid email address in email field. |
OTHERS |
Other common HTTP response codes Please see HTTP Response Codes to know more codes. |
In case of invalid email Address, you will get blank data for each of these above mentioned variables. If a field is not present, then we’ll return an empty list or null value for that field.
People Enrichment API
Enrich people (or lead or contact) level data using 6sense People Enrichment API directly in your rev-tech platforms (e.g.: CRM, MAP, BI, etc.). Customers need 6sense Platform or Sales Intelligence package to access this API.
You would need Enrichment APIs Credit to access this API. If you want to create or delete these API tokens, please reach out to support. Read more
HTTP Request
Endpoint
POSThttps://api.6sense.com/v1/enrichment/people
Headers
| Header | Value |
|---|---|
| Authorization | Token <api_token> |
| Content-Type | application/x-www-form-urlencoded |
Input Params
Following inputs are accepted as query parameters for the request
Sample Request
curl --location --request POST https://api.6sense.com/v1/enrichment/people\
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cache-Control: no-cache' \
--header 'Authorization: Token {your_api_key}' \
--data-urlencode 'email=<user_name>@<domain>.com' \
OR
curl --location --request POST https://api.6sense.com/v1/enrichment/people\
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cache-Control: no-cache' \
--header 'Authorization: Token {your_api_key}' \
--data-urlencode 'linkedinUrl={your input value}' \
OR
curl --location --request POST https://api.6sense.com/v1/enrichment/people\
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cache-Control: no-cache' \
--header 'Authorization: Token {your_api_key}' \
--data-urlencode 'peopleId={your input value}' \
var data = "email=<user_name>@<domain>.com
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.6sense.com/v1/enrichment/people");
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("Cache-Control", "no-cache");
xhr.setRequestHeader("Authorization", "Token {your_api_token}");
xhr.send(data);
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://api.6sense.com/v1/enrichment/people',
'headers': {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
},
form: {
'email': '<user_name>@<domain>.com',
}
};
request(options, function(error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "https://api.6sense.com/v1/enrichment/people"
payload=’email=<user_name>@<domain>.com’
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
{
"item": [
{
"name": "https://api.6sense.com/v1/enrichment/people",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
},
{
"key": "Cache-Control",
"value": "no-cache",
"type": "text"
},
{
"key": "Authorization",
"value": "Token {your_api_token}",
"type": "text"
},
{
"key": "X-Forwarded-For",
"value": "1.0.185.47",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "email",
"value": "<user_name>@<domain>.com",
"type": "text"
},
]
}
"url": "https://api.6sense.com/v1/enrichment/people"
},
"response": []
}
]
}
| Parameters | |
|---|---|
|
Stringrequired (only if linkedinUrl or peopleId is empty)
A Valid Email address for which you are requesting details.
naveen.titare@6sense.com
|
|
| or linkedinUrl |
Stringrequired (only if email or peopleId is empty)
A Valid LinkedIn Url of a contact for which you are requesting details.
https://www.linkedin.com/in/naveentitare
|
| or peopleId |
Stringrequired (only if email or linkedinUrl is empty)
6sense People id of the Contact for which you are requesting details. These IDs are returned in People Search API.
hlud-asdsad-asd9as7-28323
|
Response Data
Sample Response
{
"person": {
"id": "d121d17f-fc27-4edc-9d19-ce83137c8213",
"email": "abc.xyze@6sense.com",
"emailConfidence": "A+",
"fullName": "ABC XYZ",
"firstName": "ABC",
"lastName": "XYZ",
"title": "senior product manager",
"function": "Product Management",
"level": "Senior",
"division": "Product Management",
"education": [],
"skills": [
"Seo",
"Digital Marketing",
"Marketing Strategy",
"Product Management",
"Project Management",
"Html",
"Product Requirements",
"B2B Software",
"It Strategy",
"Strategy",
"Business Development",
"Business Strategy",
"Consulting"
],
"city": "Pune",
"state": "Maharashtra",
"country": "India",
"postalCode": "",
"phone": "",
"workPhone": "",
"linkedinUrl": "https://www.linkedin.com/in/naveentitare/",
"twitterUrl": "",
"facebookUrl": "https://www.facebook.com/naveen.titare"
},
"company": {
"domain": "6sense.com",
"name": "6sense",
"region": "Southern Asia",
"country": "India",
"state": "Maharashtra"
}
}
| Parameters | |
|---|---|
| Person |
Below are the data points that are available in the API response.
Below are some example of data points that are available in the API response.
|
| id |
String
6sense People id of the Contact
1111-1111-1111-11
|
|
String
Corporate Email address of the Contact
hello@acme.com
|
|
| emailConfidence |
String
Confidence level of email field A+ means High Confidence A means Medium and B means Low confidence
A
|
| fullName |
String
Full Name of the Contact
Road Runner
|
| firstName |
String
First Name of the Contact
Road
|
| lastName |
String
Last Name of the Contact
Runner
|
| education |
String
Education details of the Contact. Variables with empty values are not returned in education. { "startDate": 2021, "endDate": 2008, "schoolLocation": "Indore, Madhya Pradesh, India", "schoolWebsite": "iimidr.ac.in", "schoolName": "Indian Institute Of Management", "degrees": [ "Master Of Business Administration", "Masters" ], }
|
| skills |
String
Professional skills of the Contact { "Business Strategy", "Portfolio Management", "Financial Modelling", "Management", "Banking", }
|
| city |
String
City of the Postal Address
Los Angeles
|
| state |
String
State of the Postal Address
California
|
| country |
String
Country of the Postal Address
US
|
| postalCode |
String
Postal code of the Postal Address
12345
|
| function |
String
Function of the Contact in the organization
Product Management
|
| level |
String
Role/level of the Contact
Sr. Product Manager
|
| division |
String
Division of the Contact
General
|
| title |
String
Job Title of the Contact
Founder
|
| linkedinUrl |
String
LinkedIn profile link of the Contact
link
|
| twitterUrl |
String
Twitter profile link of the Contact
link
|
| facebookUrl |
String
Facebook profile link of the Contact
link
|
| phone |
String
Phone number of the Contact
(415) 212-9225
|
| workPhone |
String
Work phone number of the Contact
(415) 212-9225
|
| Firmographic Variables |
Below are the list of firmographics variables that will be available in the API response.
Below are the list of firmographics variables that will be available in the API response.
|
| name |
String
Name of the company
6sense
|
| domain |
String
Website of the company
6sense.com
|
| region |
String
Office region
North America
|
| country |
String
Office country
United States
|
| state |
String
State
California
|
Response Codes
| Code | Definition |
|---|---|
200 |
OK Successfully returned response against the given input parameter (email or linkedinUrl or peopleId) |
204 |
No Match Found There are no records available for this request. |
OTHERS |
Other common HTTP response codes Please see HTTP Response Codes to know more codes. |
People Search API
Easily search for people (or contacts or Leads) in an organisation to find the right one. People Search API delivers the list of profiles matching an account for a given domain. You can narrow down your search using filters like locations, Industries & job titles. This API returns whether or not 6sense has contact information details like Email, Phone, Mobile Number.
To get actual contact details of the people using peopleID, use People Enrichment API. To access people search API, customers need access to People Enrichment API. API token of People Enrichment API works on People Search API.
HTTP Request
Endpoint
POSThttps://api.6sense.com/v1/search/people
Headers
| Header | Value |
|---|---|
| Authorization | Token <api_token> |
| Content-Type | application/json |
Input Params
Following inputs are accepted as query parameters for the request
Sample Request
curl --location --request POST 'https://api.6sense.com/v1/search/people' \
--header 'accept: application/json' \
--header 'Authorization: Token {your-token-here}' \
--header 'Content-Type: application/json' \
--data-raw '{
"domain": "6sense.com",
"industry": "Software",
"city": [ "Austin", "Bangalore", "pune" ],
"state": [ "karnataka", "England", "maharashtra" ],
"titles": [ "abx manager", "senior product manager" ]
}
var data = JSON.stringify({
"domain": "6sense.com",
"industry": "Software",
"city": [ "Austin", "Bangalore", "pune" ],
"state": [ "karnataka", "England", "maharashtra" ],
"titles": [ "abx manager", "senior product manager" ]
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.6sense.com/v1/search/people");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("Authorization", "Token {your-token-here}");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://api.6sense.com/v1/search/people',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Token {your_api_token}'
},
form: {
"domain": "6sense.com",
"industry": "Software",
"city": [ "Austin", "Bangalore", "pune" ],
"state": [ "karnataka", "England", "maharashtra" ],
"titles": [ "abx manager", "senior product manager" ]
}
};
request(options, function(error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "https://api.6sense.com/v1/search/people"
payload=’domain=6sense.com&
industry="Software"&
city="[ "Austin", "Bangalore", "pune" ]&
state=[ "karnataka", "England", "maharashtra" ]&
titles=[ "abx manager", "senior product manager" ]’
headers = {
'Content-Type': 'application/json',
'Authorization': 'Token {your_api_token}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
{
"item": [
{
"name": "https://api.6sense.com/v1/search/people",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
},
{
"key": "Authorization",
"value": "Token {your_api_token}",
"type": "text"
},
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "domain",
"value": "6sense.com",
"type": "text"
},
{
"key": "industry",
"value": "Software",
"type": "text"
},
{
"key": "city",
"value": [ "Austin", "Bangalore", "pune" ],
"type": "list"
},
{
"key": "state",
"value": [ "karnataka", "England", "maharashtra" ],
"type": "list"
},
{
"key": "titles",
"value": [ "abx manager", "senior product manager" ],
"type": "list"
},
]
}
"url": "https://api.6sense.com/v1/search/people"
},
"response": []
}
]
}
| Parameters | |
|---|---|
| domain |
StringRequired
A Valid domain of the account for which you are requesting details.
6sense.com
|
| city |
ArrayOptional
Applicable city list can be found in the People Search Dictionary API for the input domain. Accepts single or multiple values separated by comma and maximum 10 values are accepted. If you don’t pass any filter values then response will include all the city location of the account.
San Francisco, Los Angeles
|
| state |
ArrayOptional
Applicable state list can be found in the People Search Dictionary API for the input domain. Accepts single or multiple values separated by comma and maximum 10 values are accepted. If you don’t pass any filter values then response will include all the state location of the account.
California, Florida
|
| country |
StringOptional
Applicable country list can be found in the People Search Dictionary API for the input domain. Accepts single or multiple values separated by comma and maximum 10 values are accepted. If you don’t pass any filter values then response will include all the country location of the account.
US, Canada
|
| industry |
StringOptional
Applicable Industry list can be found in the People Search Dictionary API for the input domain. Accepts single value only. If you don’t pass any filter values then response will include all the Industries mapped with the account.
Information Technology
|
| titles |
ArrayOptional
List of all Job Titles can be found in the People Search Dictionary API for the input domain. Accepts single or multiple values separated by comma and maximum 10 values are accepted. If you don’t pass any filter values then response will include all the Job titles available for the account.
cxo, manager, vp
|
| pageNo |
IntegerOptional
Valid page number for which you want to get results.
1
|
| pageSize |
IntegerOptional
Use pageSize to limit the number of responses per page. Maximum and default page size is 50 results per page.
50
|
Response Data
Sample Response
{
"domain": "6sense.com",
"city": [ "Bangalore", "Pune" ],
"state": [ "Karnataka", "Maharashtra" ],
"country": [ "India" ],
"titles": [ "senior product manager" ],
"totalRecordCount": 8,
"totalPage": 1,
"pageNumber": 1,
"pageSize": 50,
"data": [
{
"peopleId": "xxx-xxx-xxx-xx-xx",
"hasEmail": true,
"fullName": "A******* S****",
"firstName": "A*******",
"lastName": "S****",
"hasPhone": false,
"city": "Bangalore",
"state": "Karnataka",
"country": "India",
"function": "Product Management",
"division": "Product Management",
"seniorityLevel": "Senior"
}, {
"peopleId": "xxx-xxx-xxx-xx-xx",
"hasEmail": true,
"fullName": "S**** J*****",
"firstName": "S****",
"lastName": "J*****",
"hasPhone": false,
"city": "Pune",
"state": "Maharashtra",
"country": "India",
"function": "Product Management",
"division": "Product Management",
"seniorityLevel": "Senior"
}
]
}
| Parameters | |
|---|---|
| Detail |
Below are the data points that are available in the API response.
Below are some example of data points that are available in the API response.
|
| domain |
String
Domain name of the account, for which you have requested data.
6sense.com
|
| city |
String
List of cities, for which you have requested data. If you have not used any filter values then response will include all the city location of the account.
San Francisco, Los Angeles
|
| state |
String
List of states, for which you have requested data. If you have not used any filter values then response will include all the state location of the office of the account.
California, Florida
|
| country |
String
List of countries, for which you have requested data. If you have not used any filter values then response will include all the country location of the office of the account.
US, Canada
|
| titles |
String
List of titles, for which you have requested data. If you have not used any filter values then response will include all the job titles available for that account.
cxo, manager, vp
|
| totalRecordCount |
Number
Total number of records available for the requested data.
6
|
| totalPage |
Number
Total no. of pages available for the requested data. You can use this range as reference and accordingly use it in pageNumber.
10
|
| pageNumber |
Number
Page no. for which you have requested data.
3
|
| pageSize |
Number
Number of records available per page.
10
|
| peopleId |
String
Unique 6sense ID of a people (or contact or lead). You can use this in People Enrichment API and get contact details.
121212
|
| hasEmail |
Boolean
Whether or not 6sense has people (or contact or lead) information. True represents data is available and False represents data is not available.
true
|
| fullName |
String
Masked Full Name of the people (or contact or lead)
N**** X**
|
| firstName |
String
Masked First Name of the people (or contact or lead)
N****
|
| lastName |
String
Masked Last Name of the people (or contact or lead
X**
|
| hasPhone |
Boolean
Whether or not 6sense has contact information. True represents data is available and False represents data is not available.
true
|
| hasWorkPhone |
Boolean
Whether or not 6sense has contact information. True represents data is available and False represents data is not available.
true
|
| city |
String
City location of the people (or contact or lead)
san francisco
|
| state |
String
State location of the people (or contact or lead)
california
|
| country |
String
Country location of the people (or contact or lead)
United States
|
| function |
String
Function of the people (or contact or lead) in the company
CEO
|
| division |
String
Division in which the people (or contact or lead) works in the company.
General
|
| seniorityLevel |
String
Seniority level of the people (or contact or lead) in the company.
Director
|
Response Codes
| Code | Definition |
|---|---|
200 |
OK Successfully returned response against an account. |
204 |
No Match Found There are no records available for this request. |
OTHERS |
Other common HTTP response codes Please see HTTP Response Codes to know more codes. |
People Search Dictionary API
This Dictionary API is a supporting API for People Search API. This API delivers the list of data that you need to use in input parameters for People Search API. Dictionary API will work with the API token used for People Search API.
HTTP Request
Endpoint
GEThttps://api.6sense.com/v1/dictionary/peopleSearch
Headers
| Header | Value |
|---|---|
| Authorization | Token <api_token> |
Input Params
Following inputs are accepted as query parameters for the request
Sample Request
curl --location --request GET 'https://api.6sense.com/v1/dictionary/peopleSearch?domainName=6sense.com&pageNumber=1&pageSize=999' \
--header 'accept: application/json' \
--header 'Authorization: Token {your-token-here}'
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://api.6sense.com/v1/dictionary/peopleSearch?domainName=6sense.com&pageNumber=1&pageSize=999");
xhr.setRequestHeader("accept", "application/json");
xhr.setRequestHeader("Authorization", "Token cf7f1f732b9c2ee213f338ee281df4a0746262be");
xhr.send();
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://api.6sense.com/v1/dictionary/peopleSearch?domainName=6sense.com&pageNumber=1&pageSize=999',
'headers': {
'Authorization': 'Token {your_api_token}'
}
};
request(options, function(error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "https://api.6sense.com/v1/dictionary/peopleSearch?domainName=6sense.com&pageNumber=1&pageSize=999"
headers = {
'Authorization': 'Token {your_api_token}'
}
response = requests.request("GET", url, headers=headers)
print(response.text)
{
"item": [
{
"name": "https://api.6sense.com/v1/dictionary/peopleSearch?domainName=6sense.com&pageNumber=1&pageSize=999",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Token {your_api_token}",
"type": "text"
},
],
"url": "https://api.6sense.com/v1/dictionary/peopleSearch?domainName=6sense.com&pageNumber=1&pageSize=999"
},
"response": []
}
]
}
| Parameters | |
|---|---|
| domainName |
StringRequired
A Valid domain of the account for which you are requesting details.
6sense.com
|
| pageNumber |
IntegerOptional
Provide the Page number to get that page response.
1
|
| pageSize |
IntegerOptional
Use pageSize to limit the number of responses per page. Maximum and default page size is 1000 results per page.
50
|
Response Data
Sample Response
{
"city": [ "Auckland", "Barcelona", "Kharkiv", "Kolding" ],
"state": [ "Auckland", "Catalonia", "Kharkiv", "South Denmark" ],
"country": [ "Denmark", "Libya", "New Zealand", "Spain", "Ukraine" ],
"titles": [ "account manager", "business development representative smb uk ireland", "customer engineer", "educator", "group lead" ],
"industry": [ "Business Services", "Information Technology", "Internet", "Software" ],
"totalRecordCount": 146975,
"totalPage": 29395,
"pageNumber": 1,
"pageSize": 5
}
| Parameters | |
|---|---|
| Detail |
Below are the data points that are available in the API response.
Below are some example of data points that are available in the API response.
|
| city |
String
All the cities where the account has offices.
San Francisco, Los Angeles
|
| state |
String
All the states where the account has offices.
California, Florida
|
| country |
String
All the countries where the account has offices.
US, Canada
|
| titles |
String
List of all the job titles available for that account.
cxo, manager, vp
|
| totalRecordCount |
Number
Maximum number of records available for city, state, country and titles.
6
|
| totalPage |
Number
Total no. of pages available for the requested data. You can use this range as reference and accordingly use it in pageNumber.
10
|
| pageNumber |
Number
Page no. for which you have requested data.
3
|
| pageSize |
Number
Number of records per page. Maximum and default is 1000. You can also limit the page size between 1-1000
10
|
Response Codes
| Code | Definition |
|---|---|
200 |
OK Successfully returned response against an account. |
204 |
No Match Found There are no records available for this request. |
OTHERS |
Other common HTTP response codes Please see HTTP Response Codes to know more codes. |
FAQs
Please reach out to your Customer Success Manager for additional questions.
Q: What are Firmographics?
A: Firmographics are a collection of descriptive attributes used by B2B organizations to segment their target market and discover their ideal customers. Such data helps categorize companies according to geographic location, industry, customer base, type of organization, technologies used, etc. With this information at hand, you can build a more effective lead generation strategy and improve your marketing and sales campaigns. Know more about Firmographics.
Q: Will these API slow down my page load?
A: Not at all! The API is designed to load asynchronously in the background.
Q: How many API calls are made per visitor in Company Identification API?
A: One API call per visitor browsing your website.
Q: How fast is the response time for the API?
A: Generally, under 150ms depending on location, with under 50ms not uncommon in US. It is production ready, built to scale, and has already been deployed on hundreds of pages without issue.
Q: Do you support both client-side and server-side implementations?
A: Company Identification API is designed for client-side implementation to unlock use cases like real time web visitor de-anonymization, website personalization, etc. where latency is a important. We do not recommend server side implementation of this API. If you have a complex use case, please talk to our team.
For other APIs, we recommend server-side implementations only.
Q: I want to integrate with a solution outside of the 6sense Network. Can 6sense do it?
A: The answer is dependent on the solution and business constraints and sometimes requires development work but is most likely yes. Contact your 6sense Customer Success Manager for more details or an integration request.
Q: I’m on my mobile cellular network, will the API work?
A: Your cellular network will have an IP address that belongs to a cell company (like ATT). The API will most likely identify the mobile visitor as your mobile provider.
Q: I’m at my Company’s HQ, why is the data identifying me as a different company?
A: It’s likely that we are identifying the previous tenant/occupant of your HQ. It’s also likely that you share a block of IPs from another tenant in the building. It’s also likely that your ISP has made a recent change.
Q: What is your match rate?
A: 6sense delivers one of the highest match rates in the industry. The match rate depends on the type of traffic you are seeing. For example: If the website is primarily B2B, software and tech, and US based, it can be as high as 75%. However, we are constantly making improvements to our data to boost the match rate so please don't hesitate to give us feedback.
Q: Why is the data incorrect?
A: 6sense has the best in house data scientists, but we are only as good as our data that we receive. Furthermore, as we get our data from data vendors, we are at the mercy at how quickly the data vendors update them. Our machine learning algorithm is constantly getting better and will self-correct as we see more intent data on the B2B network.
Q: How often does the firmographic data update?
A: 6sense gets its data from data vendors generally monthly or quarterly.
Q: Do you have a static list of values that are populated in the Company Identification API?
A: Yes! See Available Data Values for Key Firmographic Properties. You would need a 6sense account to access this.