LeadIQ Public API Reference
Welcome to the API reference for the LeadIQ Public API.
Quickstart Guide
For a guide covering authentication, error handling and code samples to get started quickly, see the LeadIQ Public API Guide.
Main Features
The API consists of these main queries and mutations:
- Contact Search: find a single person based on identifying information:
- Person name and current (or past) companies.
- LinkedIn profile.
- Work email or personal email.
- And more, see full list here.
- Company Search: find a single company based on name, domain, country, linkedinUrl.
- Advanced Search: find a list of people based on some broad search criterias e.g: job title, seniority, role, company size, location, etc. See ContactFilter and CompanyFilter.
- groupedAdvancedSearch: resulting list of people are grouped into companies and returned.
- flatAdvancedSearch: resulting list of people is returned as is.
- Account: view your account details.
- Submit Data Feedback: submit data correction patch.
Contact
Terms of Service
API Endpoints
# GraphQL Endpoint:
https://api.leadiq.com/graphql
Queries
account
Description
The current user's account
Response
Returns an Account
Example
Query
query Account {
account {
plans {
name
product
status
nextBillingPeriod
}
dataHubPlan {
name
product
status
nextBillingPeriod
available
used
visibility {
sku
dataPoints
}
costs {
sku
costs {
dataPoint
cost
}
}
}
universalPlan {
name
product
status
nextBillingPeriod
available
used
visibility {
sku
dataPoints
}
costs {
sku
costs {
dataPoint
cost
}
}
}
}
}
Response
{
"data": {
"account": {
"plans": [Plan],
"dataHubPlan": DataHubPlan,
"universalPlan": UniversalPlan
}
}
}
flatAdvancedSearch
Description
Advanced search for flat response
Response
Returns a PersonSearchResponse!
Arguments
| Name | Description |
|---|---|
input - FlatSearchInput!
|
Example
Query
query FlatAdvancedSearch($input: FlatSearchInput!) {
flatAdvancedSearch(input: $input) {
totalPeople
people {
id
companyId
name
linkedinId
linkedinUrl
title
role
city
state
country
countryCode2
countryCode3
seniority
workEmails
verifiedWorkEmails
verifiedLikelyWorkEmails
workPhones
personalEmails
personalPhones
score
firstName
middleName
lastName
updatedAt
currentPositionStartDate
company {
id
name
industry
description
linkedinId
domain
employeeCount
city
country
countryCode2
countryCode3
state
postalCode
score
companyTechnologies
companyTechnologyCategories
revenueRange {
start
end
description
}
fundingInfo {
fundingRounds
fundingTotalUsd
lastFundingOn
lastFundingType
lastFundingUsd
}
naicsCode {
code
description
}
sicCode {
code
description
}
}
picture
}
}
}
Variables
{"input": FlatSearchInput}
Response
{
"data": {
"flatAdvancedSearch": {
"totalPeople": 1,
"people": [Person]
}
}
}
groupedAdvancedSearch
Description
Advanced search for grouped response
Response
Returns a CompanySearchResponse!
Arguments
| Name | Description |
|---|---|
input - GroupedSearchInput!
|
Example
Query
query GroupedAdvancedSearch($input: GroupedSearchInput!) {
groupedAdvancedSearch(input: $input) {
totalCompanies
companies {
company {
id
name
industry
description
linkedinId
domain
employeeCount
city
country
countryCode2
countryCode3
state
postalCode
score
companyTechnologies
companyTechnologyCategories
revenueRange {
start
end
description
}
fundingInfo {
fundingRounds
fundingTotalUsd
lastFundingOn
lastFundingType
lastFundingUsd
}
naicsCode {
code
description
}
sicCode {
code
description
}
}
people {
id
companyId
name
linkedinId
linkedinUrl
title
role
city
state
country
countryCode2
countryCode3
seniority
workEmails
verifiedWorkEmails
verifiedLikelyWorkEmails
workPhones
personalEmails
personalPhones
score
firstName
middleName
lastName
updatedAt
currentPositionStartDate
company {
id
name
industry
description
linkedinId
domain
employeeCount
city
country
countryCode2
countryCode3
state
postalCode
score
companyTechnologies
companyTechnologyCategories
revenueRange {
...RevenueRangeFragment
}
fundingInfo {
...FundingInfoFragment
}
naicsCode {
...NAICSCodeFragment
}
sicCode {
...SICCodeFragment
}
}
picture
}
totalContactsInCompany
}
}
}
Variables
{"input": GroupedSearchInput}
Response
{
"data": {
"groupedAdvancedSearch": {
"totalCompanies": 1,
"companies": [CompanyWithPeople]
}
}
}
searchCompany
Description
Search for companies based on identifying information: name, domain, country, etc
Response
Returns a CompanySearchResult!
Arguments
| Name | Description |
|---|---|
input - SearchCompanyInput!
|
Example
Query
query SearchCompany($input: SearchCompanyInput!) {
searchCompany(input: $input) {
totalResults
hasMore
results {
source
name
alternativeNames
domain
description
emailDomains
type
phones
country
address
locationInfo {
formattedAddress
street1
street2
city
areaLevel1
country
countryCode2
countryCode3
postalCode
}
logoUrl
linkedinId
linkedinUrl
numberOfEmployees
industry
specialities
fundingInfo {
fundingRounds
fundingTotalUsd
lastFundingOn
lastFundingType
lastFundingUsd
}
technologies {
name
category
parentCategory
attributes
categories
}
revenueRange {
start
end
description
}
sicCode {
code
description
}
secondarySicCodes {
code
description
}
naicsCode {
code
description
}
employeeRange
crunchbaseUrl
facebookUrl
twitterUrl
foundedYear
companyHierarchy {
isUltimate
parent {
id
name
}
ultimateParent {
id
name
}
}
updatedDate
isExcluded
}
}
}
Variables
{"input": SearchCompanyInput}
Response
{
"data": {
"searchCompany": {
"totalResults": 123,
"hasMore": false,
"results": [CompanyInfo]
}
}
}
searchPeople
Description
Search for people based on identifying information: name, company (past & present), social profiles, email, etc
Response
Returns a SearchResult!
Arguments
| Name | Description |
|---|---|
input - SearchPeopleInput!
|
Example
Query
query SearchPeople($input: SearchPeopleInput!) {
searchPeople(input: $input) {
totalResults
hasMore
results {
_id
name {
first
fullName
last
middle
}
currentPositions {
companyId
title
dateRange {
start
end
}
updatedAt
emails {
type
status
updatedAt
value
}
phones {
type
status
verificationStatus
updatedAt
value
}
companyInfo {
source
name
alternativeNames
domain
description
emailDomains
type
phones
country
address
locationInfo {
...LocationInfoFragment
}
logoUrl
linkedinId
linkedinUrl
numberOfEmployees
industry
specialities
fundingInfo {
...FundingInfoFragment
}
technologies {
...TechnologyInfoFragment
}
revenueRange {
...RevenueRangeFragment
}
sicCode {
...SICCodeFragment
}
secondarySicCodes {
...SICCodeFragment
}
naicsCode {
...NAICSCodeFragment
}
employeeRange
crunchbaseUrl
facebookUrl
twitterUrl
foundedYear
companyHierarchy {
...CompanyHierarchyFragment
}
updatedDate
isExcluded
}
seniority
function
matchedQuery
}
pastPositions {
companyId
title
dateRange {
start
end
}
updatedAt
emails {
type
status
updatedAt
value
}
phones {
type
status
verificationStatus
updatedAt
value
}
companyInfo {
source
name
alternativeNames
domain
description
emailDomains
type
phones
country
address
locationInfo {
...LocationInfoFragment
}
logoUrl
linkedinId
linkedinUrl
numberOfEmployees
industry
specialities
fundingInfo {
...FundingInfoFragment
}
technologies {
...TechnologyInfoFragment
}
revenueRange {
...RevenueRangeFragment
}
sicCode {
...SICCodeFragment
}
secondarySicCodes {
...SICCodeFragment
}
naicsCode {
...NAICSCodeFragment
}
employeeRange
crunchbaseUrl
facebookUrl
twitterUrl
foundedYear
companyHierarchy {
...CompanyHierarchyFragment
}
updatedDate
isExcluded
}
seniority
function
matchedQuery
}
linkedin {
linkedinId
linkedinUrl
salesUrls
type
status
updatedAt
guid
}
profiles {
network
id
username
url
status
updatedAt
}
location {
fullAddress
areaLevel1
city
country
countryCode2
countryCode3
type
status
updatedAt
}
education {
name
type
linkedinUrl
facebookUrl
twitterUrl
linkedinId
website
domain
degrees
majors
grades
dateRange {
start
end
}
activities
description
}
updatedAt
personalEmails {
type
status
updatedAt
value
}
personalPhones {
type
status
verificationStatus
updatedAt
value
}
confidence
}
}
}
Variables
{"input": SearchPeopleInput}
Response
{
"data": {
"searchPeople": {
"totalResults": 987,
"hasMore": false,
"results": [PersonRecord]
}
}
}
workatoToken
Response
Returns a WorkatoTokenResponse!
Arguments
| Name | Description |
|---|---|
orgDomainUrl - String!
|
Example
Query
query WorkatoToken($orgDomainUrl: String!) {
workatoToken(orgDomainUrl: $orgDomainUrl) {
... on WorkatoTokenResponseFailure {
message
}
... on WorkatoTokenResponseSuccess {
token
customerAccountId
apiKey
}
}
}
Variables
{"orgDomainUrl": "abc123"}
Response
{"data": {"workatoToken": WorkatoTokenResponseFailure}}
Mutations
submitPersonFeedback
Description
Submit feedback about a person contact
Response
Returns an ID!
Arguments
| Name | Description |
|---|---|
input - ApiPersonFeedback!
|
Example
Query
mutation SubmitPersonFeedback($input: ApiPersonFeedback!) {
submitPersonFeedback(input: $input)
}
Variables
{"input": ApiPersonFeedback}
Response
{"data": {"submitPersonFeedback": 4}}
Types
Account
Fields
| Field Name | Description |
|---|---|
plans - [Plan!]!
|
Returns the set of subscribed plans, this will include all plans, including trial plans |
dataHubPlan - DataHubPlan
|
Returns the datahub plan if it is present |
universalPlan - UniversalPlan
|
Returns the universal plan if it is present |
Example
{
"plans": [Plan],
"dataHubPlan": DataHubPlan,
"universalPlan": UniversalPlan
}
AdvancedSearchEmailVerificationStatusType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Verified"
ApiPersonFeedback
Fields
| Input Field | Description |
|---|---|
personId - String
|
|
linkedinUrl - String
|
|
linkedinId - String
|
|
name - String
|
|
companyId - String
|
|
companyName - String
|
|
companyDomain - String
|
|
title - String
|
|
value - String!
|
|
status - ContactInfoStatus
|
|
invalidReason - InvalidReason
|
|
type - ContactInfoType
|
|
lastSeen - ZonedDateTime
|
Example
{
"personId": "xyz789",
"linkedinUrl": "xyz789",
"linkedinId": "xyz789",
"name": "abc123",
"companyId": "xyz789",
"companyName": "abc123",
"companyDomain": "abc123",
"title": "abc123",
"value": "abc123",
"status": "Correct",
"invalidReason": "EmailBounceCode513",
"type": "PersonalMobile",
"lastSeen": "2021-10-02T00:00:00.000Z"
}
Boolean
Description
The Boolean scalar type represents true or false.
Company
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String
|
|
industry - String
|
|
description - String
|
|
linkedinId - String
|
|
domain - String
|
|
employeeCount - Int
|
|
city - String
|
|
country - String
|
|
countryCode2 - String
|
|
countryCode3 - String
|
|
state - String
|
|
postalCode - String
|
|
score - Float
|
Not supported anymore |
companyTechnologies - [String!]
|
|
companyTechnologyCategories - [String!]
|
|
revenueRange - RevenueRange
|
|
fundingInfo - FundingInfo
|
|
naicsCode - NAICSCode
|
|
sicCode - SICCode
|
Example
{
"id": "abc123",
"name": "abc123",
"industry": "abc123",
"description": "abc123",
"linkedinId": "xyz789",
"domain": "xyz789",
"employeeCount": 987,
"city": "abc123",
"country": "xyz789",
"countryCode2": "xyz789",
"countryCode3": "abc123",
"state": "xyz789",
"postalCode": "xyz789",
"score": 123.45,
"companyTechnologies": ["xyz789"],
"companyTechnologyCategories": ["xyz789"],
"revenueRange": RevenueRange,
"fundingInfo": FundingInfo,
"naicsCode": NAICSCode,
"sicCode": SICCode
}
CompanyDetails
Fields
| Input Field | Description |
|---|---|
companyId - String
|
|
name - String
|
|
domain - String
|
|
emailDomain - String
|
|
linkedinId - String
|
|
country - String
|
|
searchInPastCompanies - Boolean
|
If set to true, match company against both current and past positions. Defaults to false. |
strict - Boolean
|
If set to true, all input company details must match some existing companies. If the company doesn't exists, maybe due to bad data, the search result will be empty. Defaults to false. |
Example
{
"companyId": "abc123",
"name": "xyz789",
"domain": "xyz789",
"emailDomain": "xyz789",
"linkedinId": "xyz789",
"country": "abc123",
"searchInPastCompanies": true,
"strict": true
}
CompanyFilter
Fields
| Input Field | Description |
|---|---|
ids - [String!]
|
|
names - [String!]
|
|
domains - [String!]
|
|
linkedinIds - [String!]
|
|
industries - [String!]
|
|
sizes - [CompanySizeFilter!]
|
|
locations - [LocationFilterInput!]
|
|
descriptions - [String!]
|
|
technologies - [String!]
|
|
technologyCategories - [String!]
|
|
revenueRanges - [RangeFilter!]
|
|
fundingInfoFilters - [FundingInfoFilter!]
|
|
naicsCodeFilters - [NAICSCodeFilter!]
|
|
sicCodeFilters - [SICCodeFilter!]
|
Example
{
"ids": ["xyz789"],
"names": ["xyz789"],
"domains": ["abc123"],
"linkedinIds": ["xyz789"],
"industries": ["xyz789"],
"sizes": [CompanySizeFilter],
"locations": [LocationFilterInput],
"descriptions": ["abc123"],
"technologies": ["abc123"],
"technologyCategories": ["abc123"],
"revenueRanges": [RangeFilter],
"fundingInfoFilters": [FundingInfoFilter],
"naicsCodeFilters": [NAICSCodeFilter],
"sicCodeFilters": [SICCodeFilter]
}
CompanyHierarchy
Fields
| Field Name | Description |
|---|---|
isUltimate - Boolean!
|
|
parent - CompanyHierarchyNode
|
|
ultimateParent - CompanyHierarchyNode
|
Example
{
"isUltimate": true,
"parent": CompanyHierarchyNode,
"ultimateParent": CompanyHierarchyNode
}
CompanyHierarchyNode
CompanyInfo
Fields
| Field Name | Description |
|---|---|
source - String!
|
Company Id |
name - String!
|
|
alternativeNames - [String!]
|
|
domain - String
|
|
description - String
|
|
emailDomains - [String!]
|
|
type - String
|
|
phones - [String!]
|
|
country - String
|
Use locationInfo instead |
address - String
|
|
locationInfo - LocationInfo
|
|
logoUrl - String
|
|
linkedinId - String
|
|
linkedinUrl - String
|
|
numberOfEmployees - Int
|
|
industry - String
|
|
specialities - [String!]
|
|
fundingInfo - FundingInfo
|
|
technologies - [TechnologyInfo!]
|
|
revenueRange - RevenueRange
|
|
sicCode - SICCode
|
|
secondarySicCodes - [SICCode!]
|
|
naicsCode - NAICSCode
|
|
employeeRange - String
|
|
crunchbaseUrl - String
|
|
facebookUrl - String
|
|
twitterUrl - String
|
|
foundedYear - Int
|
|
companyHierarchy - CompanyHierarchy
|
|
updatedDate - ZonedDateTime
|
|
isExcluded - Boolean
|
Example
{
"source": "abc123",
"name": "abc123",
"alternativeNames": ["abc123"],
"domain": "abc123",
"description": "abc123",
"emailDomains": ["xyz789"],
"type": "xyz789",
"phones": ["abc123"],
"country": "abc123",
"address": "xyz789",
"locationInfo": LocationInfo,
"logoUrl": "abc123",
"linkedinId": "xyz789",
"linkedinUrl": "abc123",
"numberOfEmployees": 123,
"industry": "abc123",
"specialities": ["xyz789"],
"fundingInfo": FundingInfo,
"technologies": [TechnologyInfo],
"revenueRange": RevenueRange,
"sicCode": SICCode,
"secondarySicCodes": [SICCode],
"naicsCode": NAICSCode,
"employeeRange": "xyz789",
"crunchbaseUrl": "xyz789",
"facebookUrl": "abc123",
"twitterUrl": "xyz789",
"foundedYear": 123,
"companyHierarchy": CompanyHierarchy,
"updatedDate": "2021-10-02T00:00:00.000Z",
"isExcluded": false
}
CompanySearchResponse
Fields
| Field Name | Description |
|---|---|
totalCompanies - Long!
|
|
companies - [CompanyWithPeople!]!
|
Example
{"totalCompanies": 1, "companies": [CompanyWithPeople]}
CompanySearchResult
Fields
| Field Name | Description |
|---|---|
totalResults - Int!
|
|
hasMore - Boolean!
|
|
results - [CompanyInfo!]!
|
Example
{
"totalResults": 123,
"hasMore": true,
"results": [CompanyInfo]
}
CompanySizeFilter
CompanySortingOption
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"IdDesc"
CompanyWithPeople
Fields
| Field Name | Description |
|---|---|
company - Company!
|
|
people - [Person!]!
|
|
totalContactsInCompany - Long!
|
Example
{
"company": Company,
"people": [Person],
"totalContactsInCompany": 1
}
ConfigurableDataPoint
Values
| Enum Value | Description |
|---|---|
|
|
Represents all datapoints of a company. |
|
|
Represents a unified Person datapoint. Will only be present if PersonEmail and PersonPhone are not. |
|
|
Represents an email datapoint of a person. Will only be present if Person is not. |
|
|
Represents a phone datapoint of a person. Will only be present if Person is not. |
Example
"Company"
ContactFilter
Fields
| Input Field | Description |
|---|---|
ids - [String!]
|
|
names - [String!]
|
|
titles - [String!]
|
|
linkedinIds - [String!]
|
|
linkedinUrls - [String!]
|
|
seniorities - [Seniority!]
|
|
roles - [String!]
|
|
locations - [LocationFilterInput!]
|
|
containsWorkEmails - [AdvancedSearchEmailVerificationStatusType!]
|
|
updatedAt - DateRangeFilter
|
|
newHireFrom - Long
|
|
newPromotionFrom - Long
|
Example
{
"ids": ["abc123"],
"names": ["abc123"],
"titles": ["abc123"],
"linkedinIds": ["abc123"],
"linkedinUrls": ["xyz789"],
"seniorities": ["VP"],
"roles": ["xyz789"],
"locations": [LocationFilterInput],
"containsWorkEmails": ["Verified"],
"updatedAt": DateRangeFilter,
"newHireFrom": 1,
"newPromotionFrom": 1
}
ContactInfoStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Correct"
ContactInfoType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PersonalMobile"
ContactSortingOption
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"RoleAsc"
DataHubCost
Fields
| Field Name | Description |
|---|---|
sku - SKU!
|
The subproduct that this cost is associated with |
costs - [DataPointCost!]!
|
A list of dataPoint to cost mappings |
Example
{"sku": "AccountTracking", "costs": [DataPointCost]}
DataHubPlan
Fields
| Field Name | Description |
|---|---|
name - String!
|
A human readable name for the plan. e.g. Enterprise Annual |
product - ProductName!
|
The product that this plan is for |
status - PlanStatus!
|
The current status of the plan |
nextBillingPeriod - ZonedDateTime
|
|
available - Int!
|
The number of credits available for use |
used - Int!
|
The number of credits used during the current billing period |
visibility - [DataHubVisibility!]!
|
The visibility of datapoints for this plan |
costs - [DataHubCost!]!
|
The costs per datapoint associated with this plan |
Example
{
"name": "abc123",
"product": "DataHub",
"status": "Active",
"nextBillingPeriod": "2021-10-02T00:00:00.000Z",
"available": 123,
"used": 123,
"visibility": [DataHubVisibility],
"costs": [DataHubCost]
}
DataHubVisibility
Fields
| Field Name | Description |
|---|---|
sku - SKU!
|
The subproduct that this visibility is associated with |
dataPoints - [UnlockableDataPoint!]!
|
A list of dataPoints that are visible |
Example
{"sku": "AccountTracking", "dataPoints": ["Company"]}
DataPointCost
Fields
| Field Name | Description |
|---|---|
dataPoint - ConfigurableDataPoint!
|
The datapoint that this cost is associated with |
cost - Int!
|
The cost of the datapoint |
Example
{"dataPoint": "Company", "cost": 123}
DateRange
Fields
| Field Name | Description |
|---|---|
start - ZonedDateTime
|
|
end - ZonedDateTime
|
Example
{
"start": "2021-10-02T00:00:00.000Z",
"end": "2021-10-02T00:00:00.000Z"
}
DateRangeFilter
EducationRecord
Example
{
"name": "xyz789",
"type": "xyz789",
"linkedinUrl": "abc123",
"facebookUrl": "abc123",
"twitterUrl": "xyz789",
"linkedinId": "abc123",
"website": "xyz789",
"domain": "abc123",
"degrees": ["abc123"],
"majors": ["xyz789"],
"grades": "abc123",
"dateRange": DateRange,
"activities": "xyz789",
"description": "abc123"
}
EmailType
Description
Type of email
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"WorkEmail"
EmailVerificationStatusType
Description
Status of an email
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Verified"
EmailVerificationStatusTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Verified"
FlatSearchInput
Fields
| Input Field | Description |
|---|---|
companyFilter - CompanyFilter
|
|
companyExcludedFilter - CompanyFilter
|
|
contactFilter - ContactFilter
|
|
contactExcludedFilter - ContactFilter
|
|
skip - Int
|
|
limit - Int
|
|
sortContactsBy - [ContactSortingOption!]
|
Example
{
"companyFilter": CompanyFilter,
"companyExcludedFilter": CompanyFilter,
"contactFilter": ContactFilter,
"contactExcludedFilter": ContactFilter,
"skip": 123,
"limit": 987,
"sortContactsBy": ["RoleAsc"]
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
FundingInfo
Fields
| Field Name | Description |
|---|---|
fundingRounds - String
|
|
fundingTotalUsd - Long
|
|
lastFundingOn - ZonedDateTime
|
|
lastFundingType - String
|
|
lastFundingUsd - Long
|
Example
{
"fundingRounds": "2",
"fundingTotalUsd": 40000000,
"lastFundingOn": "2021-10-02T00:00:00.000Z",
"lastFundingType": "Series B",
"lastFundingUsd": 30000000
}
FundingInfoFilter
Fields
| Input Field | Description |
|---|---|
lastFundingDateRange - DateRangeFilter
|
|
lastFundingRange - RangeFilter
|
Example
{
"lastFundingDateRange": DateRangeFilter,
"lastFundingRange": RangeFilter
}
GenericFieldStatus
Description
A generic field status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Valid"
GenericFieldType
Description
A generic field type
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NotApplicable"
GroupedSearchInput
Description
Input for Advanced Search for grouped response
Fields
| Input Field | Description |
|---|---|
companyFilter - CompanyFilter
|
|
companyExcludedFilter - CompanyFilter
|
|
contactFilter - ContactFilter
|
|
contactExcludedFilter - ContactFilter
|
|
skip - Int
|
|
limit - Int
|
|
limitPerCompany - Int
|
|
sortCompaniesBy - [CompanySortingOption!]
|
|
sortContactsBy - [ContactSortingOption!]
|
Example
{
"companyFilter": CompanyFilter,
"companyExcludedFilter": CompanyFilter,
"contactFilter": ContactFilter,
"contactExcludedFilter": ContactFilter,
"skip": 123,
"limit": 123,
"limitPerCompany": 987,
"sortCompaniesBy": ["IdDesc"],
"sortContactsBy": ["RoleAsc"]
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
InvalidReason
Values
| Enum Value | Description |
|---|---|
|
|
5.1.3 Bad destination mailbox address syntax |
|
|
5.5.4 Invalid command arguments |
|
|
5.0.0 Other undefined Status |
|
|
5.4.7 Delivery time expired |
|
|
5.3.2 System not accepting network messages |
|
|
5.6.4 Conversion with loss performed |
|
|
5.2.4 Mailing list expansion problem |
|
|
5.6.3 Conversion required but not supported |
|
|
5.2.2 Mailbox full |
|
|
5.5.5 Wrong protocol version |
|
|
5.5.2 Syntax error |
|
|
5.7.0 Other or undefined security status |
|
|
5.1.5 Destination mailbox address valid |
|
|
Email or Phone belongs to someone else |
|
|
5.6.5 Conversion failed |
|
|
5.4.4 Unable to route |
|
|
5.1.2 Bad destination system address |
|
|
5.1.6 Mailbox has moved |
|
|
5.7.5 Cryptographic failure |
|
|
|
|
|
5.6.1 Media not supported |
|
|
5.7.3 Security conversion required but not possible |
|
|
5.1.0 Another address status |
|
|
5.7.7 Message integrity failure |
|
|
5.5.1 Invalid command |
|
|
5.4.3 Routing server failure |
|
|
5.3.0 Other or undefined mail system status |
|
|
5.2.3 Message length exceeds administrative limit |
|
|
5.4.1 No answer from host |
|
|
5.3.3 System not capable of selected features |
|
|
5.4.5 Network congestion |
|
|
5.6.2 Conversion required and prohibited |
|
|
5.7.1 Delivery not authorized, message refused |
|
|
5.1.4 Destination mailbox address ambiguous |
|
|
5.7.2 Mailing list expansion prohibited |
|
|
5.4.2 Bad connection |
|
|
5.1.7 Bad sender’s mailbox address syntax |
|
|
5.7.4 Security features not supported |
|
|
5.2.1 Mailbox disabled, not accepting messages |
|
|
5.3.4 Message too big for system |
|
|
5.3.1 Mail system full |
|
|
5.5.3 Too many recipients |
|
|
5.1.8 Bad sender’s system address |
|
|
5.2.0 Other or undefined mailbox status |
|
|
5.1.1 Bad destination mailbox address |
|
|
5.7.6 Cryptographic algorithm not supported |
|
|
5.5.0 Other or undefined protocol status |
|
|
5.4.0 Other or undefined network or routing status |
|
|
5.4.6 Routing loop detected |
|
|
5.6.0 Other or undefined media error |
Example
"EmailBounceCode513"
LinkedinRecord
Fields
| Field Name | Description |
|---|---|
linkedinId - String
|
|
linkedinUrl - String
|
|
salesUrls - [String!]
|
|
type - GenericFieldType!
|
|
status - GenericFieldStatus!
|
|
updatedAt - ZonedDateTime!
|
|
guid - String
|
Example
{
"linkedinId": "xyz789",
"linkedinUrl": "abc123",
"salesUrls": ["abc123"],
"type": "NotApplicable",
"status": "Valid",
"updatedAt": "2021-10-02T00:00:00.000Z",
"guid": "xyz789"
}
LocationFilterInput
LocationInfo
Example
{
"formattedAddress": "xyz789",
"street1": "abc123",
"street2": "xyz789",
"city": "abc123",
"areaLevel1": "abc123",
"country": "abc123",
"countryCode2": "xyz789",
"countryCode3": "xyz789",
"postalCode": "abc123"
}
LocationRecord
Fields
| Field Name | Description |
|---|---|
fullAddress - String
|
|
areaLevel1 - String
|
|
city - String
|
|
country - String
|
|
countryCode2 - String
|
|
countryCode3 - String
|
|
type - GenericFieldType!
|
|
status - GenericFieldStatus!
|
|
updatedAt - ZonedDateTime!
|
Example
{
"fullAddress": "xyz789",
"areaLevel1": "xyz789",
"city": "xyz789",
"country": "xyz789",
"countryCode2": "xyz789",
"countryCode3": "abc123",
"type": "NotApplicable",
"status": "Valid",
"updatedAt": "2021-10-02T00:00:00.000Z"
}
Long
Description
The Long scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1.
Example
1
NAICSCode
NAICSCodeFilter
NameInfo
Person
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
companyId - String!
|
|
name - String
|
|
linkedinId - String
|
|
linkedinUrl - String
|
|
title - String
|
|
role - String
|
|
city - String
|
|
state - String
|
|
country - String
|
|
countryCode2 - String
|
|
countryCode3 - String
|
|
seniority - String
|
|
workEmails - [String!]
|
|
verifiedWorkEmails - [String!]
|
|
verifiedLikelyWorkEmails - [String!]
|
|
workPhones - [String!]
|
|
personalEmails - [String!]
|
|
personalPhones - [String!]
|
|
score - Float
|
Not supported anymore |
firstName - String
|
|
middleName - String
|
|
lastName - String
|
|
updatedAt - ZonedDateTime
|
|
currentPositionStartDate - ZonedDateTime
|
|
company - Company
|
|
picture - String
|
Example
{
"id": "abc123",
"companyId": "abc123",
"name": "xyz789",
"linkedinId": "xyz789",
"linkedinUrl": "abc123",
"title": "xyz789",
"role": "xyz789",
"city": "xyz789",
"state": "xyz789",
"country": "xyz789",
"countryCode2": "abc123",
"countryCode3": "abc123",
"seniority": "xyz789",
"workEmails": ["abc123"],
"verifiedWorkEmails": ["xyz789"],
"verifiedLikelyWorkEmails": ["abc123"],
"workPhones": ["xyz789"],
"personalEmails": ["abc123"],
"personalPhones": ["abc123"],
"score": 123.45,
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "abc123",
"updatedAt": "2021-10-02T00:00:00.000Z",
"currentPositionStartDate": "2021-10-02T00:00:00.000Z",
"company": Company,
"picture": "xyz789"
}
PersonRecord
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
name - NameInfo!
|
|
currentPositions - [PositionRecord!]!
|
|
pastPositions - [PositionRecord!]!
|
|
linkedin - LinkedinRecord
|
|
profiles - [SocialProfile!]!
|
|
location - LocationRecord
|
|
education - [EducationRecord!]!
|
|
updatedAt - ZonedDateTime
|
|
personalEmails - [PersonalEmailRecordType!]!
|
|
personalPhones - [PersonalPhoneRecordType!]!
|
|
confidence - Int
|
Example
{
"_id": "xyz789",
"name": NameInfo,
"currentPositions": [PositionRecord],
"pastPositions": [PositionRecord],
"linkedin": LinkedinRecord,
"profiles": [SocialProfile],
"location": LocationRecord,
"education": [EducationRecord],
"updatedAt": "2021-10-02T00:00:00.000Z",
"personalEmails": [PersonalEmailRecordType],
"personalPhones": [PersonalPhoneRecordType],
"confidence": 123
}
PersonSearchResponse
Fields
| Field Name | Description |
|---|---|
totalPeople - Long!
|
|
people - [Person!]!
|
Example
{"totalPeople": 1, "people": [Person]}
PersonalEmailRecordType
Fields
| Field Name | Description |
|---|---|
type - EmailType!
|
|
status - EmailVerificationStatusType!
|
|
updatedAt - ZonedDateTime!
|
|
value - String!
|
Example
{
"type": "WorkEmail",
"status": "Verified",
"updatedAt": "2021-10-02T00:00:00.000Z",
"value": "abc123"
}
PersonalPhoneRecordType
Fields
| Field Name | Description |
|---|---|
type - PhoneType!
|
|
status - PhoneVerificationStatusType!
|
|
verificationStatus - VerificationStatusType!
|
|
updatedAt - ZonedDateTime!
|
|
value - String!
|
Example
{
"type": "WorkPhone",
"status": "Verified",
"verificationStatus": "LikelyAccurate",
"updatedAt": "2021-10-02T00:00:00.000Z",
"value": "xyz789"
}
PhoneQualityFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HigherQualityPhones"
PhoneType
Description
Type of phone
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"WorkPhone"
PhoneVerificationStatusType
Description
Status of a phone number
Values
| Enum Value | Description |
|---|---|
|
|
use verificationStatus to know quality of phone |
|
|
use verificationStatus to know quality of phone |
|
|
use verificationStatus to know quality of phone |
|
|
|
|
|
Example
"Verified"
Plan
Fields
| Field Name | Description |
|---|---|
name - String!
|
A human readable name for the plan. e.g. Enterprise Annual |
product - ProductName!
|
The product that this plan is for |
status - PlanStatus!
|
The current status of the plan |
nextBillingPeriod - ZonedDateTime
|
The next billing period for this plan, null if the plan is inactive or will not reactivate |
Example
{
"name": "abc123",
"product": "DataHub",
"status": "Active",
"nextBillingPeriod": "2021-10-02T00:00:00.000Z"
}
PlanStatus
Description
An enum representing the status of a plan.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Active"
PositionRecord
Fields
| Field Name | Description |
|---|---|
companyId - String!
|
|
title - String
|
|
dateRange - DateRange
|
|
updatedAt - ZonedDateTime!
|
|
emails - [WorkEmailRecordType!]!
|
|
phones - [WorkPhoneRecordType!]!
|
|
companyInfo - CompanyInfo
|
|
seniority - String
|
|
function - String
|
|
matchedQuery - Boolean!
|
Example
{
"companyId": "xyz789",
"title": "abc123",
"dateRange": DateRange,
"updatedAt": "2021-10-02T00:00:00.000Z",
"emails": [WorkEmailRecordType],
"phones": [WorkPhoneRecordType],
"companyInfo": CompanyInfo,
"seniority": "xyz789",
"function": "xyz789",
"matchedQuery": true
}
ProductName
Description
A high level product name. This is used to delineate between subscriptions to different products.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DataHub"
ProfileFilterType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"HasVerifiedWorkPhone"
QualityFilter
Fields
| Input Field | Description |
|---|---|
phone - PhoneQualityFilter
|
Example
{"phone": "HigherQualityPhones"}
RangeFilter
RevenueRange
SICCode
SICCodeFilter
SKU
Description
Represents a specific product category. SKUs may have different costs or datapoints associated with them
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AccountTracking"
SearchCompanyInput
Description
Input for searching company
Example
{
"source": "abc123",
"name": "abc123",
"domain": "xyz789",
"linkedinId": "abc123",
"linkedinUrl": "xyz789",
"strict": false
}
SearchPeopleInput
Description
Input for searching people
Fields
| Input Field | Description |
|---|---|
skip - Int
|
|
limit - Int
|
|
id - String
|
|
firstName - String
|
|
lastName - String
|
|
middleName - String
|
|
fullName - String
|
|
company - CompanyDetails
|
|
linkedinId - String
|
|
linkedinUrl - String
|
|
email - String
|
|
hashedEmail - String
|
Search by SHA256 hashed email |
phone - String
|
|
workEmailStatusIn - [EmailVerificationStatusTypeInput!]
|
If set, only return result with email statuses from this list. Default to all statuses. |
containsWorkContactInfo - Boolean
|
If set to true, only return results with work contacts. Default to false. |
profileFilter - [ProfileFilterType!]
|
If set, only return results that satisfy these filters. Default to empty. |
includeInvalid - Boolean
|
If set to true, include Invalid emails in result. Default to false. |
qualityFilter - QualityFilter
|
Apply Quality Filter |
minConfidence - Int
|
Min confidence property (if applicable) for a person (0 - 100) |
Example
{
"skip": 123,
"limit": 123,
"id": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"middleName": "xyz789",
"fullName": "xyz789",
"company": CompanyDetails,
"linkedinId": "xyz789",
"linkedinUrl": "xyz789",
"email": "abc123",
"hashedEmail": "xyz789",
"phone": "abc123",
"workEmailStatusIn": ["Verified"],
"containsWorkContactInfo": true,
"profileFilter": ["HasVerifiedWorkPhone"],
"includeInvalid": true,
"qualityFilter": QualityFilter,
"minConfidence": 987
}
SearchResult
Fields
| Field Name | Description |
|---|---|
totalResults - Int!
|
|
hasMore - Boolean!
|
|
results - [PersonRecord!]!
|
Example
{
"totalResults": 123,
"hasMore": false,
"results": [PersonRecord]
}
Seniority
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"VP"
SocialNetworkType
Description
Network name of the social profile.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Twitter"
SocialProfile
Fields
| Field Name | Description |
|---|---|
network - SocialNetworkType!
|
|
id - String
|
|
username - String
|
|
url - String
|
|
status - GenericFieldStatus!
|
|
updatedAt - ZonedDateTime!
|
Example
{
"network": "Twitter",
"id": "xyz789",
"username": "abc123",
"url": "abc123",
"status": "Valid",
"updatedAt": "2021-10-02T00:00:00.000Z"
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
TechnologyInfo
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
category - String
|
|
parentCategory - String
|
|
attributes - [String!]!
|
|
categories - [String!]!
|
Example
{
"name": "Amazon Web Services (AWS)",
"category": "Infrastructure as a Service (IaaS)",
"parentCategory": "Cloud Services",
"attributes": ["Software as a Service (SaaS)"],
"categories": ["xyz789"]
}
UniversalCost
Fields
| Field Name | Description |
|---|---|
sku - SKU!
|
The subproduct that this cost is associated with |
costs - [DataPointCost!]!
|
A list of dataPoint to cost mappings |
Example
{"sku": "AccountTracking", "costs": [DataPointCost]}
UniversalPlan
Fields
| Field Name | Description |
|---|---|
name - String!
|
A human readable name for the plan. e.g. Enterprise Annual |
product - ProductName!
|
The product that this plan is for |
status - PlanStatus!
|
The current status of the plan |
nextBillingPeriod - ZonedDateTime
|
When the next billing period starts, null if the plan is inactive or will not reactivate |
available - Int!
|
The number of credits available for use |
used - Int!
|
The number of credits used during the current billing period |
visibility - [UniversalVisibility!]!
|
The visibility of datapoints for this plan |
costs - [UniversalCost!]!
|
The costs per datapoint associated with this plan |
Example
{
"name": "abc123",
"product": "DataHub",
"status": "Active",
"nextBillingPeriod": "2021-10-02T00:00:00.000Z",
"available": 987,
"used": 123,
"visibility": [UniversalVisibility],
"costs": [UniversalCost]
}
UniversalVisibility
Fields
| Field Name | Description |
|---|---|
sku - SKU!
|
The subproduct that this visibility is associated with |
dataPoints - [UnlockableDataPoint!]!
|
A list of dataPoints that are visible |
Example
{"sku": "AccountTracking", "dataPoints": ["Company"]}
UnlockableDataPoint
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Company"
VerificationStatusType
Description
Verification status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LikelyAccurate"
WorkEmailRecordType
Fields
| Field Name | Description |
|---|---|
type - EmailType!
|
|
status - EmailVerificationStatusType!
|
|
updatedAt - ZonedDateTime!
|
|
value - String!
|
Example
{
"type": "WorkEmail",
"status": "Verified",
"updatedAt": "2021-10-02T00:00:00.000Z",
"value": "abc123"
}
WorkPhoneRecordType
Fields
| Field Name | Description |
|---|---|
type - PhoneType!
|
|
status - PhoneVerificationStatusType!
|
|
verificationStatus - VerificationStatusType!
|
|
updatedAt - ZonedDateTime!
|
|
value - String!
|
Example
{
"type": "WorkPhone",
"status": "Verified",
"verificationStatus": "LikelyAccurate",
"updatedAt": "2021-10-02T00:00:00.000Z",
"value": "xyz789"
}
WorkatoTokenResponse
Types
| Union Types |
|---|
Example
WorkatoTokenResponseFailure
WorkatoTokenResponseFailure
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "xyz789"}
WorkatoTokenResponseSuccess
ZonedDateTime
Description
Zoned date time type
Example
"2021-10-02T00:00:00.000Z"