Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

meGet

account.meGet Get Current User. Credit cost: none. Risk: read
Input Output

Billing

creditsGet

billing.creditsGet Get Credit Balances. Credit cost: none. Risk: read
Input Output

subscriptionGet

billing.subscriptionGet Get Subscription. Credit cost: none. Risk: read
Input Output

usageSummaryGet

billing.usageSummaryGet Get Usage Summary. Credit cost: none. Risk: read
Input
Output

Blocklist

companiesAdd

blocklist.companiesAdd Block Companies. Credit cost: none. Risk: write
Input
Output

companiesDelete

blocklist.companiesDelete Unblock Company. Credit cost: none. Risk: destructive
Input
Output

companiesList

blocklist.companiesList List Blocked Companies. Credit cost: none. Risk: read
Input
Output

peopleAdd

blocklist.peopleAdd Block People. Credit cost: none. Risk: write
Input
Output

peopleDelete

blocklist.peopleDelete Unblock Person. Credit cost: none. Risk: destructive
Input
Output

peopleList

blocklist.peopleList List Blocked People. Credit cost: none. Risk: read
Input
Output

Companies

bulkEnrich

companies.bulkEnrich Companies Bulk Enrich. Credit cost: none. Risk: read
Input
Output

editsUpdate

companies.editsUpdate Edit Saved Company. Credit cost: none. Risk: write
Input
Output

enrich

companies.enrich Companies Enrich. Credit cost: none. Risk: read
Input
Output

get

companies.get Companies Get. Credit cost: none. Risk: read
Input
Output

save

companies.save Companies Save. Credit cost: none. Risk: write
Input
Output
companies.search Companies Search. Credit cost: none. Risk: read
Input
Output

Developer

apiLogsList

developer.apiLogsList List Request Logs. Credit cost: none. Risk: read
Input
Output

rateLimitsGet

developer.rateLimitsGet Get Rate Limits. Credit cost: none. Risk: read
Input Output

Email

find

email.find Find Email. Credit cost: served_address (a valid address is served that the workspace does not already own (the email of a revealed or saved person, and an address charged before, are free)). Risk: read
Input Credit-aware operation: served_address; a valid address is served that the workspace does not already own (the email of a revealed or saved person, and an address charged before, are free). Check the workspace balance and the provider response before repeating the request. This synchronous endpoint can take up to 95 seconds; the client uses the documented timeout.
Output

findGet

email.findGet Find Email (GET). Credit cost: served_address (a valid address is served that the workspace does not already own (the email of a revealed or saved person, and an address charged before, are free)). Risk: read
Input Credit-aware operation: served_address; a valid address is served that the workspace does not already own (the email of a revealed or saved person, and an address charged before, are free). Check the workspace balance and the provider response before repeating the request.
Output

verificationsCancel

email.verificationsCancel Cancel Email Verification. Credit cost: none. Risk: destructive
Input
Output

verificationsCreate

email.verificationsCreate Create Email Verification. Credit cost: billable_row (when a data.emails job starts on its own after counting, for counts.billable; unknown rows and rows never verified are refunded when the job ends (a file_key job charges at email_verifications_start)). Risk: destructive
Input Credit-aware operation: billable_row; when a data.emails job starts on its own after counting, for counts.billable; unknown rows and rows never verified are refunded when the job ends (a file_key job charges at email_verifications_start). Check the workspace balance and the provider response before repeating the request.
Output

verificationsGet

email.verificationsGet Get Email Verification. Credit cost: none. Risk: read
Input
Output

verificationsHistoryList

email.verificationsHistoryList List Verification History. Credit cost: none. Risk: read
Input
Output

verificationsInspect

email.verificationsInspect Inspect Email File. Credit cost: none. Risk: read
Input
Output

verificationsList

email.verificationsList List Email Verifications. Credit cost: none. Risk: read
Input
Output

verificationsResults

email.verificationsResults Get Email Verification Results. Credit cost: none. Risk: read
Input
Output

verificationsStart

email.verificationsStart Start Email Verification. Credit cost: billable_row (at start, for counts.billable; unknown rows and rows never verified are refunded when the job ends). Risk: destructive
Input Credit-aware operation: billable_row; at start, for counts.billable; unknown rows and rows never verified are refunded when the job ends. Check the workspace balance and the provider response before repeating the request.
Output

verify

email.verify Verify Email. Credit cost: address (a valid, invalid or accept_all verdict, once per address per workspace). Risk: read
Input Credit-aware operation: address; a valid, invalid or accept_all verdict, once per address per workspace. Check the workspace balance and the provider response before repeating the request. The provider documents a lookup timeout of up to 80 seconds; wallet charges apply only to billable verdicts.
Output

verifyGet

email.verifyGet Verify Email (GET). Credit cost: address (a valid, invalid or accept_all verdict, once per address per workspace). Risk: read
Input Credit-aware operation: address; a valid, invalid or accept_all verdict, once per address per workspace. Check the workspace balance and the provider response before repeating the request.
Output

Enrichments

cancel

enrichments.cancel Cancel Enrichment. Credit cost: none. Risk: destructive
Input
Output

companiesEnrichmentsCreate

enrichments.companiesEnrichmentsCreate Create Companies Enrichment. Credit cost: none. Risk: write
Input
Output

get

enrichments.get Get Enrichment. Credit cost: none. Risk: read
Input
Output

list

enrichments.list List Enrichments. Credit cost: none. Risk: read
Input
Output

peopleEnrichmentsCreate

enrichments.peopleEnrichmentsCreate Create People Enrichment. Credit cost: revealed profile not already owned / address found / mobile number found (during the job). Risk: destructive
Input Credit-aware operation: revealed profile not already owned / address found / mobile number found; during the job. Check the workspace balance and the provider response before repeating the request.
Output

results

enrichments.results Get Enrichment Results. Credit cost: none. Risk: read
Input
Output

Enums

get

enums.get Get Filter Enum. Credit cost: none. Risk: read
Input
Output

list

enums.list List Filter Enums. Credit cost: none. Risk: read
Input Output

Exports

companiesExport

exports.companiesExport Export Companies. Credit cost: none. Risk: write
Input
Output

get

exports.get Get an Export. Credit cost: none. Risk: read
Input
Output

peopleExport

exports.peopleExport Export People. Credit cost: revealed profile not already owned (per chunk during the run, against the balance read at that chunk; emails past it are withheld). Risk: destructive
Input Credit-aware operation: revealed profile not already owned; per chunk during the run, against the balance read at that chunk; emails past it are withheld. Check the workspace balance and the provider response before repeating the request.
Output

Jobs

get

jobs.get Get a Job. Credit cost: none. Risk: read
Input
Output

Lists

companiesListsRemove

lists.companiesListsRemove Remove Companies from List. Credit cost: none. Risk: write
Input
Output

companiesListsSet

lists.companiesListsSet Set Company Lists. Credit cost: none. Risk: destructive
Input
Output

create

lists.create Create List. Credit cost: none. Risk: write
Input
Output

delete

lists.delete Delete List. Credit cost: none. Risk: destructive
Input
Output

get

lists.get Get List. Credit cost: none. Risk: read
Input
Output

list

lists.list List Lists. Credit cost: none. Risk: read
Input
Output

peopleListsAdd

lists.peopleListsAdd Add People to List. Credit cost: none. Risk: write
Input
Output

peopleListsRemove

lists.peopleListsRemove Remove People from List. Credit cost: none. Risk: write
Input
Output

peopleListsSet

lists.peopleListsSet Set People Lists. Credit cost: none. Risk: destructive
Input
Output

update

lists.update Rename List. Credit cost: none. Risk: write
Input
Output

Notifications

list

notifications.list List Notifications. Credit cost: none. Risk: read
Input
Output

markRead

notifications.markRead Mark Notifications Read. Credit cost: none. Risk: write
Input
Output

People

bulkEnrich

people.bulkEnrich People Bulk Enrich. Credit cost: newly revealed email; phone number found (enrich_email (on by default) / enrich_phone, per item). Risk: read
Input Credit-aware operation: newly revealed email; phone number found; enrich_email (on by default) / enrich_phone, per item. Check the workspace balance and the provider response before repeating the request.
Output

calculateCredits

people.calculateCredits Preview Save Credits. Credit cost: none. Risk: read
Input
Output

count

people.count People Count. Credit cost: none. Risk: read
Input
Output

editsUpdate

people.editsUpdate Edit a Saved Person. Credit cost: none. Risk: write
Input
Output

enrich

people.enrich People Enrich. Credit cost: newly revealed email; phone number found (enrich_email (on by default) / enrich_phone). Risk: read
Input Credit-aware operation: newly revealed email; phone number found; enrich_email (on by default) / enrich_phone. Check the workspace balance and the provider response before repeating the request. This synchronous endpoint can take up to 95 seconds; a searching email result can be polled by calling the endpoint again after retry_after.
Output

enrichSearch

people.enrichSearch Enrich Mobiles for a Search. Credit cost: phone number found (always, until the balance runs out). Risk: destructive
Input Credit-aware operation: phone number found; always, until the balance runs out. Check the workspace balance and the provider response before repeating the request.
Output

get

people.get Get a Person. Credit cost: none. Risk: read
Input
Output

save

people.save Save People. Credit cost: person whose valid email is handed over and was not already owned (always; a re-save of a person already paid for is free. A person answered searching costs nothing until the refreshed search finds an email and the balance allows it). Risk: destructive
Input Credit-aware operation: person whose valid email is handed over and was not already owned; always; a re-save of a person already paid for is free. A person answered searching costs nothing until the refreshed search finds an email and the balance allows it. Check the workspace balance and the provider response before repeating the request.
Output

saveSearch

people.saveSearch Save a Whole Search. Credit cost: person whose stored valid email is handed over and was not already owned (always, in search order, until the balance runs out). Risk: destructive
Input Credit-aware operation: person whose stored valid email is handed over and was not already owned; always, in search order, until the balance runs out. Check the workspace balance and the provider response before repeating the request.
Output

search

people.search People Search. Credit cost: newly revealed email; phone number found (only with enrich_email / enrich_phone). Risk: read
Input Credit-aware operation: newly revealed email; phone number found; only with enrich_email / enrich_phone. Check the workspace balance and the provider response before repeating the request.
Output

Search

matchingTitles

search.matchingTitles Matching Job Titles. Credit cost: none. Risk: read
Input
Output

smartJobTitles

search.smartJobTitles Smart Job Titles. Credit cost: none. Risk: read
Input
Output

suggest

search.suggest Search Suggestions. Credit cost: none. Risk: read
Input
Output

Trash

companiesAdd

trash.companiesAdd Delete Companies to Trash. Credit cost: none. Risk: destructive
Input
Output

list

trash.list List Trash. Credit cost: none. Risk: read
Input
Output

peopleAdd

trash.peopleAdd Delete People to Trash. Credit cost: none. Risk: destructive
Input
Output

restore

trash.restore Restore from Trash. Credit cost: none. Risk: write
Input
Output