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

Applications

list

applications.list List applications belonging to a pipeline opportunity Risk: read
Input Output

listDeleted

applications.listDeleted List deleted applications Risk: read
Input Output

retrieve

applications.retrieve Retrieve a single application of a pipeline opportunity Risk: read
Input Output

Archive Reasons

list

archiveReasons.list List archive reasons configured for the workspace Risk: read
Input Output

retrieve

archiveReasons.retrieve Retrieve a single archive reason by ID Risk: read
Input Output

Audit Events

list

auditEvents.list List workspace audit events Risk: read
Input Output

Contacts

retrieve

contacts.retrieve Retrieve a single contact by ID Risk: read
Input Output

update

contacts.update Update a contact Risk: write
Input
Output

Disposition Stages

list

dispositionStages.list List disposition stages configured for the workspace Risk: read
Input: empty object Output

Eeo

retrieveAnonymous

eeo.retrieveAnonymous Retrieve anonymized EEO responses Risk: read
Input Output

retrieveWithPii

eeo.retrieveWithPii Retrieve EEO responses including personally identifiable information Risk: read
Input Output

Feedback

create

feedback.create Submit a feedback form for a pipeline opportunity Risk: write
Input
Output: object

delete

feedback.delete Delete a feedback form from a pipeline opportunity Risk: destructive
Input Output: object \| undefined

list

feedback.list List feedback forms on a pipeline opportunity Risk: read
Input Output

retrieve

feedback.retrieve Retrieve a single feedback form by ID Risk: read
Input Output

update

feedback.update Update a feedback form on a pipeline opportunity Risk: write
Input
Output

Feedback Templates

create

feedbackTemplates.create Create a feedback template for the workspace Risk: write
Input
Output

delete

feedbackTemplates.delete Delete a feedback template Risk: destructive
Input Output: object \| undefined

list

feedbackTemplates.list List feedback templates configured for the workspace Risk: read
Input Output

retrieve

feedbackTemplates.retrieve Retrieve a single feedback template by ID Risk: read
Input Output

update

feedbackTemplates.update Update a feedback template Risk: write
Input
Output

Files

delete

files.delete Delete a file from a pipeline opportunity Risk: destructive
Input Output: object \| undefined

download

files.download Download the raw bytes of an opportunity file Risk: read
Input Output

list

files.list List files attached to a pipeline opportunity Risk: read
Input Output

retrieve

files.retrieve Retrieve a single file attached to a pipeline opportunity Risk: read
Input Output

Forms

create

forms.create Submit a form for a pipeline opportunity Risk: write
Input
Output: object

list

forms.list List form submissions on a pipeline opportunity Risk: read
Input Output

retrieve

forms.retrieve Retrieve a single form submission by ID Risk: read
Input Output

Form Templates

create

formTemplates.create Create a form template for the workspace Risk: write
Input
Output

delete

formTemplates.delete Delete a form template Risk: destructive
Input Output: object \| undefined

list

formTemplates.list List form templates configured for the workspace Risk: read
Input Output

retrieve

formTemplates.retrieve Retrieve a single form template by ID Risk: read
Input Output

update

formTemplates.update Update a form template Risk: write
Input
Output

Interviews

create

interviews.create Schedule an interview for a pipeline opportunity Risk: write
Input
Output

delete

interviews.delete Delete a scheduled interview Risk: destructive
Input Output: object \| undefined

list

interviews.list List interviews scheduled for a pipeline opportunity Risk: read
Input Output

retrieve

interviews.retrieve Retrieve a single interview by ID Risk: read
Input Output

update

interviews.update Update a scheduled interview Risk: write
Input
Output

Notes

create

notes.create Add a note to a pipeline opportunity Risk: write
Input Output

delete

notes.delete Delete a note from a pipeline opportunity Risk: destructive
Input Output: object \| undefined

list

notes.list List notes on a pipeline opportunity Risk: read
Input Output

retrieve

notes.retrieve Retrieve a single note on a pipeline opportunity Risk: read
Input Output

update

notes.update Update a note on a pipeline opportunity Risk: write
Input
Output

Offers

download

offers.download Download the raw bytes of an offer file Risk: read
Input Output

list

offers.list List offers for a pipeline opportunity Risk: read
Input Output

Opportunities

opportunities.addLinks Add web links (LinkedIn, portfolio) to an opportunity’s contact Risk: write
Input Output: object \| undefined

addSources

opportunities.addSources Add sourcing sources to a pipeline opportunity Risk: write
Input Output: object \| undefined

addTags

opportunities.addTags Add tags to a pipeline opportunity Risk: write
Input Output: object \| undefined

create

opportunities.create Create a pipeline opportunity for a candidate profile Risk: write
Input
Output

list

opportunities.list List pipeline opportunities with filters and pagination Risk: read
Input Output

listDeleted

opportunities.listDeleted List deleted pipeline opportunities Risk: read
Input Output

listFileActions

opportunities.listFileActions List file actions recorded for a pipeline opportunity Risk: read
Input Output

opportunities.removeLinks Remove web links from an opportunity’s contact Risk: write
Input Output: object \| undefined

removeSources

opportunities.removeSources Remove sourcing sources from a pipeline opportunity Risk: write
Input Output: object \| undefined

removeTags

opportunities.removeTags Remove tags from a pipeline opportunity Risk: write
Input Output: object \| undefined

retrieve

opportunities.retrieve Retrieve a single pipeline opportunity by ID Risk: read
Input Output

updateArchivedState

opportunities.updateArchivedState Archive or unarchive a pipeline opportunity Risk: write
Input Output

updateStage

opportunities.updateStage Move a pipeline opportunity to a different hiring stage Risk: write
Input Output

Panels

create

panels.create Create an interview panel for a pipeline opportunity Risk: write
Input
Output

delete

panels.delete Delete an interview panel Risk: destructive
Input Output: object \| undefined

list

panels.list List interview panels for a pipeline opportunity Risk: read
Input Output

retrieve

panels.retrieve Retrieve a single interview panel by ID Risk: read
Input Output

update

panels.update Update an interview panel Risk: write
Input
Output

Postings

apply

postings.apply Submit an application to a job posting Risk: write
Input
Output

create

postings.create Create a job posting Risk: write
Input
Output

list

postings.list List job postings Risk: read
Input Output

listDeleted

postings.listDeleted List deleted job postings Risk: read
Input Output

listUsers

postings.listUsers List users with access to a job posting Risk: read
Input Output: object

retrieve

postings.retrieve Retrieve a single job posting by ID Risk: read
Input Output

retrieveApplicationQuestions

postings.retrieveApplicationQuestions Retrieve the application questions configured for a posting Risk: read
Input Output

update

postings.update Update an existing job posting Risk: write
Input
Output

Referrals

list

referrals.list List referrals on a pipeline opportunity Risk: read
Input Output

retrieve

referrals.retrieve Retrieve a single referral by ID Risk: read
Input Output

Requisition Fields

addOptions

requisitionFields.addOptions Add dropdown options to a requisition field Risk: write
Input
Output

create

requisitionFields.create Create a requisition field for the workspace Risk: write
Input
Output

delete

requisitionFields.delete Delete a requisition field Risk: destructive
Input Output: object \| undefined

deleteOptions

requisitionFields.deleteOptions Remove dropdown option values from a requisition field Risk: destructive · Irreversible
Input Output: object \| undefined

list

requisitionFields.list List requisition fields configured for the workspace Risk: read
Input Output

replaceOptions

requisitionFields.replaceOptions Replace the dropdown options of a requisition field Risk: destructive
Input
Output

retrieve

requisitionFields.retrieve Retrieve a single requisition field by ID Risk: read
Input Output

update

requisitionFields.update Update a requisition field Risk: write
Input
Output

Requisitions

create

requisitions.create Create a requisition Risk: write
Input
Output

delete

requisitions.delete Delete a requisition Risk: destructive
Input Output: object \| undefined

list

requisitions.list List requisitions Risk: read
Input Output

retrieve

requisitions.retrieve Retrieve a single requisition by ID Risk: read
Input Output

update

requisitions.update Update a requisition Risk: write
Input
Output

Resumes

download

resumes.download Download the raw bytes of an opportunity resume Risk: read
Input Output

list

resumes.list List resumes attached to a pipeline opportunity Risk: read
Input Output

retrieve

resumes.retrieve Retrieve a single resume by ID Risk: read
Input Output

Sources

list

sources.list List sourcing sources configured for the workspace Risk: read
Input: empty object Output

Stages

list

stages.list List hiring stages configured for the workspace Risk: read
Input Output

retrieve

stages.retrieve Retrieve a single hiring stage by ID Risk: read
Input Output

Surveys

retrieveDiversity

surveys.retrieveDiversity Retrieve the diversity survey for a job posting Risk: read
Input Output

Tags

list

tags.list List tags configured for the workspace Risk: read
Input: empty object Output

Users

create

users.create Create a workspace user Risk: write
Input Output

deactivate

users.deactivate Deactivate a workspace user Risk: write
Input Output

list

users.list List workspace users Risk: read
Input Output

reactivate

users.reactivate Reactivate a workspace user Risk: write
Input Output

retrieve

users.retrieve Retrieve a single workspace user by ID Risk: read
Input Output

update

users.update Update a workspace user Risk: write
Input Output

Webhooks

create

webhooks.create Register a webhook Risk: write
Input
Output

delete

webhooks.delete Delete a registered webhook Risk: destructive
Input Output: object \| undefined

list

webhooks.list List registered webhooks Risk: read
Input: empty object Output

update

webhooks.update Update a registered webhook Risk: write
Input
Output