Skip to main content
Every capsulecrm.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.

Activity Types

get

activityTypes.get Get an activity type by ID Risk: read
Input Output: empty object

list

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

listIcons

activityTypes.listIcons List activity type icons Risk: read
Input: empty object Output: empty object

Attachments

get

attachments.get Download an attachment by ID Risk: read
Input Output

upload

attachments.upload Upload an attachment and receive a token Risk: write
Input Output

Boards

delete

boards.delete Delete (archive) a board Risk: destructive · Irreversible
Input Output

get

boards.get Get a board by ID Risk: read
Input Output: empty object

list

boards.list List boards Risk: read
Input Output: empty object

listStages

boards.listStages List stages on a board Risk: read
Input Output: empty object

restore

boards.restore Restore a deleted board Risk: write
Input Output

update

boards.update Update a board Risk: write
Input Output: empty object

Categories

create

categories.create Create a task category Risk: write
Input: empty object Output: empty object

delete

categories.delete Delete a category Risk: destructive · Irreversible
Input Output

get

categories.get Get a category by ID Risk: read
Input Output: empty object

list

categories.list List task categories Risk: read
Input Output: empty object

update

categories.update Update a category Risk: write
Input Output: empty object

Countries

list

countries.list List countries Risk: read
Input: empty object Output: empty object

Currencies

list

currencies.list List currencies Risk: read
Input: empty object Output: empty object

Custom Fields

create

customFields.create Create a custom field definition Risk: write
Input Output: empty object

delete

customFields.delete Delete a custom field definition Risk: destructive · Irreversible
Input Output

get

customFields.get Get a custom field definition Risk: read
Input Output: empty object

list

customFields.list List custom field definitions for an entity type Risk: read
Input Output: empty object

update

customFields.update Update a custom field definition Risk: write
Input Output: empty object

Entries

create

entries.create Create a note entry Risk: write
Input Output: empty object

delete

entries.delete Delete an entry Risk: destructive · Irreversible
Input Output

get

entries.get Get an entry by ID Risk: read
Input Output: empty object

listByDate

entries.listByDate List notes, emails, and completed tasks by date Risk: read
Input Output: empty object

listForEntity

entries.listForEntity List entries for a party, opportunity, or project Risk: read
Input Output: empty object

update

entries.update Update a note or email entry Risk: write
Input Output: empty object

Filters

run

filters.run Run a structured filter query Risk: read
Input
Output: empty object

Goals

list

goals.list List goals Risk: read
Input Output: empty object

Lost Reasons

create

lostReasons.create Create a lost reason Risk: write
Input: empty object Output: empty object

delete

lostReasons.delete Delete a lost reason Risk: destructive · Irreversible
Input Output

get

lostReasons.get Get a lost reason by ID Risk: read
Input Output: empty object

list

lostReasons.list List lost reasons Risk: read
Input Output: empty object

update

lostReasons.update Update a lost reason Risk: write
Input Output: empty object

Milestones

create

milestones.create Create a milestone Risk: write
Input: empty object Output: empty object

delete

milestones.delete Delete a milestone Risk: destructive · Irreversible
Input Output

get

milestones.get Get a milestone by ID Risk: read
Input Output: empty object

list

milestones.list List milestones Risk: read
Input Output: empty object

update

milestones.update Update a milestone Risk: write
Input Output: empty object

Opportunities

addParty

opportunities.addParty Add a party to an opportunity Risk: write
Input Output

create

opportunities.create Create an opportunity Risk: write
Input: empty object Output: empty object

delete

opportunities.delete Delete an opportunity Risk: destructive · Irreversible
Input Output

deleteParty

opportunities.deleteParty Remove a party from an opportunity Risk: write
Input Output

get

opportunities.get Get an opportunity by ID Risk: read
Input Output: empty object

list

opportunities.list List opportunities Risk: read
Input Output: empty object

listDeleted

opportunities.listDeleted List deleted or restricted opportunities Risk: read
Input Output: empty object

listParties

opportunities.listParties List additional parties on an opportunity Risk: read
Input Output: empty object

listProjects

opportunities.listProjects List projects linked to an opportunity Risk: read
Input Output: empty object
opportunities.search Search opportunities by query string Risk: read
Input Output: empty object

update

opportunities.update Update an opportunity Risk: write
Input Output: empty object

Parties

create

parties.create Create a person or organisation Risk: write
Input Output: empty object

delete

parties.delete Delete a party Risk: destructive · Irreversible
Input Output

get

parties.get Get a party by ID Risk: read
Input Output: empty object

list

parties.list List parties (people and organisations) Risk: read
Input Output: empty object

listDeleted

parties.listDeleted List parties deleted since a date Risk: read
Input Output: empty object

listEmployees

parties.listEmployees List employees of an organisation Risk: read
Input Output: empty object

listOpportunities

parties.listOpportunities List opportunities for a party Risk: read
Input Output: empty object

listProjects

parties.listProjects List projects for a party Risk: read
Input Output: empty object

search

parties.search Search parties by query string Risk: read
Input Output: empty object

update

parties.update Update a party Risk: write
Input Output: empty object

Pipelines

get

pipelines.get Get a pipeline by ID Risk: read
Input Output: empty object

list

pipelines.list List sales pipelines Risk: read
Input Output: empty object

listMilestones

pipelines.listMilestones List milestones on a pipeline Risk: read
Input Output: empty object

update

pipelines.update Update a pipeline Risk: write
Input Output: empty object

Projects

addParty

projects.addParty Add a party to a project Risk: write
Input Output

create

projects.create Create a project (case) Risk: write
Input: empty object Output: empty object

delete

projects.delete Delete a project Risk: destructive · Irreversible
Input Output

deleteParty

projects.deleteParty Remove a party from a project Risk: write
Input Output

get

projects.get Get a project by ID Risk: read
Input Output: empty object

list

projects.list List projects (kases) Risk: read
Input Output: empty object

listDeleted

projects.listDeleted List deleted or restricted projects Risk: read
Input Output: empty object

listParties

projects.listParties List parties on a project Risk: read
Input Output: empty object

search

projects.search Search projects by query string Risk: read
Input Output: empty object

update

projects.update Update a project Risk: write
Input Output: empty object

Rest Hooks

list

restHooks.list List REST hook subscriptions Risk: read
Input Output: empty object

Site

get

site.get Get Capsule site (account) details Risk: read
Input: empty object Output: empty object

Stages

create

stages.create Create a board stage Risk: write
Input: empty object Output: empty object

delete

stages.delete Delete a stage Risk: destructive · Irreversible
Input Output

get

stages.get Get a stage by ID Risk: read
Input Output: empty object

list

stages.list List stages across boards Risk: read
Input Output: empty object

update

stages.update Update a stage Risk: write
Input Output: empty object

Tags

delete

tags.delete Delete a tag Risk: destructive · Irreversible
Input Output

get

tags.get Get a tag by ID Risk: read
Input Output: empty object

list

tags.list List tags for an entity type Risk: read
Input Output: empty object

update

tags.update Update a tag name Risk: write
Input Output: empty object

Tasks

create

tasks.create Create a task Risk: write
Input: empty object Output: empty object

delete

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

get

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

list

tasks.list List tasks Risk: read
Input Output: empty object

update

tasks.update Update a task Risk: write
Input Output: empty object

Teams

list

teams.list List teams Risk: read
Input Output: empty object

Titles

create

titles.create Create a custom person title Risk: write
Input: empty object Output: empty object

delete

titles.delete Delete a title Risk: destructive · Irreversible
Input Output

list

titles.list List custom person titles Risk: read
Input Output: empty object

Track Definitions

create

trackDefinitions.create Create a track definition Risk: write
Input: empty object Output: empty object

delete

trackDefinitions.delete Delete a track definition Risk: destructive · Irreversible
Input Output

get

trackDefinitions.get Get a track definition by ID Risk: read
Input Output: empty object

list

trackDefinitions.list List track definitions Risk: read
Input Output: empty object

update

trackDefinitions.update Update a track definition Risk: write
Input Output: empty object

Tracks

create

tracks.create Apply a track definition to an entity Risk: write
Input Output: empty object

delete

tracks.delete Delete a track Risk: destructive · Irreversible
Input Output

get

tracks.get Get a track by ID Risk: read
Input Output: empty object

listForEntity

tracks.listForEntity List tracks on an opportunity or project Risk: read
Input Output: empty object

update

tracks.update Update a track description or date Risk: write
Input Output: empty object

Users

get

users.get Get a user by ID Risk: read
Input Output: empty object

getCurrent

users.getCurrent Get the current authenticated user Risk: read
Input Output: empty object

list

users.list List users Risk: read
Input Output: empty object

update

users.update Update user preferences Risk: write
Input Output: empty object