Evaboot API
  • Documentation
  • API Reference
Information
LinkedIn Extraction
    Extract a Sales Navigator search or listpostExtract a single Sales Navigator profilepostExtract a list of Sales Navigator profilespostGet LinkedIn extraction job resultsgetList LinkedIn extraction jobsget
Email Finder
    Find an emailpostList Email Finder jobsgetFind emails in bulkpostGet Email Finder job resultsget
Email Verifier
    Verify an emailpostList email validation jobsgetVerify emails in bulkpostGet email validation job resultsget
Account
    Get user quota informationget
Search Builder
    Generate a Sales Navigator search URLpost
Schemas
powered by Zudoku
Evaboot Public API
Evaboot Public API

Schemas


ExtractionCreateOut

extraction_id
​string · required

Identifier of the new extraction. Poll GET /v1/extractions/{extraction_id}/ with it to follow progress and collect the results; it is the same value the list endpoint returns as search_id.

Example: ext-12345
success
​boolean

Always true when the extraction was accepted.

Example: true
Default: true
message
​string

Human-readable confirmation that the job was queued.

Example: Extraction job created and processing has begun
Default:
status
​string

Stage the job was in when it was accepted.

Example: Scraping initiated
Default:
count
​integer

Number of leads or accounts submitted, when known upfront. It is 0 for a search or list URL, whose real size is only known once Sales Navigator has been paged through.

Example: 3
Default: 0

UrlExtractionCreateIn

linkedin_url
​string · required

The Sales Navigator URL to extract. Accepts a people or company search URL, a saved search URL, or a lead or account list URL. Copy it straight from your browser's address bar; it must be a linkedin.com/sales/... URL.

Example: https://www.linkedin.com/sales/search/people?query=(spellCorrectionEnabled%3Atrue%2CrecentSearchParam%3A(keywords%3ACEOs))
search_name
​string · maxLength: 255 · required

Your own name for this extraction. Shown in the Evaboot dashboard and returned by the list and detail endpoints, so use something you will recognize later.

Example: Tech Startup CEOs
​

Optional HTTPS URL to notify once the extraction finishes. It receives a POST carrying the same results as GET /v1/extractions/{extraction_id}/, so you do not have to poll. Leave it out to poll instead.

Example: https://myapp.com/webhook/extraction
enrich_email
​string · enum

Whether to also find and verify a professional email address for each extracted lead. none skips enrichment, matching enriches only the leads that match your search filters, all enriches every extracted lead. Enrichment costs 1 extra credit per email found.

Enum values:
none
matching
all
Example: matching
Default: none

SingleExtractionOut

extraction_id
​string · required

Identifier of the extraction that produced this record. Use it with GET /v1/extractions/{extraction_id}/ to fetch the same result again later.

Example: single-ext-12345
success
​boolean

Always true when the profile was extracted.

Example: true
Default: true
​object

The extracted record, as human-readable column names mapped to values: identity, role and tenure, company details, and the email address plus its verification status when enrichment was requested. Which columns are present depends on whether a lead or an account was extracted. Empty if nothing could be extracted.

Example: {"Company Name":"TechCorp Inc","Current Job":"Senior Software Engineer","Email":"alex.johnson@techcorp.com","Email Status":"safe","Full Name":"Alex Johnson"}
Default: {}

SingleExtractionCreateIn

profile_id
​string · required

The lead or account to extract, as a Sales Navigator URL (linkedin.com/sales/lead/...) or as a bare Sales Navigator id. Public linkedin.com/in/... profile URLs are not accepted.

Example: ACwAAABcYZ8B
enrich_email
​string · enum

Whether to also find and verify a professional email address for the extracted lead. none skips enrichment, matching enriches only a lead that matches your search filters, all always enriches. Enrichment costs 1 extra credit when an email is found.

Enum values:
none
matching
all
Example: none
Default: none

ProfileExtractionCreateIn

profile_ids
​string[] · minItems: 1 · maxItems: 2500 · required

The Sales Navigator leads or accounts to extract, as full URLs or as bare Sales Navigator ids. One batch must be either all leads or all accounts, and public linkedin.com/in/... profile URLs are not accepted. Between 1 and 2500 entries.

Example: ["https://www.linkedin.com/sales/lead/ACwAAABcYZ8B","https://www.linkedin.com/sales/lead/ACwAAABdYZ9C","ACwAAABeYZ8D"]
search_name
​string · maxLength: 255 · required

Your own name for this extraction. Shown in the Evaboot dashboard and returned by the list and detail endpoints.

Example: Target Executive Prospects
​

Optional HTTPS URL to notify once the extraction finishes. It receives a POST carrying the same results as GET /v1/extractions/{extraction_id}/, so you do not have to poll.

Example: https://myapp.com/webhook/extraction
enrich_email
​string · enum

Whether to also find and verify a professional email address for each extracted lead. none skips enrichment, matching enriches only the leads that match your search filters, all enriches every extracted lead. Enrichment costs 1 extra credit per email found.

Enum values:
none
matching
all
Example: all
Default: none

ExtractionListItemOut

search_id
​string · required

Identifier of the extraction. Pass it to GET /v1/extractions/{extraction_id}/ to fetch the results.

Example: ext-12345
search_name
​string

The name you gave the extraction when you created it.

Example: Tech Startup CEOs
Default:
status
​string

Where the extraction stands: ACCEPTED (queued), SCHEDULED (waiting for its start date), EXECUTING (running), EXECUTED (finished, results available), PAUSED (waiting for credits) or FAILED.

Example: EXECUTED
Default:
extraction_type
​string

How the extraction was created: SEARCH (a search URL), LIST (a lead or account list URL), UPLOAD (a list of profiles) or SINGLE (one profile).

Example: SEARCH
Default:
total_prospects
​integer

Number of leads or accounts Sales Navigator reported for this search before scraping. An estimate, so it can differ from the number of records finally returned.

Example: 150
Default: 0
​

When the extraction was created (UTC).

Example: 2023-01-01 12:00:00+00:00

ExtractionDetailOut

search_id
​string · required

Identifier of the extraction you requested.

Example: ext-12345
search_name
​string

The name you gave the extraction when you created it.

Example: Tech Startup CEOs
Default:
status
​string

Where the extraction stands. On this response it is EXECUTED when the results are complete, or FAILED / PAUSED when they are not.

Example: EXECUTED
Default:
extraction_type
​string

How the extraction was created: SEARCH, LIST, UPLOAD or SINGLE.

Example: SEARCH
Default:
total_prospects
​integer

Number of leads or accounts Sales Navigator reported before scraping. An estimate; use total_count for the number of records actually extracted.

Example: 150
Default: 0
progress
​integer

Completion percentage, 0 to 100. 100 once the extraction has finished successfully.

Example: 100
Default: 0
​

When the extraction was created (UTC).

Example: 2023-01-01 12:00:00+00:00
​

When the extraction finished (UTC). null if it never finished.

Example: 2023-01-01 12:04:31+00:00
failure_reason
​string

Short machine-readable reason the extraction did not complete, for example insufficient_credits, auth_error, quota_exceeded or invalid_urls. Empty string when the extraction succeeded.

Example: insufficient_credits
Default:
​object[]

The extracted records, each a mapping of human-readable column names to values: identity, role and tenure, company details, and the email address plus its verification status when enrichment was requested. Which columns are present depends on whether leads or accounts were extracted.

Example: [{"Company Name":"TechCorp Inc","Current Job":"Senior Software Engineer","Email":"alex.johnson@techcorp.com","Email Status":"safe","Full Name":"Alex Johnson"}]
Default: []
start
​integer

Zero-based index of the first record returned.

Example: 0
Default: 0
​

Page size that was applied, echoing the limit you sent. null when you did not page and every record was returned.

Example: 100
returned_count
​integer

Number of records in prospects on this response.

Example: 100
Default: 0
total_count
​integer

Number of records this extraction produced in total, across all pages.

Example: 143
Default: 0
has_more
​boolean

Whether records remain after this page. Request the next page with start = start + returned_count.

Example: true
Default: false

ExtractionInProgressOut

search_id
​string · required

Identifier of the extraction you requested.

Example: ext-12345
search_name
​string

The name you gave the extraction when you created it.

Example: Tech Startup CEOs
Default:
status
​string

Where the extraction stands: ACCEPTED (queued), SCHEDULED (waiting for its start date) or EXECUTING (running).

Example: EXECUTING
Default:
progress
​integer

Completion percentage, 0 to 100. Paging through Sales Navigator accounts for the first three quarters, fetching the individual profiles for the last quarter.

Example: 45
Default: 0
extraction_type
​string

How the extraction was created: SEARCH, LIST, UPLOAD or SINGLE.

Example: SEARCH
Default:
​

When the extraction was created (UTC).

Example: 2023-01-01 12:00:00+00:00
total_prospects
​integer

Number of leads or accounts Sales Navigator reported for this search before scraping. An estimate.

Example: 150
Default: 0

EmailFinderJobAcceptedOut

job_id
​string · required

Identifier of the queued job. Use it with GET /v1/email-finder/{job_id}/ to collect the results.

Example: 550e8400-e29b-41d4-a716-446655440000
success
​boolean

Always true; failures come back as an error response.

Example: true
Default: true
message
​string

Human-readable confirmation that the job was queued.

Example: Email finder job created and processing has begun
Default: Email finder job created and processing has begun

EmailFinderJobIn

​EmailFinderProspectIn[] · required

The people to find emails for. Each entry needs a first and last name plus a company name or domain.

job_name
​string

Your own label for the job, so you can recognize it later. Optional.

Example: Tech Startup Email Hunt
Default:
webhook_url
​string

Optional HTTPS URL to notify when the job finishes. We send a POST carrying the same payload as GET /v1/email-finder/{job_id}/, so you can skip polling.

Example: https://myapp.com/webhook/email-finder
Default:

EmailFinderProspectIn

first_name
​string · required

First name of the prospect.

Example: John
last_name
​string · required

Last name of the prospect.

Example: Doe
company_name
​string

Name of the company the prospect works at. Supply this or company_domain for each prospect.

Example: Example Corp
Default:
company_domain
​string

Web domain of the prospect's company, without a scheme or path. Improves accuracy when you already know it.

Example: example.com
Default:

EmailFinderJobOut

id
​string · required

Identifier of the job, as returned when you created it.

Example: dcbcdb01-42a8-4efb-91a7-ce6a9ba01afb
status
​string · required

Job status: pending, running, complete or failed.

Example: complete
created_at
​string · required

When the job was created.

Example: 2023-01-01T12:00:00Z
updated_at
​string · required

When the job last changed.

Example: 2023-01-01T12:05:00Z
​EmailFinderProspectOut[] · required

One result per prospect submitted, in the order received.

progress
​integer

Percentage of the job's prospects that have finished, from 0 to 100.

Example: 100
Default: 0
error_message
​string

Job-level failure message. Empty when the job itself did not fail; a single prospect failing is reported on that prospect.

Default:
job_type
​string

Always email_finder for jobs created on this endpoint.

Example: email_finder
Default: email_finder

EmailFinderProspectOut

id
​string

Identifier of this prospect within the job.

Example: 5371cd59-adc2-402f-af02-d40aee34f629
Default:
first_name
​string

First name as submitted.

Example: John
Default:
last_name
​string

Last name as submitted.

Example: Doe
Default:
full_name
​string

First and last name joined, for convenience.

Example: John Doe
Default:
company_name
​string

Company name as submitted.

Example: Example Corp
Default:
company_domain
​string

Company domain as submitted.

Example: example.com
Default:
​

The email address we found, or null when no address could be found for this prospect.

Example: john.doe@example.com
​

Deliverability verdict for found_email: safe (deliverable), riskier (accepts mail but less certain), suspect or invalid. null when no email was found.

Example: safe
status
​string

Outcome for this prospect: pending (queued), processing (being looked up), complete (finished, see found_email) or failed (no email found, or the lookup errored).

Example: complete
Default:
​

Why this prospect failed, or null when it did not fail.

Example: Email not found

EmailFinderOut

​EmailFinderProspectOut · required

The person you asked about, with the email and its verdict.

success
​boolean

true when the lookup ran, including when it ran and found nothing; false when the lookup itself errored.

Example: true
Default: true
job_id
​string

Reference for this single lookup. There is nothing to poll: the result is already in prospect.

Example: 550e8400-e29b-41d4-a716-446655440000
Default:

EmailFinderIn

first_name
​string · required

First name of the person whose email you are looking for.

Example: John
last_name
​string · required

Last name of the person whose email you are looking for.

Example: Doe
company_name
​string

Name of the company the person works at. Supply this or company_domain — the lookup needs at least one of them, and sending both gives the best hit rate.

Example: Example Corp
Default:
company_domain
​string

Web domain of the company, without a scheme or path. The most accurate way to identify the company; supply this or company_name.

Example: example.com
Default:

EmailFinderJobInProgressOut

id
​string · required

Identifier of the job.

Example: 550e8400-e29b-41d4-a716-446655440000
status
​string · required

pending while the job is queued, running once it started.

Example: running
created_at
​string · required

When the job was created.

Example: 2023-01-01T12:00:00Z
updated_at
​string · required

When the job last changed.

Example: 2023-01-01T12:01:00Z
progress
​integer

Percentage of the job's prospects that have finished, from 0 to 100.

Example: 45
Default: 0

EmailValidationJobAcceptedOut

job_id
​string · required

Identifier of the new job. Pass it to the job-retrieval endpoint to poll for results.

Example: 550e8400-e29b-41d4-a716-446655440000
success
​boolean

True when the job was accepted.

Default: true
message
​string

Human-readable confirmation that the job started.

Default: Email validation job created and processing has begun

EmailValidationJobIn

​EmailValidationProspectIn[] · required

The addresses to verify, one entry per address.

job_name
​string

Your own label for the job, so you can recognize it later in the Evaboot dashboard.

Example: Email List Validation
Default:
webhook_url
​string

Optional HTTPS URL to notify when the job finishes. It receives a POST carrying the same payload as the job-retrieval endpoint. Leave empty to poll instead.

Example: https://myapp.com/webhook/email-validation
Default:

EmailValidationProspectIn

email
​string · required

The email address to verify.

Example: john.doe@example.com

EmailValidationJobOut

id
​string · required

Identifier of the job.

Example: 550e8400-e29b-41d4-a716-446655440000
status
​string · required

complete when every address has been processed, failed when the job could not finish.

Example: complete
created_at
​string · required

When the job was created.

Example: 2023-01-01T12:00:00Z
updated_at
​string · required

When the job last changed.

Example: 2023-01-01T12:05:00Z
​EmailValidationJobProspectOut[] · required

One verification result per submitted address.

progress
​integer

Percentage of addresses processed, from 0 to 100.

Example: 100
Default: 0
error_message
​string

Why the job failed. Empty when it completed normally.

Default:
job_type
​string

Always email_validation for jobs created here.

Example: email_validation
Default: email_validation

EmailValidationJobProspectOut

id
​string

Identifier of this address within the job.

Example: 123e4567-e89b-12d3-a456-426614174000
Default:
email
​string

The email address that was submitted for verification.

Example: john.doe@example.com
Default:
​

Deliverability verdict: safe (deliverable), riskier (deliverable but lower confidence), suspect (could not be confirmed) or invalid (undeliverable). Null when verification did not complete.

Example: safe
status
​string

Per-address progress: pending, processing, complete once a verdict was reached, or failed when verification could not run.

Example: complete
Default:
​

Why this address could not be verified. Null when it succeeded.

Example: Invalid email domain

EmailValidationOut

​EmailValidationProspectOut · required

The verification result for the submitted address.

success
​boolean

True when a verdict was reached, false when verification failed.

Default: true
job_id
​string

Reference for this verification, useful when correlating it with your own logs. Nothing is queued, so there is no job to poll.

Example: dcbcdb01-42a8-4efb-91a7-ce6a9ba01afb
Default:

EmailValidationProspectOut

email
​string

The email address that was verified.

Example: john.doe@example.com
Default:
​

Deliverability verdict: safe (deliverable), riskier (deliverable but lower confidence), suspect (could not be confirmed) or invalid (undeliverable). Null when verification did not complete.

Example: safe
status
​string

Whether verification ran: complete when a verdict was reached, failed when it could not be.

Example: complete
Default:
​

Why verification failed. Null when it succeeded.

Example: Validation error

EmailValidationIn

email
​string · required

The email address to verify.

Example: john.doe@example.com

EmailValidationJobInProgressOut

id
​string · required

Identifier of the job.

Example: 550e8400-e29b-41d4-a716-446655440000
status
​string · required

pending while the job is queued, running while addresses are being verified.

Example: running
created_at
​string · required

When the job was created.

Example: 2023-01-01T12:00:00Z
updated_at
​string · required

When the job last changed.

Example: 2023-01-01T12:01:00Z
progress
​integer

Percentage of addresses processed so far, from 0 to 100.

Example: 45
Default: 0

QuotaInfo

daily_limit
​integer

Total profiles you may extract per day, summed across your valid Sales Navigator accounts.

Example: 2500
Default: 0
used_today
​integer

Profiles extracted in the last 24 hours, summed across your valid Sales Navigator accounts.

Example: 250
Default: 0
remaining
​integer

Profiles you can still extract today, summed across your valid Sales Navigator accounts. A single extraction cannot exceed the remaining of one account, so check salesnavs before launching a large job.

Example: 2250
Default: 0
has_valid_salesnav
​boolean

Whether at least one usable Sales Navigator account is connected. When false no extraction can be launched, whatever your credit balance: connect an account with the Evaboot Chrome extension first.

Example: true
Default: false
credits
​number

Credits available to spend on API operations. Extractions and found emails cost 1 credit each; email validation costs 0.5 credits per address, rounded up per request.

Example: 1500
Default: 0
​SalesNavInfo[]

Every Sales Navigator account connected to your Evaboot account, valid or not, with its own daily limit and usage.

Default: []

QuotaOut

​QuotaInfo · required

Your current daily extraction quota and credit balance.

success
​boolean

true when the quota was read successfully.

Example: true
Default: true

SalesNavInfo

id
​string · required

Identifier of the connected Sales Navigator account.

Example: 7f4c1e2a-9b3d-4a51-8c6e-2f0d5b7a1c34
status
​string · required

Whether this Sales Navigator account can currently be used to extract: valid when its session is still good, invalid when it needs to be reconnected from the Chrome extension. An invalid account contributes nothing to your daily limit.

Example: valid
daily_limit
​integer

Profiles this Sales Navigator account may extract per day. 0 when the account is invalid.

Example: 2500
Default: 0
used_today
​integer

Profiles already extracted on this Sales Navigator account in the last 24 hours.

Example: 250
Default: 0
remaining
​integer

Profiles this Sales Navigator account can still extract in the next launch, before its daily limit is reached.

Example: 2250
Default: 0

SearchBuilderOut

url
​string · required

The generated Sales Navigator search URL. Open it in Sales Navigator to review the results, or send it to the URL extraction endpoint to extract the leads it matches.

Example: https://www.linkedin.com/sales/search/people?query=(filters%3AList((type%3ASENIORITY_LEVEL%2Cvalues%3AList((id%3A310%2Ctext%3ACXO%2CselectionType%3AINCLUDED)))))
​object · required

Summary of the filters that were applied, so you can check the description was understood before running an extraction. Keyed by filter type, each value a list of the labels Sales Navigator shows; excluded values are prefixed with NOT , and a keywords key appears when free-text keywords were used.

Example: {"COMPANY_HEADCOUNT":["51-200"],"INDUSTRY":["Software Development"],"REGION":["United States"],"SENIORITY_LEVEL":["CXO"]}
success
​boolean

Always true on a successful response. Failed requests return an error object instead.

Example: true
Default: true

SearchBuilderIn

description
​string · minLength: 10 · maxLength: 2000 · required

Plain-language description of the leads or accounts you want to find. Mention everything that matters (job titles, seniority, industry, company size, location, revenue) and it is mapped onto the matching Sales Navigator filters. Between 10 and 2000 characters.

Example: CTOs and VPs of Engineering at SaaS companies in the US with 50-200 employees
search_type
​string · enum

Which Sales Navigator search to build: "LEAD" for a people search, "ACCOUNT" for a company search.

Enum values:
LEAD
ACCOUNT
Example: LEAD
Default: LEAD
On this page
  • ExtractionCreateOut
  • UrlExtractionCreateIn
  • SingleExtractionOut
  • SingleExtractionCreateIn
  • ProfileExtractionCreateIn
  • ExtractionListItemOut
  • ExtractionDetailOut
  • ExtractionInProgressOut
  • EmailFinderJobAcceptedOut
  • EmailFinderJobIn
  • EmailFinderProspectIn
  • EmailFinderJobOut
  • EmailFinderProspectOut
  • EmailFinderOut
  • EmailFinderIn
  • EmailFinderJobInProgressOut
  • EmailValidationJobAcceptedOut
  • EmailValidationJobIn
  • EmailValidationProspectIn
  • EmailValidationJobOut
  • EmailValidationJobProspectOut
  • EmailValidationOut
  • EmailValidationProspectOut
  • EmailValidationIn
  • EmailValidationJobInProgressOut
  • QuotaInfo
  • QuotaOut
  • SalesNavInfo
  • SearchBuilderOut
  • SearchBuilderIn