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.
- Usage: view API credit usage and limit.
- Submit Data Feedback: submit data correction patch.
Contact
Terms of Service
API Endpoints
# GraphQL Endpoint:
https://api.leadiq.com/graphql
Queries
companyTrackingTask
Description
Get the current status of the company tracking task.
Response
Returns a
CompanyTrackingTask
Example
Query
query CompanyTrackingTask(
$id: ID!,
$uniqueOnly: Boolean
) {
companyTrackingTask(
id: $id,
uniqueOnly: $uniqueOnly
) {
id
jobChanges {
edges {
cursor
node {
id
person {
...PersonDataFragment
}
currentCompany {
...CompanyDataFragment
}
currentPosition {
...PositionFragment
}
jobChangeType
matchedICPIds
duplicateRecordIds
}
}
pageInfo {
total
startCursor
endCursor
hasPreviousPage
hasNextPage
}
}
status
createdAt
monthsBack
jobStartDateFrom
error
isCancelled
}
}
Variables
{"id": 4, "uniqueOnly": false}
Response
{
"data": {
"companyTrackingTask": {
"id": "4",
"jobChanges": JobChangeConnection,
"status": "Failed",
"createdAt": Instant,
"monthsBack": 123,
"jobStartDateFrom": "2020-07-19",
"error": "abc123",
"isCancelled": false
}
}
}
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
state
country
seniority
workEmails
verifiedWorkEmails
verifiedLikelyWorkEmails
workPhones
personalEmails
personalPhones
score
firstName
middleName
lastName
updatedAt
currentPositionStartDate
company {
id
name
industry
description
linkedinId
domain
employeeCount
city
country
state
postalCode
score
companyTechnologies
companyTechnologyCategories
revenueRange {
start
end
description
}
fundingInfo {
fundingRounds
fundingTotalUsd
lastFundingOn
lastFundingType
lastFundingUsd
}
naicsCode {
code
description
}
}
picture
}
}
}
Variables
{"input": FlatSearchInput}
Response
{
"data": {
"flatAdvancedSearch": {
"totalPeople": 100,
"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
state
postalCode
score
companyTechnologies
companyTechnologyCategories
revenueRange {
start
end
description
}
fundingInfo {
fundingRounds
fundingTotalUsd
lastFundingOn
lastFundingType
lastFundingUsd
}
naicsCode {
code
description
}
}
people {
id
companyId
name
linkedinId
linkedinUrl
title
role
state
country
seniority
workEmails
verifiedWorkEmails
verifiedLikelyWorkEmails
workPhones
personalEmails
personalPhones
score
firstName
middleName
lastName
updatedAt
currentPositionStartDate
company {
id
name
industry
description
linkedinId
domain
employeeCount
city
country
state
postalCode
score
companyTechnologies
companyTechnologyCategories
revenueRange {
...RevenueRangeFragment
}
fundingInfo {
...FundingInfoFragment
}
naicsCode {
...NAICSCodeFragment
}
}
picture
}
totalContactsInCompany
}
}
}
Variables
{"input": GroupedSearchInput}
Response
{
"data": {
"groupedAdvancedSearch": {
"totalCompanies": 100,
"companies": [CompanyWithPeople]
}
}
}
regeneratedTime
Description
Last regenerated time
Response
Returns a
RegeneratedTimeResult!
Arguments
Name | Description |
---|---|
input -
RegeneratedTimeInput!
|
Example
Query
query RegeneratedTime($input: RegeneratedTimeInput!) {
regeneratedTime(input: $input) {
time
}
}
Variables
{"input": RegeneratedTimeInput}
Response
{
"data": {
"regeneratedTime": {
"time": "2021-10-02T00:00:00.000Z"
}
}
}
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
postalCode
}
logoUrl
linkedinId
linkedinUrl
numberOfEmployees
industry
specialities
fundingInfo {
fundingRounds
fundingTotalUsd
lastFundingOn
lastFundingType
lastFundingUsd
}
technologies {
name
category
parentCategory
attributes
categories
}
revenue
revenueRange {
start
end
description
}
predictedRevenue {
start
end
description
}
sicCode {
code
description
}
secondarySicCodes {
code
description
}
naicsCode {
code
description
}
employeeRange
crunchbaseUrl
facebookUrl
twitterUrl
foundedYear
updatedDate
}
}
}
Variables
{"input": SearchCompanyInput}
Response
{
"data": {
"searchCompany": {
"totalResults": 987,
"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
}
revenue
revenueRange {
...RevenueRangeFragment
}
predictedRevenue {
...RevenueRangeFragment
}
sicCode {
...SICCodeFragment
}
secondarySicCodes {
...SICCodeFragment
}
naicsCode {
...NAICSCodeFragment
}
employeeRange
crunchbaseUrl
facebookUrl
twitterUrl
foundedYear
updatedDate
}
seniority
function
}
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
}
revenue
revenueRange {
...RevenueRangeFragment
}
predictedRevenue {
...RevenueRangeFragment
}
sicCode {
...SICCodeFragment
}
secondarySicCodes {
...SICCodeFragment
}
naicsCode {
...NAICSCodeFragment
}
employeeRange
crunchbaseUrl
facebookUrl
twitterUrl
foundedYear
updatedDate
}
seniority
function
}
linkedin {
linkedinId
linkedinUrl
salesUrls
type
status
updatedAt
guid
}
profiles {
network
id
username
url
status
updatedAt
}
location {
fullAddress
areaLevel1
city
country
type
status
updatedAt
}
education {
name
type
linkedinUrl
facebookUrl
twitterUrl
linkedinId
website
domain
degrees
majors
}
updatedAt
personalEmails {
type
status
updatedAt
value
}
personalPhones {
type
status
verificationStatus
updatedAt
value
}
}
}
}
Variables
{"input": SearchPeopleInput}
Response
{
"data": {
"searchPeople": {
"totalResults": 987,
"hasMore": true,
"results": [PersonRecord]
}
}
}
trackedCompanies
Description
Get the list of tracked companies.
Response
Returns a
TrackedCompaniesConnection
Example
Query
query TrackedCompanies(
$first: Int,
$after: ID
) {
trackedCompanies(
first: $first,
after: $after
) {
pageInfo {
total
startCursor
endCursor
hasPreviousPage
hasNextPage
}
edges {
node {
id
name
domain
customData
}
cursor
}
}
}
Variables
{"first": 987, "after": "4"}
Response
{
"data": {
"trackedCompanies": {
"pageInfo": PageInfo,
"edges": [TrackedCompanyEdge]
}
}
}
usage
Description
View API credit usage and limit
Response
Returns a
UsageMetaType!
Example
Query
query Usage {
usage {
planUsage {
name
usageType
creditType
units
cap
billingType
}
trialUsage {
name
usageType
creditType
units
cap
billingType
}
subscription {
status
}
universalUsage {
units
cap
}
}
}
Response
{
"data": {
"usage": {
"planUsage": [PlanUsage],
"trialUsage": [TrialUsage],
"subscription": SubscriptionInfo,
"universalUsage": [UniversalUsage]
}
}
}
Mutations
addTrackedCompanies
Description
Add companies to the list of tracked companies. Companies must be added to the list before calling startCompanyTrackingTask
.
Response
Returns an
AddTrackedCompaniesResponse
Arguments
Name | Description |
---|---|
input -
AddTrackedCompaniesInput!
|
Example
Query
mutation AddTrackedCompanies($input: AddTrackedCompaniesInput!) {
addTrackedCompanies(input: $input) {
companies {
input {
name
domain
customData
}
company {
id
name
domain
customData
}
success
errors
}
total
}
}
Variables
{"input": AddTrackedCompaniesInput}
Response
{
"data": {
"addTrackedCompanies": {
"companies": [AddTrackedCompanyResult],
"total": 100
}
}
}
cancelCompanyTrackingTask
Description
Cancel a scheduled task to track companies.
Response
Returns a
CancelCompanyTrackingResponse
Arguments
Name | Description |
---|---|
input -
CancelCompanyTrackingTaskInput!
|
Example
Query
mutation CancelCompanyTrackingTask($input: CancelCompanyTrackingTaskInput!) {
cancelCompanyTrackingTask(input: $input) {
success
error
task {
id
jobChanges {
edges {
cursor
node {
...JobChangeFragment
}
}
pageInfo {
total
startCursor
endCursor
hasPreviousPage
hasNextPage
}
}
status
createdAt
monthsBack
jobStartDateFrom
error
isCancelled
}
}
}
Variables
{"input": CancelCompanyTrackingTaskInput}
Response
{
"data": {
"cancelCompanyTrackingTask": {
"success": false,
"error": "xyz789",
"task": CompanyTrackingTask
}
}
}
regenerate
Description
Regenerate person
Response
Returns a
RegenerateResponse!
Arguments
Name | Description |
---|---|
input -
RegenerateRecordInput!
|
Example
Query
mutation Regenerate($input: RegenerateRecordInput!) {
regenerate(input: $input)
}
Variables
{"input": RegenerateRecordInput}
Response
{"data": {"regenerate": "InProgress"}}
removeAllTrackedCompanies
Description
Remove all companies from the list of tracked companies.
Response
Returns a
RemoveAllTrackedCompaniesResponse
Example
Query
mutation RemoveAllTrackedCompanies {
removeAllTrackedCompanies {
success
totalRemaining
}
}
Response
{
"data": {
"removeAllTrackedCompanies": {"success": true, "totalRemaining": 100}
}
}
removeTrackedCompanies
Description
Remove companies from the list of tracked companies.
Response
Returns a
RemoveTrackedCompaniesResponse
Arguments
Name | Description |
---|---|
input -
RemoveTrackedCompaniesInput!
|
Example
Query
mutation RemoveTrackedCompanies($input: RemoveTrackedCompaniesInput!) {
removeTrackedCompanies(input: $input) {
companies {
id
name
domain
}
notFound
totalRemaining
}
}
Variables
{"input": RemoveTrackedCompaniesInput}
Response
{
"data": {
"removeTrackedCompanies": {
"companies": [RemoveTrackedCompanyResult],
"notFound": ["4"],
"totalRemaining": 100
}
}
}
startCompanyTrackingTask
Description
Start a scheduled task to track companies. You should have tracked companies before calling this mutation.
Response
Returns a
StartCompanyTrackingResponse
Arguments
Name | Description |
---|---|
input -
StartCompanyTrackingTaskInput!
|
Example
Query
mutation StartCompanyTrackingTask($input: StartCompanyTrackingTaskInput!) {
startCompanyTrackingTask(input: $input) {
success
errors
task {
id
jobChanges {
edges {
cursor
node {
...JobChangeFragment
}
}
pageInfo {
total
startCursor
endCursor
hasPreviousPage
hasNextPage
}
}
status
createdAt
monthsBack
jobStartDateFrom
error
isCancelled
}
}
}
Variables
{"input": StartCompanyTrackingTaskInput}
Response
{
"data": {
"startCompanyTrackingTask": {
"success": false,
"errors": ["abc123"],
"task": CompanyTrackingTask
}
}
}
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
AddTrackedCompaniesInput
Fields
Input Field | Description |
---|---|
companies -
[AddTrackedCompanyInput!]!
|
Example
{"companies": [AddTrackedCompanyInput]}
AddTrackedCompaniesResponse
Description
The response of adding a set of companies to the tracked list
Fields
Field Name | Description |
---|---|
companies -
[AddTrackedCompanyResult!]!
|
The results of adding each company to the tracked list |
total -
Long!
|
Total number of companies added to the tracked list |
Example
{"companies": [AddTrackedCompanyResult], "total": 100}
AddTrackedCompany
AddTrackedCompanyInput
AddTrackedCompanyResult
Description
The result of adding a single company to the tracked list
Fields
Field Name | Description |
---|---|
input -
AddTrackedCompany!
|
The input data for the company to add |
company -
TrackedCompany
|
The tracked company after adding. If the company was not added, this field will be empty |
success -
Boolean!
|
Whether adding the company was successful |
errors -
[String!]!
|
A list of errors that occurred while adding the company. This field will be empty if the company was added successfully. |
Example
{
"input": AddTrackedCompany,
"company": TrackedCompany,
"success": true,
"errors": ["abc123"]
}
ApiCreditType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"Page"
ApiName
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
Example
"Contact"
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": "abc123",
"linkedinId": "abc123",
"name": "abc123",
"companyId": "abc123",
"companyName": "abc123",
"companyDomain": "abc123",
"title": "abc123",
"value": "abc123",
"status": "Correct",
"invalidReason": "EmailBounceCode513",
"type": "PersonalMobile",
"lastSeen": "2021-10-02T00:00:00.000Z"
}
ApiUsageType
Values
Enum Value | Description |
---|---|
|
|
|
Example
"Premium"
BillingType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"FreeCredits"
Boolean
Description
The Boolean
scalar type represents true
or false
.
Example
true
CancelCompanyTrackingResponse
Fields
Field Name | Description |
---|---|
success -
Boolean!
|
|
error -
String
|
|
task -
CompanyTrackingTask
|
Example
{
"success": false,
"error": "abc123",
"task": CompanyTrackingTask
}
CancelCompanyTrackingTaskInput
Company
Fields
Field Name | Description |
---|---|
id -
String!
|
|
name -
String
|
|
industry -
String
|
|
description -
String
|
|
linkedinId -
String
|
|
domain -
String
|
|
employeeCount -
Int
|
|
city -
String
|
|
country -
String
|
|
state -
String
|
|
postalCode -
String
|
|
score -
Float
|
|
companyTechnologies -
[String!]
|
|
companyTechnologyCategories -
[String!]
|
|
revenueRange -
RevenueRange
|
|
fundingInfo -
FundingInfo
|
|
naicsCode -
NAICSCode
|
Example
{
"id": "xyz789",
"name": "abc123",
"industry": "abc123",
"description": "abc123",
"linkedinId": "xyz789",
"domain": "xyz789",
"employeeCount": 987,
"city": "abc123",
"country": "abc123",
"state": "abc123",
"postalCode": "xyz789",
"score": 987.65,
"companyTechnologies": ["abc123"],
"companyTechnologyCategories": ["abc123"],
"revenueRange": RevenueRange,
"fundingInfo": FundingInfo,
"naicsCode": NAICSCode
}
CompanyData
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": "abc123",
"domain": "xyz789",
"emailDomain": "xyz789",
"linkedinId": "xyz789",
"country": "abc123",
"searchInPastCompanies": true,
"strict": false
}
CompanyFilter
Fields
Input Field | Description |
---|---|
ids -
[String!]
|
|
names -
[String!]
|
|
domains -
[String!]
|
|
linkedinIds -
[String!]
|
|
industries -
[String!]
|
|
sizes -
[CompanySizeFilter!]
|
|
cities -
[String!]
|
|
states -
[String!]
|
|
postalCodes -
[String!]
|
|
countries -
[String!]
|
|
descriptions -
[String!]
|
|
technologies -
[String!]
|
|
technologyCategories -
[String!]
|
|
revenueRanges -
[RangeFilter!]
|
|
fundingInfoFilters -
[FundingInfoFilter!]
|
|
naicsCodeFilters -
[NAICSCodeFilter!]
|
Example
{
"ids": ["abc123"],
"names": ["abc123"],
"domains": ["xyz789"],
"linkedinIds": ["abc123"],
"industries": ["xyz789"],
"sizes": [CompanySizeFilter],
"cities": ["abc123"],
"states": ["xyz789"],
"postalCodes": ["abc123"],
"countries": ["xyz789"],
"descriptions": ["abc123"],
"technologies": ["xyz789"],
"technologyCategories": ["xyz789"],
"revenueRanges": [RangeFilter],
"fundingInfoFilters": [FundingInfoFilter],
"naicsCodeFilters": [NAICSCodeFilter]
}
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
|
|
address -
String
|
|
locationInfo -
LocationInfo
|
|
logoUrl -
String
|
|
linkedinId -
String
|
|
linkedinUrl -
String
|
|
numberOfEmployees -
Int
|
|
industry -
String
|
|
specialities -
[String!]
|
|
fundingInfo -
FundingInfo
|
|
technologies -
[TechnologyInfo!]
|
|
revenue -
Long
|
|
revenueRange -
RevenueRange
|
|
predictedRevenue -
RevenueRange
|
|
sicCode -
SICCode
|
|
secondarySicCodes -
[SICCode!]
|
|
naicsCode -
NAICSCode
|
|
employeeRange -
String
|
|
crunchbaseUrl -
String
|
|
facebookUrl -
String
|
|
twitterUrl -
String
|
|
foundedYear -
Int
|
|
updatedDate -
ZonedDateTime
|
Example
{
"source": "abc123",
"name": "abc123",
"alternativeNames": ["xyz789"],
"domain": "xyz789",
"description": "abc123",
"emailDomains": ["xyz789"],
"type": "abc123",
"phones": ["abc123"],
"country": "xyz789",
"address": "xyz789",
"locationInfo": LocationInfo,
"logoUrl": "abc123",
"linkedinId": "abc123",
"linkedinUrl": "abc123",
"numberOfEmployees": 123,
"industry": "xyz789",
"specialities": ["abc123"],
"fundingInfo": FundingInfo,
"technologies": [TechnologyInfo],
"revenue": 100,
"revenueRange": RevenueRange,
"predictedRevenue": RevenueRange,
"sicCode": SICCode,
"secondarySicCodes": [SICCode],
"naicsCode": NAICSCode,
"employeeRange": "abc123",
"crunchbaseUrl": "abc123",
"facebookUrl": "xyz789",
"twitterUrl": "xyz789",
"foundedYear": 987,
"updatedDate": "2021-10-02T00:00:00.000Z"
}
CompanySearchResponse
Fields
Field Name | Description |
---|---|
totalCompanies -
Long!
|
|
companies -
[CompanyWithPeople!]!
|
Example
{"totalCompanies": 100, "companies": [CompanyWithPeople]}
CompanySearchResult
Fields
Field Name | Description |
---|---|
totalResults -
Int!
|
|
hasMore -
Boolean!
|
|
results -
[CompanyInfo!]!
|
Example
{
"totalResults": 123,
"hasMore": false,
"results": [CompanyInfo]
}
CompanySizeFilter
CompanySortingOption
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"IdDesc"
CompanyTrackingTask
Fields
Field Name | Description |
---|---|
id -
ID!
|
|
jobChanges -
JobChangeConnection
|
Returns a list of jobchanges. Note that this collection will be empty if the task is not yet completed. |
status -
TaskStatus!
|
The present status of the task. |
createdAt -
Instant!
|
The timestamp of when this task was created. |
monthsBack -
Int!
|
|
jobStartDateFrom -
LocalDate!
|
|
error -
String
|
The error message if the task is in a failed state. |
isCancelled -
Boolean!
|
True if the task was manually cancelled before completion. |
Example
{
"id": 4,
"jobChanges": JobChangeConnection,
"status": "Failed",
"createdAt": Instant,
"monthsBack": 987,
"jobStartDateFrom": "2020-07-19",
"error": "xyz789",
"isCancelled": true
}
CompanyWithPeople
Fields
Field Name | Description |
---|---|
company -
Company!
|
|
people -
[Person!]!
|
|
totalContactsInCompany -
Long!
|
Example
{
"company": Company,
"people": [Person],
"totalContactsInCompany": 100
}
ContactInfoStatus
Values
Enum Value | Description |
---|---|
|
|
|
Example
"Correct"
ContactInfoType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PersonalMobile"
ContactSortingOption
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"RoleAsc"
Cursor
Description
A pagination cursor
Example
Cursor
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
Fields
Field Name | Description |
---|---|
name -
String!
|
|
type -
String
|
|
linkedinUrl -
String
|
|
facebookUrl -
String
|
|
twitterUrl -
String
|
|
linkedinId -
String
|
|
website -
String
|
|
domain -
String
|
|
degrees -
[String!]!
|
|
majors -
[String!]!
|
Example
{
"name": "xyz789",
"type": "abc123",
"linkedinUrl": "abc123",
"facebookUrl": "abc123",
"twitterUrl": "xyz789",
"linkedinId": "abc123",
"website": "xyz789",
"domain": "abc123",
"degrees": ["abc123"],
"majors": ["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
|
|
skip -
Int
|
|
limit -
Int
|
|
sortContactsBy -
[ContactSortingOption!]
|
Example
{
"companyFilter": CompanyFilter,
"companyExcludedFilter": CompanyFilter,
"skip": 987,
"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
|
|
skip -
Int
|
|
limit -
Int
|
|
limitPerCompany -
Int
|
|
sortCompaniesBy -
[CompanySortingOption!]
|
|
sortContactsBy -
[ContactSortingOption!]
|
Example
{
"companyFilter": CompanyFilter,
"companyExcludedFilter": CompanyFilter,
"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"
Instant
Description
An instantaneous point on the time-line represented by a standard date time string
Example
Instant
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
987
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"
JobChange
Fields
Field Name | Description |
---|---|
id -
ID!
|
|
person -
PersonData!
|
|
currentCompany -
CompanyData!
|
|
currentPosition -
Position!
|
|
jobChangeType -
JobDetectionType!
|
|
matchedICPIds -
[String!]!
|
|
duplicateRecordIds -
[String!]!
|
Example
{
"id": 4,
"person": PersonData,
"currentCompany": CompanyData,
"currentPosition": Position,
"jobChangeType": "JobChange",
"matchedICPIds": ["xyz789"],
"duplicateRecordIds": ["abc123"]
}
JobChangeConnection
Fields
Field Name | Description |
---|---|
edges -
[JobChangeEdge!]!
|
|
pageInfo -
PageInfo!
|
Example
{
"edges": [JobChangeEdge],
"pageInfo": PageInfo
}
JobChangeEdge
Fields
Field Name | Description |
---|---|
cursor -
ID!
|
|
node -
JobChange!
|
Example
{"cursor": 4, "node": JobChange}
JobDetectionType
Values
Enum Value | Description |
---|---|
|
|
|
Example
"JobChange"
Json
Description
Represents a JSON object
Example
Json
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": ["xyz789"],
"type": "NotApplicable",
"status": "Valid",
"updatedAt": "2021-10-02T00:00:00.000Z",
"guid": "xyz789"
}
LocalDate
Description
A date without a time-zone in the ISO-8601 calendar system using the format 1970-01-01
Example
"2020-07-19"
LocationInfo
Example
{
"formattedAddress": "xyz789",
"street1": "abc123",
"street2": "xyz789",
"city": "xyz789",
"areaLevel1": "xyz789",
"country": "xyz789",
"postalCode": "abc123"
}
LocationRecord
Fields
Field Name | Description |
---|---|
fullAddress -
String
|
|
areaLevel1 -
String
|
|
city -
String
|
|
country -
String
|
|
type -
GenericFieldType!
|
|
status -
GenericFieldStatus!
|
|
updatedAt -
ZonedDateTime!
|
Example
{
"fullAddress": "abc123",
"areaLevel1": "xyz789",
"city": "xyz789",
"country": "xyz789",
"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
100
NAICSCode
NAICSCodeFilter
NameInfo
PageInfo
Fields
Field Name | Description |
---|---|
total -
Int!
|
Total count matching the query for this connection |
startCursor -
Cursor
|
The cursor of the first item in the connection |
endCursor -
Cursor
|
The cursor of the last item in the connection |
hasPreviousPage -
Boolean!
|
Whether there are more items in the connection before the current page |
hasNextPage -
Boolean!
|
Whether there are more items in the connection after the current page |
Example
{
"total": 123,
"startCursor": Cursor,
"endCursor": Cursor,
"hasPreviousPage": true,
"hasNextPage": true
}
Person
Fields
Field Name | Description |
---|---|
id -
String!
|
|
companyId -
String!
|
|
name -
String
|
|
linkedinId -
String
|
|
linkedinUrl -
String
|
|
title -
String
|
|
role -
String
|
|
state -
String
|
|
country -
String
|
|
seniority -
String
|
|
workEmails -
[String!]
|
|
verifiedWorkEmails -
[String!]
|
|
verifiedLikelyWorkEmails -
[String!]
|
|
workPhones -
[String!]
|
|
personalEmails -
[String!]
|
|
personalPhones -
[String!]
|
|
score -
Float
|
|
firstName -
String
|
|
middleName -
String
|
|
lastName -
String
|
|
updatedAt -
ZonedDateTime
|
|
currentPositionStartDate -
ZonedDateTime
|
|
company -
Company
|
|
picture -
String
|
Example
{
"id": "xyz789",
"companyId": "xyz789",
"name": "abc123",
"linkedinId": "xyz789",
"linkedinUrl": "abc123",
"title": "xyz789",
"role": "xyz789",
"state": "abc123",
"country": "xyz789",
"seniority": "xyz789",
"workEmails": ["abc123"],
"verifiedWorkEmails": ["abc123"],
"verifiedLikelyWorkEmails": ["abc123"],
"workPhones": ["abc123"],
"personalEmails": ["xyz789"],
"personalPhones": ["xyz789"],
"score": 123.45,
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "xyz789",
"updatedAt": "2021-10-02T00:00:00.000Z",
"currentPositionStartDate": "2021-10-02T00:00:00.000Z",
"company": Company,
"picture": "abc123"
}
PersonData
Fields
Field Name | Description |
---|---|
firstName -
String!
|
|
lastName -
String
|
|
email -
String
|
|
emailStatus -
String
|
|
personalPhones -
[String!]!
|
|
workPhones -
[String!]!
|
|
linkedinUrl -
String
|
|
country -
String
|
Example
{
"firstName": "xyz789",
"lastName": "abc123",
"email": "abc123",
"emailStatus": "abc123",
"personalPhones": ["xyz789"],
"workPhones": ["xyz789"],
"linkedinUrl": "abc123",
"country": "abc123"
}
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!]!
|
Example
{
"_id": "abc123",
"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]
}
PersonSearchResponse
Fields
Field Name | Description |
---|---|
totalPeople -
Long!
|
|
people -
[Person!]!
|
Example
{"totalPeople": 100, "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!
|
Use verificationStatus instead |
verificationStatus -
VerificationStatusType!
|
|
updatedAt -
ZonedDateTime!
|
|
value -
String!
|
Example
{
"type": "WorkPhone",
"status": "Verified",
"verificationStatus": "LikelyAccurate",
"updatedAt": "2021-10-02T00:00:00.000Z",
"value": "abc123"
}
PhoneType
Description
Type of phone
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"WorkPhone"
PhoneVerificationStatusType
Description
Status of a phone number
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"Verified"
PlanUsage
Fields
Field Name | Description |
---|---|
name -
ApiName!
|
|
usageType -
ApiUsageType!
|
|
creditType -
ApiCreditType!
|
|
units -
Int!
|
|
cap -
Int
|
|
billingType -
BillingType!
|
Example
{
"name": "Contact",
"usageType": "Premium",
"creditType": "Page",
"units": 987,
"cap": 987,
"billingType": "FreeCredits"
}
Position
PositionRecord
Fields
Field Name | Description |
---|---|
companyId -
String!
|
|
title -
String
|
|
dateRange -
DateRange
|
|
updatedAt -
ZonedDateTime!
|
|
emails -
[WorkEmailRecordType!]!
|
|
phones -
[WorkPhoneRecordType!]!
|
|
companyInfo -
CompanyInfo
|
|
seniority -
String
|
|
function -
String
|
Example
{
"companyId": "xyz789",
"title": "abc123",
"dateRange": DateRange,
"updatedAt": "2021-10-02T00:00:00.000Z",
"emails": [WorkEmailRecordType],
"phones": [WorkPhoneRecordType],
"companyInfo": CompanyInfo,
"seniority": "xyz789",
"function": "abc123"
}
ProfileFilterType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"HasVerifiedWorkPhone"
RangeFilter
RegenerateRecordInput
RegenerateResponse
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"InProgress"
RegeneratedTimeInput
RegeneratedTimeResult
Fields
Field Name | Description |
---|---|
time -
ZonedDateTime
|
Example
{"time": "2021-10-02T00:00:00.000Z"}
RemoveAllTrackedCompaniesResponse
RemoveTrackedCompaniesInput
Fields
Input Field | Description |
---|---|
ids -
[ID!]!
|
Example
{"ids": ["4"]}
RemoveTrackedCompaniesResponse
Fields
Field Name | Description |
---|---|
companies -
[RemoveTrackedCompanyResult!]!
|
|
notFound -
[ID!]!
|
|
totalRemaining -
Long!
|
Example
{
"companies": [RemoveTrackedCompanyResult],
"notFound": [4],
"totalRemaining": 100
}
RemoveTrackedCompanyResult
RevenueRange
SICCode
SearchCompanyInput
Description
Input for searching company
Example
{
"source": "xyz789",
"name": "abc123",
"domain": "abc123",
"linkedinId": "xyz789",
"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. |
Example
{
"skip": 987,
"limit": 123,
"id": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"middleName": "xyz789",
"fullName": "xyz789",
"company": CompanyDetails,
"linkedinId": "abc123",
"linkedinUrl": "xyz789",
"email": "abc123",
"hashedEmail": "abc123",
"phone": "abc123",
"workEmailStatusIn": ["Verified"],
"containsWorkContactInfo": true,
"profileFilter": ["HasVerifiedWorkPhone"],
"includeInvalid": true
}
SearchResult
Fields
Field Name | Description |
---|---|
totalResults -
Int!
|
|
hasMore -
Boolean!
|
|
results -
[PersonRecord!]!
|
Example
{
"totalResults": 987,
"hasMore": true,
"results": [PersonRecord]
}
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"
}
StartCompanyTrackingResponse
Fields
Field Name | Description |
---|---|
success -
Boolean!
|
Whether the task was successfully started |
errors -
[String!]!
|
A list of errors that prevented the task from starting |
task -
CompanyTrackingTask
|
The created task if the mutation was successful |
Example
{
"success": false,
"errors": ["xyz789"],
"task": CompanyTrackingTask
}
StartCompanyTrackingTaskInput
Fields
Input Field | Description |
---|---|
monthsBack -
Int
|
Example
{"monthsBack": 987}
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"
SubscriptionInfo
Fields
Field Name | Description |
---|---|
status -
String
|
Example
{"status": "xyz789"}
TaskStatus
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"Failed"
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": ["abc123"]
}
TrackedCompaniesConnection
Fields
Field Name | Description |
---|---|
pageInfo -
PageInfo!
|
|
edges -
[TrackedCompanyEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [TrackedCompanyEdge]
}
TrackedCompany
TrackedCompanyEdge
Fields
Field Name | Description |
---|---|
node -
TrackedCompany!
|
|
cursor -
ID!
|
Example
{
"node": TrackedCompany,
"cursor": "4"
}
TrialUsage
Fields
Field Name | Description |
---|---|
name -
ApiName!
|
|
usageType -
ApiUsageType!
|
|
creditType -
ApiCreditType!
|
|
units -
Int!
|
|
cap -
Int
|
|
billingType -
BillingType!
|
Example
{
"name": "Contact",
"usageType": "Premium",
"creditType": "Page",
"units": 123,
"cap": 987,
"billingType": "FreeCredits"
}
UniversalUsage
UsageMetaType
Fields
Field Name | Description |
---|---|
planUsage -
[PlanUsage!]!
|
Returns the active(non-trial) api usage in the current billing period. The from input argument is deprecated and will be ignored. |
Arguments
|
|
trialUsage -
[TrialUsage!]!
|
|
subscription -
SubscriptionInfo!
|
|
universalUsage -
[UniversalUsage!]!
|
Example
{
"planUsage": [PlanUsage],
"trialUsage": [TrialUsage],
"subscription": SubscriptionInfo,
"universalUsage": [UniversalUsage]
}
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": "xyz789"
}
WorkPhoneRecordType
Fields
Field Name | Description |
---|---|
type -
PhoneType!
|
|
status -
PhoneVerificationStatusType!
|
Use verificationStatus instead |
verificationStatus -
VerificationStatusType!
|
|
updatedAt -
ZonedDateTime!
|
|
value -
String!
|
Example
{
"type": "WorkPhone",
"status": "Verified",
"verificationStatus": "LikelyAccurate",
"updatedAt": "2021-10-02T00:00:00.000Z",
"value": "abc123"
}
ZonedDateTime
Description
Zoned date time type
Example
"2021-10-02T00:00:00.000Z"