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
Output: empty object
list
activityTypes.list
List activity types
Risk: read
Output: empty object
listIcons
activityTypes.listIcons
List activity type icons
Risk: read
Attachments
get
attachments.get
Download an attachment by ID
Risk: read
Output
upload
attachments.upload
Upload an attachment and receive a token
Risk: write
Output
upload full type
upload full type
Boards
delete
boards.delete
Delete (archive) a board
Risk: destructive · Irreversible
Output
get
boards.get
Get a board by ID
Risk: read
Output: empty object
list
boards.list
List boards
Risk: read
Output: empty object
listStages
boards.listStages
List stages on a board
Risk: read
Output: empty object
restore
boards.restore
Restore a deleted board
Risk: write
Output
update
boards.update
Update a board
Risk: write
Output: empty object
Categories
create
categories.create
Create a task category
Risk: write
delete
categories.delete
Delete a category
Risk: destructive · Irreversible
Output
get
categories.get
Get a category by ID
Risk: read
Output: empty object
list
categories.list
List task categories
Risk: read
Output: empty object
update
categories.update
Update a category
Risk: write
Output: empty object
Countries
list
countries.list
List countries
Risk: read
Currencies
list
currencies.list
List currencies
Risk: read
Custom Fields
create
customFields.create
Create a custom field definition
Risk: write
Output: empty object
delete
customFields.delete
Delete a custom field definition
Risk: destructive · Irreversible
Output
get
customFields.get
Get a custom field definition
Risk: read
Output: empty object
list
customFields.list
List custom field definitions for an entity type
Risk: read
Output: empty object
update
customFields.update
Update a custom field definition
Risk: write
Output: empty object
Entries
create
entries.create
Create a note entry
Risk: write
Output: empty object
delete
entries.delete
Delete an entry
Risk: destructive · Irreversible
Output
get
entries.get
Get an entry by ID
Risk: read
Output: empty object
listByDate
entries.listByDate
List notes, emails, and completed tasks by date
Risk: read
Output: empty object
listForEntity
entries.listForEntity
List entries for a party, opportunity, or project
Risk: read
Output: empty object
update
entries.update
Update a note or email entry
Risk: write
Output: empty object
Filters
run
filters.run
Run a structured filter query
Risk: read
conditions full type
conditions full type
Goals
list
goals.list
List goals
Risk: read
Output: empty object
Lost Reasons
create
lostReasons.create
Create a lost reason
Risk: write
delete
lostReasons.delete
Delete a lost reason
Risk: destructive · Irreversible
Output
get
lostReasons.get
Get a lost reason by ID
Risk: read
Output: empty object
list
lostReasons.list
List lost reasons
Risk: read
Output: empty object
update
lostReasons.update
Update a lost reason
Risk: write
Output: empty object
Milestones
create
milestones.create
Create a milestone
Risk: write
delete
milestones.delete
Delete a milestone
Risk: destructive · Irreversible
Output
get
milestones.get
Get a milestone by ID
Risk: read
Output: empty object
list
milestones.list
List milestones
Risk: read
Output: empty object
update
milestones.update
Update a milestone
Risk: write
Output: empty object
Opportunities
addParty
opportunities.addParty
Add a party to an opportunity
Risk: write
Output
create
opportunities.create
Create an opportunity
Risk: write
delete
opportunities.delete
Delete an opportunity
Risk: destructive · Irreversible
Output
deleteParty
opportunities.deleteParty
Remove a party from an opportunity
Risk: write
Output
get
opportunities.get
Get an opportunity by ID
Risk: read
Output: empty object
list
opportunities.list
List opportunities
Risk: read
Output: empty object
listDeleted
opportunities.listDeleted
List deleted or restricted opportunities
Risk: read
Output: empty object
listParties
opportunities.listParties
List additional parties on an opportunity
Risk: read
Output: empty object
listProjects
opportunities.listProjects
List projects linked to an opportunity
Risk: read
Output: empty object
search
opportunities.search
Search opportunities by query string
Risk: read
Output: empty object
update
opportunities.update
Update an opportunity
Risk: write
Output: empty object
Parties
create
parties.create
Create a person or organisation
Risk: write
Output: empty object
delete
parties.delete
Delete a party
Risk: destructive · Irreversible
Output
get
parties.get
Get a party by ID
Risk: read
Output: empty object
list
parties.list
List parties (people and organisations)
Risk: read
Output: empty object
listDeleted
parties.listDeleted
List parties deleted since a date
Risk: read
Output: empty object
listEmployees
parties.listEmployees
List employees of an organisation
Risk: read
Output: empty object
listOpportunities
parties.listOpportunities
List opportunities for a party
Risk: read
Output: empty object
listProjects
parties.listProjects
List projects for a party
Risk: read
Output: empty object
search
parties.search
Search parties by query string
Risk: read
Output: empty object
update
parties.update
Update a party
Risk: write
Output: empty object
Pipelines
get
pipelines.get
Get a pipeline by ID
Risk: read
Output: empty object
list
pipelines.list
List sales pipelines
Risk: read
Output: empty object
listMilestones
pipelines.listMilestones
List milestones on a pipeline
Risk: read
Output: empty object
update
pipelines.update
Update a pipeline
Risk: write
Output: empty object
Projects
addParty
projects.addParty
Add a party to a project
Risk: write
Output
create
projects.create
Create a project (case)
Risk: write
delete
projects.delete
Delete a project
Risk: destructive · Irreversible
Output
deleteParty
projects.deleteParty
Remove a party from a project
Risk: write
Output
get
projects.get
Get a project by ID
Risk: read
Output: empty object
list
projects.list
List projects (kases)
Risk: read
Output: empty object
listDeleted
projects.listDeleted
List deleted or restricted projects
Risk: read
Output: empty object
listParties
projects.listParties
List parties on a project
Risk: read
Output: empty object
search
projects.search
Search projects by query string
Risk: read
Output: empty object
update
projects.update
Update a project
Risk: write
Output: empty object
Rest Hooks
list
restHooks.list
List REST hook subscriptions
Risk: read
Output: empty object
Site
get
site.get
Get Capsule site (account) details
Risk: read
Stages
create
stages.create
Create a board stage
Risk: write
delete
stages.delete
Delete a stage
Risk: destructive · Irreversible
Output
get
stages.get
Get a stage by ID
Risk: read
Output: empty object
list
stages.list
List stages across boards
Risk: read
Output: empty object
update
stages.update
Update a stage
Risk: write
Output: empty object
Tags
delete
tags.delete
Delete a tag
Risk: destructive · Irreversible
Output
get
tags.get
Get a tag by ID
Risk: read
Output: empty object
list
tags.list
List tags for an entity type
Risk: read
Output: empty object
update
tags.update
Update a tag name
Risk: write
Output: empty object
Tasks
create
tasks.create
Create a task
Risk: write
delete
tasks.delete
Delete a task
Risk: destructive · Irreversible
Output
get
tasks.get
Get a task by ID
Risk: read
Output: empty object
list
tasks.list
List tasks
Risk: read
Output: empty object
update
tasks.update
Update a task
Risk: write
Output: empty object
Teams
list
teams.list
List teams
Risk: read
Output: empty object
Titles
create
titles.create
Create a custom person title
Risk: write
delete
titles.delete
Delete a title
Risk: destructive · Irreversible
Output
list
titles.list
List custom person titles
Risk: read
Output: empty object
Track Definitions
create
trackDefinitions.create
Create a track definition
Risk: write
delete
trackDefinitions.delete
Delete a track definition
Risk: destructive · Irreversible
Output
get
trackDefinitions.get
Get a track definition by ID
Risk: read
Output: empty object
list
trackDefinitions.list
List track definitions
Risk: read
Output: empty object
update
trackDefinitions.update
Update a track definition
Risk: write
Output: empty object
Tracks
create
tracks.create
Apply a track definition to an entity
Risk: write
Output: empty object
delete
tracks.delete
Delete a track
Risk: destructive · Irreversible
Output
get
tracks.get
Get a track by ID
Risk: read
Output: empty object
listForEntity
tracks.listForEntity
List tracks on an opportunity or project
Risk: read
Output: empty object
update
tracks.update
Update a track description or date
Risk: write
Output: empty object
Users
get
users.get
Get a user by ID
Risk: read
Output: empty object
getCurrent
users.getCurrent
Get the current authenticated user
Risk: read
Output: empty object
list
users.list
List users
Risk: read
Output: empty object
update
users.update
Update user preferences
Risk: write
Output: empty object