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

Companies

autocomplete

companies.autocomplete Search companies by text for autocomplete Risk: read
Input Output: object[]

create

companies.create Create a company Risk: write
Input checkForDuplicates asks the API to detect and report possible duplicates. Output

delete

companies.delete Delete a company Risk: destructive
Input Output: any

get

companies.get Read one company Risk: read
Input Output

list

companies.list List companies with conditions filters and paging Risk: read
Input Output

listPeople

companies.listPeople List the people of a company Risk: read
Input Output

update

companies.update Update a company Risk: write
Input Output

Deals

create

deals.create Create a deal Risk: write
Input probability 0 or 100 closes the deal; setting 1-99 on a closed deal reopens it. companyName creates and links a company when no id matches. Output

delete

deals.delete Delete a deal Risk: destructive
Input Output: any

get

deals.get Read one deal Risk: read
Input Output

list

deals.list List deals with conditions filters and paging Risk: read
Input conditions keys are the documented DealConditions (deal_stage, deal_owner, deal_value ranges, date selections); the API ignores unknown keys. Output

listNotes

deals.listNotes List the activities of a deal Risk: read
Input Output

totalsByStage

deals.totalsByStage Deal count and value per stage Risk: read
Input: empty object Output: object[]

update

deals.update Update a deal Risk: write
Input Output

Notes

create

notes.create Create an activity on a record Risk: write
Input Output

delete

notes.delete Delete an activity Risk: destructive
Input Output: any

get

notes.get Read one activity Risk: read
Input Output

list

notes.list List activities filtered by deal, company or person Risk: read
Input conditions must carry one of conditions[deal_id], conditions[company_id] or conditions[person_id]. Output

update

notes.update Update an activity Risk: write
Input Output

People

autocomplete

people.autocomplete Search people by text for autocomplete Risk: read
Input Output: object[]

create

people.create Create a person Risk: write
Input fullName splits on whitespace into first_name and last_name; companyName creates and links a company when none matches. Output

delete

people.delete Delete a person Risk: destructive
Input Output: any

get

people.get Read one person Risk: read
Input Output

list

people.list List people with conditions filters and paging Risk: read
Input Output

listDeals

people.listDeals List the deals of a person Risk: read
Input Output

listNotes

people.listNotes List the activities of a person Risk: read
Input Output

update

people.update Update a person Risk: write
Input Output

Users

get

users.get Read one visible user Risk: read
Input Output

list

users.list List the visible users Risk: read
Input Returns the users this credential can see; admin-only views live under /admin/users. Output