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

Accounts

create

accounts.create Create an account Risk: write
Input
Output: object

createCustomField

accounts.createCustomField Create a custom field Risk: write
Input
Output

customFieldAttributes

accounts.customFieldAttributes Get a list of custom fields Risk: read
Input: empty object Output

customfields

accounts.customfields Get custom fields Risk: read
Input Output

delete

accounts.delete Delete an account Risk: destructive
Input Output

get

accounts.get Get an account Risk: read
Input Output

list

accounts.list Get a list of accounts Risk: read
Input
Output

listFields

accounts.listFields Get the fields for an account Risk: read
Input: empty object Output

listItems

accounts.listItems Get list items for all accounts Risk: read
Input
Output

undelete

accounts.undelete Undelete an account Risk: write
Input Output: object

update

accounts.update Update an account Risk: write
Input
Output: undefined

Account Types

list

accountTypes.list Get a list of account types Risk: read
Input: empty object Output

Activities

create

activities.create Create an activity Risk: write
Input
Output: object

get

activities.get Get an activity Risk: read
Input Output: object

list

activities.list Get activities Risk: read
Input Output: object

update

activities.update Update an activity Risk: write
Input
Output: object

Activity Types

list

activityTypes.list Get activity types Risk: read
Input: empty object Output

Audiences

create

audiences.create Create an audience Risk: write
Input
Output

list

audiences.list Get a list of audiences Risk: read
Input: empty object Output

Competitor Maps

delete

competitorMaps.delete Delete a lead-competitor relationship Risk: destructive · Irreversible
Input Output: undefined

get

competitorMaps.get Get a lead-competitor relationship Risk: read
Input Output

list

competitorMaps.list Get a list of lead-competitor relationships Risk: read
Input: empty object Output

update

competitorMaps.update Update a lead-competitor relationship Risk: write
Input
Output: undefined

Competitors

get

competitors.get Get a competitor Risk: read
Input Output

list

competitors.list Get a list of competitors Risk: read
Input Output

Contacts

create

contacts.create Create a contact Risk: write
Input
Output

createCustomField

contacts.createCustomField Create a custom field Risk: write
Input
Output

customFieldAttributes

contacts.customFieldAttributes Get applicable custom fields Risk: read
Input: empty object Output

customfields

contacts.customfields Get contact custom fields Risk: read
Input Output

delete

contacts.delete Delete a contact Risk: destructive
Input Output

get

contacts.get Get a contact Risk: read
Input Output

list

contacts.list Get a list of contacts Risk: read
Input
Output

listFields

contacts.listFields Get the fields for a contact Risk: read
Input: empty object Output

listItems

contacts.listItems Get list items for all contacts Risk: read
Input
Output

undelete

contacts.undelete Undelete a contact Risk: write
Input Output

update

contacts.update Update a contact Risk: write
Input
Output

Dashboards

listFields

dashboards.listFields Get dashboard field definitions Risk: read
Input: empty object Output

Editions

get

editions.get Get a single edition by its ID Risk: read
Input Output

list

editions.list Get a list of editions Risk: read
Input: empty object Output

Emails

get

emails.get Get an email Risk: read
Input Output

Events

deleted

events.deleted Get deletion events Risk: read
Input Output

list

events.list Get a list of events Risk: read
Input Output

Filters

list

filters.list Get saved filters Risk: read
Input Output

Forms

get

forms.get Get a form Risk: read
Input Output: object

getFieldId

forms.getFieldId Get a form field Risk: read
Input Output

list

forms.list Get all forms Risk: read
Input: empty object Output

Industries

get

industries.get Get a single industry by its ID Risk: read
Input Output

list

industries.list Get a list of industries Risk: read
Input: empty object Output

Invoices

get

invoices.get Get an invoice Risk: read
Input Output

list

invoices.list Get a list of invoices Risk: read
Input Output

status

invoices.status Update the status of an invoice Risk: write
Input
Output

Leads

create

leads.create Create a lead Risk: write
Input
Output: object

createCustomField

leads.createCustomField Create a custom field Risk: write
Input
Output

customFieldAttributes

leads.customFieldAttributes Get applicable custom fields for leads Risk: read
Input: empty object Output

customfields

leads.customfields Get a lead’s custom fields Risk: read
Input Output

delete

leads.delete Delete a lead Risk: destructive
Input Output: object

get

leads.get Get a lead Risk: read
Input Output

installments

leads.installments Get installments for a lead Risk: read
Input Output

list

leads.list Get a list of leads Risk: read
Input
Output

listFields

leads.listFields Get the fields for a lead Risk: read
Input: empty object Output

listItems

leads.listItems Get list items for all leads Risk: read
Input
Output

postStageset

leads.postStageset Set the pipeline for a lead Risk: write
Input
Output: object

reopen

leads.reopen Reopen a lead Risk: write
Input Output: object

report

leads.report Get reports for a lead Risk: read
Input Output: object \| string

stages

leads.stages Get all stages associated with lead Risk: read
Input Output

status

leads.status Update the status of a lead Risk: write
Input
Output: object

undelete

leads.undelete Undelete a lead Risk: write
Input Output: object

update

leads.update Update a lead Risk: write
Input
Output: undefined

updateInstallments

leads.updateInstallments Replace a lead’s installment schedule Risk: destructive
Input
Output

watch

leads.watch Watch a lead Risk: write
Input Output: object

Markets

get

markets.get Get a market by the ID Risk: read
Input Output

list

markets.list Get a list of markets Risk: read
Input: empty object Output

Notes

create

notes.create Create a note Risk: write
Input
Output: object

delete

notes.delete Delete a note Risk: destructive
Input Output: object

get

notes.get Get a note Risk: read
Input Output: object

list

notes.list Get a list of notes Risk: read
Input Output: object

undelete

notes.undelete Undelete a note Risk: write
Input Output: object

Outcomes

get

outcomes.get Get a lead outcome by ID Risk: read
Input Output

list

outcomes.list Get a list of lead outcomes Risk: read
Input: empty object Output

Product Categories

create

productCategories.create Create a product category Risk: write
Input
Output

get

productCategories.get Get a product category Risk: read
Input Output

list

productCategories.list List all product categories Risk: read
Input: empty object Output

Product Maps

delete

productMaps.delete Delete a product on a lead Risk: destructive · Irreversible
Input Output

get

productMaps.get Get lead product Risk: read
Input Output

list

productMaps.list Get lead products Risk: read
Input: empty object Output

update

productMaps.update Update a lead’s product information Risk: write
Input
Output: undefined

Products

delete

products.delete Delete a product Risk: destructive
Input Output

get

products.get Get a product Risk: read
Input Output

list

products.list List or search products Risk: read
Input Output

undelete

products.undelete Undelete a product Risk: write
Input Output

Quotes

createInvoice

quotes.createInvoice Create an invoice from a quote Risk: write
Input Output

get

quotes.get Get a quote Risk: read
Input Output

list

quotes.list Get a list of quotes Risk: read
Input Output

status

quotes.status Update the status of a quote Risk: write
Input
Output

Sources

create

sources.create Create a new source Risk: write
Input
Output

delete

sources.delete Delete a Source Risk: destructive
Input Output

list

sources.list Get a list of sources Risk: read
Input Output

undelete

sources.undelete Undelete a Source Risk: write
Input Output

Stages

list

stages.list Get a list of stages Risk: read
Input: empty object Output

Stage Sets

export

stageSets.export Get a CSV export of lead movements through a pipeline Risk: read
Input Output: string

list

stageSets.list Get a list of pipelines Risk: read
Input: empty object Output

Tags

create

tags.create Create a tag Risk: write
Input
Output

delete

tags.delete Delete a tag Risk: destructive
Input Output

list

tags.list Get a list of tags Risk: read
Input Output

undelete

tags.undelete Undelete a tag Risk: write
Input Output

Tasks

create

tasks.create Create a new task Risk: write
Input
Output

delete

tasks.delete Delete a task Risk: destructive · Irreversible
Input Output: object

get

tasks.get Get a task Risk: read
Input Output: object

list

tasks.list Get a list of tasks Risk: read
Input Output

update

tasks.update Update a task Risk: write
Input
Output

Territories

list

territories.list Get a list of territories Risk: read
Input: empty object Output

Todos

list

todos.list Get tasks and sales process steps Risk: read
Input Output

Users

get

users.get Get a user Risk: read
Input Output

list

users.list Get a list of users Risk: read
Input: empty object Output