| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.capsulecrm.com/api/v2 | link | — | — | — |
Actions (121)
Opportunities · 13
- Add additional party to opportunityPOST /api/v2/opportunities/{opportunityId}/parties/{partyId}
Link an existing party as an additional contact to the opportunity.
documented - Create opportunityPOST /api/v2/opportunities
Create a new opportunity.
documented - Delete opportunityDELETE /api/v2/opportunities/{opportunityId}
Delete an opportunity.
documented - List additional partiesGET /api/v2/opportunities/{opportunityId}/parties
List additional parties related to the opportunity.
documented - List associated projectsGET /api/v2/opportunities/{opportunityId}/kases
List projects associated with the opportunity.
documented - List deleted opportunitiesGET /api/v2/opportunities/deleted
Show deleted opportunities.
documented - List opportunitiesGET /api/v2/opportunities
Retrieve all opportunities.
documented - List opportunities by partyGET /api/v2/parties/{partyId}/opportunities
Retrieve opportunities for a specific party.
documented - Remove additional party from opportunityDELETE /api/v2/opportunities/{opportunityId}/parties/{partyId}
Unlink an additional party from the opportunity.
documented - Search opportunitiesGET /api/v2/opportunities/search
Search opportunities.
documented - Show multiple opportunitiesGET /api/v2/opportunities/{opportunityIds}
Retrieve multiple opportunities by IDs.
documented - Show opportunityGET /api/v2/opportunities/{opportunityId}
Retrieve a specific opportunity.
documented - Update opportunityPUT /api/v2/opportunities/{opportunityId}
Update an existing opportunity.
documented
Projects · 13
- Add additional party to projectPOST /api/v2/kases/{projectId}/parties/{partyId}
Add an existing party as an additional contact to the project.
documented - Create projectPOST /api/v2/kases
Create a new project.
documented - Delete projectDELETE /api/v2/kases/{projectId}
Delete a project.
documented - List additional partiesGET /api/v2/kases/{projectId}/parties
List additional parties related to a project.
documented - List deleted projectsGET /api/v2/kases/deleted
Show deleted projects.
documented - List opportunities for projectGET /api/v2/kases/{projectId}/opportunities
List opportunities linked to the project.
documented - List projectsGET /api/v2/kases
Retrieve all projects.
documented - List projects by partyGET /api/v2/parties/{partyId}/kases
List projects associated with a party.
documented - Remove additional party from projectDELETE /api/v2/kases/{projectId}/parties/{partyId}
Remove an additional party from a project.
documented - Search projectsGET /api/v2/kases/search
Search projects.
documented - Show multiple projectsGET /api/v2/kases/{projectIds}
Load multiple projects by IDs.
documented - Show projectGET /api/v2/kases/{projectId}
Retrieve a specific project.
documented - Update projectPUT /api/v2/kases/{projectId}
Update an existing project.
documented
Parties · 10
- Create partyPOST /api/v2/parties
Create a new party.
documented - Delete partyDELETE /api/v2/parties/{partyId}
Fully delete the specific party.
documented - List deleted partiesGET /api/v2/parties/deleted
Retrieve parties that have been deleted since a given date.
documented - List employeesGET /api/v2/parties/{partyId}/people
List employees linked to the party (organisation/person).
documented - List opportunities for partyGET /api/v2/parties/{partyId}/opportunities
Retrieve opportunities associated with the given party.
documented - List partiesGET /api/v2/parties
Retrieve the collection of Parties (people and organisations) in the Capsule account.
documented - Search partiesGET /api/v2/parties/search
Search parties in the Capsule account.
documented - Show multiple partiesGET /api/v2/parties/{partyIds}
Load a list of parties by IDs (comma separated).
documented - Show partyGET /api/v2/parties/{partyId}
Retrieve details for a specific party.
documented - Update partyPUT /api/v2/parties/{partyId}
Update an existing party.
documented
Pipelines · 8
- Archive pipelinePOST /api/v2/pipelines/{pipelineId}/archive
Archive a pipeline.
documented - Create pipelinePOST /api/v2/pipelines
Create a new pipeline.
documented - Duplicate pipelinePOST /api/v2/pipelines/{pipelineId}/duplicate
Create a duplicate of an existing pipeline.
documented - List pipelinesGET /api/v2/pipelines
List all pipelines.
documented - Restore pipelinePOST /api/v2/pipelines/{pipelineId}/restore
Restore a previously archived pipeline.
documented - Show multiple pipelinesGET /api/v2/pipelines/{pipelineIds}
Show multiple pipelines.
documented - Show pipelineGET /api/v2/pipelines/{pipelineId}
Show a specific pipeline.
documented - Update pipelinePUT /api/v2/pipelines/{pipelineId}
Update pipeline details.
documented
Users · 8
- List usersGET /api/v2/users
List users in the Capsule account.
documented - List usersGET /api/v2/users
List all users in the Capsule account.
documented - Show current userGET /api/v2/users/current
Show the user associated with the access token.
documented - Show current userGET /api/v2/users/current
Show the user associated with the access token.
documented - Show userGET /api/v2/users/{userId}
Show a specific user.
documented - Show userGET /api/v2/users/{userId}
Show a specific user.
documented - Update userPUT /api/v2/users/{userId}
Update a user.
documented - Update userPUT /api/v2/users/{userId}
Update a user.
documented
Boards · 7
- Archive boardPOST /api/v2/boards/{boardId}/archive
Archive a board.
documented - Create boardPOST /api/v2/boards
Create a new board.
documented - Delete boardDELETE /api/v2/boards/{boardId}
Delete a board.
documented - List boardsGET /api/v2/boards
List all boards.
documented - Restore boardPOST /api/v2/boards/{boardId}/restore
Restore an archived board.
documented - Show boardGET /api/v2/boards/{boardId}
Show a specific board.
documented - Update boardPUT /api/v2/boards/{boardId}
Update a board.
documented
Entries · 7
- Create entryPOST /api/v2/entries
Create a new entry (note/email) for a party, project or opportunity.
documented - Delete entryDELETE /api/v2/entries/{id}
Delete an entry.
documented - List entriesGET /api/v2/entries
Fetch a list of entries (notes, emails, etc.).
documented - Show attachmentGET /api/v2/attachments/{attachmentId}
Download an attachment.
documented - Show entryGET /api/v2/entries/{id}
Show a specific entry.
documented - Update entryPUT /api/v2/entries/{id}
Update an existing entry.
documented - Upload attachmentPOST /api/v2/attachments/upload
Upload a file to attach to an entry (provides a token for later use).
documented
Custom Fields · 5
- Create custom fieldPOST /api/v2/fields
Create a new custom field definition.
documented - Delete custom fieldDELETE /api/v2/fields/{fieldId}
Delete a custom field definition.
documented - List custom fieldsGET /api/v2/fields
List all custom field definitions.
documented - Show custom fieldGET /api/v2/fields/{fieldId}
Show a single custom field definition.
documented - Update custom fieldPUT /api/v2/fields/{fieldId}
Update an existing custom field definition.
documented
Lost Reasons · 5
- Create lost reasonPOST /api/v2/lostReasons
Create a lost reason.
documented - Delete lost reasonDELETE /api/v2/lostReasons/{lostReasonId}
Delete lost reason.
documented - List lost reasonsGET /api/v2/lostReasons
List lost reasons.
documented - Show lost reasonGET /api/v2/lostReasons/{lostReasonId}
Show a lost reason.
documented - Update lost reasonPUT /api/v2/lostReasons/{lostReasonId}
Update lost reason.
documented
Milestones · 5
- Create milestonePOST /api/v2/milestones
Create a milestone.
documented - Delete milestoneDELETE /api/v2/milestones/{milestoneId}
Delete milestone.
documented - List milestonesGET /api/v2/milestones
List all milestones.
documented - Show milestoneGET /api/v2/milestones/{milestoneId}
Show a milestone.
documented - Update milestonePUT /api/v2/milestones/{milestoneId}
Update milestone.
documented
Stages · 5
- Create stagePOST /api/v2/stages
Create a stage.
documented - Delete stageDELETE /api/v2/stages/{stageId}
Delete a stage.
documented - List stagesGET /api/v2/stages
List stages.
documented - Show stageGET /api/v2/stages/{stageId}
Show a stage.
documented - Update stagePUT /api/v2/stages/{stageId}
Update a stage.
documented
Tags · 5
- Create tag definitionPOST /api/v2/{entity}/tags
Create a new tag definition for an entity.
documented - Delete tag definitionDELETE /api/v2/{entity}/tags/{tagId}
Delete a tag definition.
documented - List tag definitionsGET /api/v2/{entity}/tags
List all tag definitions for a given entity (parties, opportunities, or kases).
documented - Show tag definitionGET /api/v2/{entity}/tags/{tagId}
Show a single tag definition for an entity.
documented - Update tag definitionPUT /api/v2/{entity}/tags/{tagId}
Update an existing tag definition.
documented
Tasks · 5
- Create taskPOST /api/v2/tasks
Create a new task.
documented - Delete taskDELETE /api/v2/tasks/{taskId}
Delete a task.
documented - List tasksGET /api/v2/tasks
Retrieve the collection of tasks.
documented - Show taskGET /api/v2/tasks/{taskId}
Retrieve a specific task.
documented - Update taskPUT /api/v2/tasks/{taskId}
Update an existing task.
documented
Track Definitions · 5
- Create track definitionPOST /api/v2/trackDefinitions
Create a track definition.
documented - Delete track definitionDELETE /api/v2/trackDefinitions/{definitionId}
Delete a track definition.
documented - List track definitionsGET /api/v2/trackDefinitions
List track definitions.
documented - Show track definitionGET /api/v2/trackDefinitions/{definitionId}
Show a track definition.
documented - Update track definitionPUT /api/v2/trackDefinitions/{definitionId}
Update a track definition.
documented
Tracks · 5
- Create trackPOST /api/v2/tracks
Create a track.
documented - Delete trackDELETE /api/v2/tracks/{trackId}
Delete a track.
documented - List tracksGET /api/v2/tracks
List all tracks.
documented - Show trackGET /api/v2/tracks/{trackId}
Show a track.
documented - Update trackPUT /api/v2/tracks/{trackId}
Update a track.
documented
REST Hook · 4
- List REST hooksGET /api/v2/restHooks
List REST hooks.
documented - Show REST hookGET /api/v2/restHooks/{hookId}
Show a REST hook.
documented - Subscribe REST hookPOST /api/v2/restHooks
Subscribe to REST hooks.
documented - Unsubscribe REST hookDELETE /api/v2/restHooks/{hookId}
Unsubscribe from a REST hook.
documented