Capsule CRM

Delete activity type. DELETE /activitytypes/{activityTypeId}. Removes an activity type from the Capsule account.

Archive board. DELETE /boards/{boardId}. Archive the specific board. This operation requires the authenticated user to have an Administrator role on the Capsule account.

Delete custom field. DELETE /{entity}/fields/definitions/{fieldId}. Removes a custom field from this Capsule account. Note that this will remove the field value from any parties, opportunities and projects it was assigned to.

Delete tag definition. DELETE /{entity}/tags/{tagId}. Removes a tag from the Capsule account. Note that this will remove the tag from any parties, opportunities and projects it was assigned to.

Delete task category. DELETE /categories/{categoryId}. Removes a category from the Capsule account. Any tasks under this category will be retained but will become uncategorized.

Delete entry. DELETE /entries/{id}. Remove an entry from the Capsule account and any associated attachments.

Delete goal. DELETE /goals/{goalId}. Removes a goal from the Capsule account.

Delete project. DELETE /kases/{projectId}. Fully delete the specific project from Capsule.

Remove additional party (Project). DELETE /kases/{projectId}/parties/{partyId}. Remove a specific person or organisation as an additional contact of the project.

Delete lost reason. DELETE /lostreasons/{lostReasonId}. Removes a lost reason from the Capsule account. Lost Reasons may not be immediately deleted and may be kept for reporting on historical records, however you will not be able to select a lost reason marked for deletion on a new opportunity or while updating an opportunity. This operation requires the

Delete milestone. DELETE /milestones/{milestoneId}. Removes a milestone from the Capsule account. You cannot delete a milestone while it is still being used on an opportunity. First you need to change or remove the milestone on all such opportunities.

Delete opportunity. DELETE /opportunities/{opportunityId}. Fully delete a specific opportunity from Capsule.

Remove additional party (Opportunity). DELETE /opportunities/{opportunityId}/parties/{partyId}. Remove that person or organisation as an additional contact of the opportunity.

Delete party. DELETE /parties/{partyId}. Fully delete the specific party from Capsule.

Archive pipeline. DELETE /pipelines/{pipelineId}. Archive the specific pipeline. This operation requires the authenticated user to have an Administrator role on the Capsule account.

Unsubscribe REST hook. DELETE /resthooks/{restHookId}. Unsubscribes a REST hook, stopping all events immediately. This operation requires that the user has an Administrator role on the account, and is authenticated via the same registered application that subscribed the REST hook to be deleted.

Delete stage. DELETE /stages/{stageId}. Removes a stage from the Capsule account. You cannot delete a stage while it is still being used on an open project. First you need to change or remove the stage on all such projects. This operation requires the authenticated user to have an Administrator role on the Capsule account.

Delete task. DELETE /tasks/{taskId}. Fully delete the specific task from Capsule.

Delete custom title. DELETE /titles/{titleId}. Delete a custom title from Capsule. Titles can only be deleted if they are not in use by any party. This operation requires the authenticated user has an Administrator role on the Capsule account.

Delete track definition. DELETE /trackdefinitions/{trackDefinitionId}. Delete a track definition.

Delete track. DELETE /tracks/{trackId}. Remove track and related tasks from party, opportunity or project.

List activity types. GET /activitytypes. The collection of all the activity types on this Capsule account.

Show activity type. GET /activitytypes/{activityTypeId}. Show a specific activity type.

List icons. GET /activitytypes/icons. List of icons that can be associated with activity types.

Show attachment. GET /attachments/{attachmentId}. Get the contents of an attachment. The contents can be saved locally to a file using the Content-disposition header to determine the file name.

List boards. GET /boards. The collection of boards on the Capsule account.

Show board. GET /boards/{boardId}. Show a specific board.

List stages by board. GET /boards/{boardId}/stages. List stages associated with a board.

List entries. GET /{entity}/{entityId}/entries. List notes, emails and completed tasks for parties, kases (projects) and opportunities. The entity parameter in the URL determines which entry type to list and must be one of parties, opportunities or kases (projects). entityId should be the id of a party, project or opportunity on the account.

List tracks. GET /{entity}/{entityId}/tracks. List tracks for a specific party, opportunity or project. The entity parameter inside the URL must be parties, opportunities or kases and defines which tracks to return.

List custom fields. GET /{entity}/fields/definitions. The collection of all custom fields on this Capsule account. The entity parameter inside the URL must be parties, opportunities or kases and defines which custom fields to return.

Show custom field. GET /{entity}/fields/definitions/{fieldId}. Show a specific custom field.

List tag definitions. GET /{entity}/tags. The collection of all of the tags on this Capsule account. The entity parameter inside the URL must be parties, opportunities or kases and defines which tags to return.

Show tag definition. GET /{entity}/tags/{tagId}. Show a specific tag.

List task categories. GET /categories. The collection of all the task categories on this Capsule account.

Show task category. GET /categories/{categoryId}. Show a specific task category.

List countries. GET /countries. Collection of country names available in Capsule; useful for populating the country field of the party's address. These are the same for all Capsule accounts.

List currencies. GET /currencies. Collection of ISO currency code options available in Capsule; useful for populating and displaying the opportunities' value. These are the same for all Capsule accounts.

List by date. GET /entries. List notes, emails and the details of completed party tasks in descending order starting with the most recent entry date first.

Show entry. GET /entries/{id}. Show a specific note, email or the details of a completed party task.

List goals. GET /goals. The collection of all the goals on this Capsule account.

Show goal. GET /goals/{goalId}. Show a specific goal.

List goal periods. GET /goals/{goalId}/periods. The collection of all the goal periods for a specific goal on this Capsule account.

List projects. GET /kases. The collection of Projects on the Capsule account.

Show project. GET /kases/{projectId}. Show a specific project.

List additional parties (Project). GET /kases/{projectId}/parties. The collection of additional parties related to this project.

Show multiple projects. GET /kases/{projectIds}. Allows to load a list of projects by providing their unique ids. projectIds must be a comma separated list of integers and can contain at most 10 values.

List deleted projects. GET /kases/deleted. A collection of projects that have been deleted from Capsule since the date specified in the since parameter. Also contains projects that have been made restricted for the user calling the API endpoint.

Search projects. GET /kases/search. Search for projects on the Capsule account. This will return the same results as the global search inside Capsule. If you're looking for a more structured search endpoint you can use Filters to search by a specific field or tag.

List lost reasons. GET /lostreasons. The collection of all the lost reasons on this Capsule account.

Show lost reason. GET /lostreasons/{lostReasonId}. Show a specific lost reason.

List milestones. GET /milestones. The collection of all the milestones on the oldest active pipeline. This endpoint remains for backwards compatibility purposes. To list milestones on a specific pipeline, use the list milestones by pipeline endpoint.

Show milestone. GET /milestones/{milestoneId}. Show a specific milestone.

List opportunities. GET /opportunities. The collection of Opportunities on the Capsule account.

Show opportunity. GET /opportunities/{opportunityId}. Returns a specific opportunity.

List associated projects. GET /opportunities/{opportunityId}/kases. The collection of projects related to this opportunity.

List additional parties (Opportunity). GET /opportunities/{opportunityId}/parties. The collection of additional parties related to this opportunity.

Show multiple opportunities. GET /opportunities/{opportunityIds}. Return a list of opportunities, specified by the opportunityIds provided. The opportunityIds must be a comma separated list of integers and can contain at most 10 values.

List deleted opportunities. GET /opportunities/deleted. A collection of opportunities that have been deleted from Capsule since the date specified in the since parameter. Also contains opportunities that have been made restricted for the user calling the API endpoint.

Search opportunities. GET /opportunities/search. Search for opportunities on the Capsule account. This will return the same results as the global search inside Capsule. If you're looking for a more structured search endpoint you can use Filters to search by a specific field or tag.

List parties. GET /parties. The collection of Parties on the Capsule account.

Show party. GET /parties/{partyId}. Show a specific person or organisation.

List projects by party. GET /parties/{partyId}/kases. The collection of all projects associated with the given party.

List opportunities by party. GET /parties/{partyId}/opportunities. The collection of all opportunities associated with the given party.

List employees. GET /parties/{partyId}/people. The collection of employees linked to this organisation.

Show multiple parties. GET /parties/{partyIds}. Allows to load a list of parties by providing their unique ids. partyIds must be a comma separated list of integers and can contain at most 10 values.

List deleted parties. GET /parties/deleted. A collection of parties that have been deleted from Capsule since the date specified in the since parameter. Also contains parties that have been made restricted for the user calling the API endpoint.

Search parties. GET /parties/search. Search for parties on the Capsule account. This will return the same results as the global search inside Capsule. If you're looking for a more structured search endpoint you can use Filters to search by a specific field or tag.

List pipelines. GET /pipelines. The collection of pipelines on the Capsule account.

Show pipeline. GET /pipelines/{pipelineId}. Show a specific pipeline.

List milestones by pipeline. GET /pipelines/{pipelineId}/milestones. List milestones associated with a pipeline.

Show multiple pipelines. GET /pipelines/{pipelineIds}. Allows to load a list of pipelines by providing their unique ids. pipelineIds must be a comma separated list of integers and can contain at most 10 values.

List REST hooks. GET /resthooks. The collection of REST hooks currently subscribed on the account. If authenticated via a registered application, only REST hooks subscribed by that application will be returned.

Show REST hook. GET /resthooks/{restHookId}. Show a specific REST hook. The REST hook is only visible to users authenticated via the registered application that subscribed it.

Show site address. GET /site. Shows the details of the site address the provided access token is associated with.

List stages. GET /stages. The collection of stages on the Capsule account.

Show stage. GET /stages/{stageId}. Show a specific stage.

List tasks. GET /tasks. The collection of Tasks on the Capsule account. By default the body will contain only the open tasks. If you want to retrieve pending and/or completed tasks use the status query parameter.

Show task. GET /tasks/{taskId}. Show a specific task.

List teams. GET /teams. List all the teams on this Capsule account.

Show team. GET /teams/{teamId}. Show a specific team.

List custom titles. GET /titles. List custom titles for this Capsule account.

List track definitions. GET /trackdefinitions. List track definitions with the option to filter for track definitions for parties, opportunities or projects.

Show track definition. GET /trackdefinitions/{trackDefinitionId}. Show a specific track definition.

Show track. GET /tracks/{trackId}. Show a specific track.

List users. GET /users. List all the users on this Capsule account.

Show user. GET /users/{userId}. Retrieve a specific user. Each user has an associated Party record. It stores additional information about the user, including email addresses, phone numbers etc. In order to retrieve user information stored in a user's party record, you can embed party in the query.

Show current user. GET /users/current. Shows the details of the user the provided access token is associated with. In most cases this will be the user who approved your application. Each user has an associated Party record. It stores additional information about the user, including email addresses, phone numbers etc. In order to retrieve

Create activity type. POST /activitytypes. Creates a new activity type. The body must contain an object with a single property activityType which must be an Activity Type object. Please be aware that creating an activity type is only possible on a teams edition Capsule account.

Upload attachment. POST /attachments/upload. Upload an attachment ready to be attached to an entry. The following request headers are required. Content-Type - should be set to the MIME type of the file being uploaded. Content-Length - should be set to the length of the file being uploaded in bytes. X-Attachment-Filename - should be set to a U

Create board. POST /boards. Creates a new board. The body must contain an object with a single property board which must be a Board object. Capsule accounts can have at most 30 active (non-archived) boards at any one time. This operation requires the authenticated user to have an Administrator role on the Capsule account.

Restore board. POST /boards/{boardId}/restore. Restore an archived board. This operation requires the authenticated user to have an Administrator role on the Capsule account.

Create custom field. POST /{entity}/fields/definitions. Creates a new party, opportunity or project custom field specified by the entity parameter inside the URL, which must be parties, opportunities or kases. Custom fields can be created on data tags - i.e. tags with dataTag set to true. Simply specify the id or name of the tag in the request body as

Run query. POST /{entity}/filters/results. Runs a query and returns the matching results. The entity parameter in the URL determines which entity type to search and must be one of parties, opportunities or kases (projects). The conditions field in the request body is used to specify the search criteria.

Create tag definition. POST /{entity}/tags. Defines a new party, opportunity or project tag. The type of this tag is defined by the entity parameter inside the URL which must be parties, opportunities or kases. The body must contain an object with a single property tag which must be a Tag Definition object. To create a new data tag set the

Create task category. POST /categories. Creates a new task category. The body must contain an object with a single property category which must be a Category object.

Create entry. POST /entries.

Create goal. POST /goals. Creates a new goal. The body must contain an object with a single property goal which must be a Goal object.

Create project. POST /kases.

Add additional party (Project). POST /kases/{projectId}/parties/{partyId}. Add a person or organisation as an additional contact to the project.

Create lost reason. POST /lostreasons. Creates a new lost reason. The body must contain an object with a single property lostReason which must be a Lost Reason object. This operation requires the authenticated user has an Administrator role on the Capsule account.

Create milestone. POST /milestones. Creates a new opportunity milestone. The body must contain an object with a single property milestone which must be a Milestone object.

Create opportunity. POST /opportunities.

Add additional party (Opportunity). POST /opportunities/{opportunityId}/parties/{partyId}. Add a person or organisation as an additional contact to the opportunity.

Create party. POST /parties.

Create pipeline. POST /pipelines. Creates a new pipeline. The body must contain an object with a single property pipeline which must be a Pipeline object. Capsule accounts can have at most 30 active (non-archived) pipelines at any one time. This operation requires the authenticated user to have an Administrator role on the Capsule

Duplicate pipeline. POST /pipelines/{pipelineId}/duplicate. Duplicate a specific pipeline. This operation requires the authenticated user to have an Administrator role on the Capsule account.

Restore pipeline. POST /pipelines/{pipelineId}/restore. Restore an archived pipeline. This operation requires the authenticated user to have an Administrator role on the Capsule account.

Subscribe REST hook. POST /resthooks. Subscribes to an event in Capsule. A maximum 20 REST hooks can be subscribed per account. The body must contain an object with a single property restHook which must be a REST Hook object. This operation requires that the User has an Administrator role on the account, and is authenticated via a regi

Create stage. POST /stages. Creates a new stage. The body must contain an object with a single property stage which must be a Stage object. This operation requires the authenticated user to have an Administrator role on the Capsule account.

Create task. POST /tasks. Creates a new task. The body must contain an object with a single property task which must be a Task object.

Create custom title. POST /titles. Create a new custom title. The body must contain an object with a single property personTitle which must be a Title object. Capsule accounts can have at most 50 custom titles. This operation requires the authenticated user has an Administrator role on the Capsule account.

Create track definition. POST /trackdefinitions. Create a track definition.

Create track. POST /tracks. Applies a Track definition to a party, opportunity or project to create a track.

Update activity type. PUT /activitytypes/{activityTypeId}. Updates an existing activity type. The body must contain an object with a single property activityType which must be an Activity Type object. Fields that are not included in the request will remain unchanged.

Update board. PUT /boards/{boardId}. Update an existing board. The body must contain an object with a single property board which must be a Board object. Fields that are not included in the request will remain unchanged. This operation requires the authenticated user to have an Administrator role on the Capsule account.

Update custom field. PUT /{entity}/fields/definitions/{fieldId}. Update the details of a party, opportunity or project field definition. The body must contain an object with a single property definition which must be a Field Definition object.

Update tag definition. PUT /{entity}/tags/{tagId}. Update the details of a party, opportunity or project tag. The body must contain an object with a single property tag which must be a Tag Definition object. To convert a data tag back to a simple tag you will need to first delete all the custom field definitions linked to it and then set the dataTa

Update task category. PUT /categories/{categoryId}. Allows to rename or change the colour of the task category. The body must contain an object with a single property category which must be a Category object.

Update entry. PUT /entries/{id}. Update the content of notes and emails. The body must contain an object with a single property entry which must be an Entry object. This endpoint can only be applied to entries of type email or note. To apply changes to entities in attachments you can do the following: To add a new entity: create

Update goal. PUT /goals/{goalId}. Update an existing goal. The body must contain an object with a single property goal which must be a Goal object. Goal assignee, type, pipeline and milestone cannot be changed.

Update project. PUT /kases/{projectId}. Updates an existing project. The body must contain an object with a single property kase which must be a Project object. Fields that are not included in the request will remain unchanged. An owner and/or team are required on a project. To apply changes to entities in the tags or fields collections

Update lost reason. PUT /lostreasons/{lostReasonId}. Update the name and inclusion in conversion calculation of lost reason. The body must contain an object with a single property lostReason which must be a Lost Reason object. Fields that are not included in the request will remain unchanged. This operation requires the authenticated user has an Admi

Update milestone. PUT /milestones/{milestoneId}. Update the name, description or probability of a milestone. The body must contain an object with a single property milestone which must be a Milestone object.

Update opportunity. PUT /opportunities/{opportunityId}. Updates an existing opportunity. The body must contain an object with a single property opportunity which must be an Opportunity object. Fields that are not included in the request will remain unchanged. An owner and/or team are required on an opportunity. To apply changes to entities in the tags o

Update party. PUT /parties/{partyId}. Update an existing party. The body must contain an object with a single property party which must be a Party object. Fields that are not included in the request will remain unchanged. The owner and team are optional, with either owner and/or team being provided to assign the party to a user and/or

Update pipeline. PUT /pipelines/{pipelineId}. Update an existing pipeline. The body must contain an object with a single property pipeline which must be a Pipeline object. Fields that are not included in the request will remain unchanged. This operation requires the authenticated user to have an Administrator role on the Capsule account.

Update stage. PUT /stages/{stageId}. Update the name, description or position of a stage. The body must contain an object with a single property stage which must be a Stage object. This operation requires the authenticated user to have an Administrator role on the Capsule account.

Update task. PUT /tasks/{taskId}. Update the specified task. The body must contain an object with a single property task which must be a Task object. Fields that are not included in the request will remain unchanged.

Update track definition. PUT /trackdefinitions/{trackDefinitionId}.

Update track. PUT /tracks/{trackId}. Updates basic details about the track - only description and trackDateOn can be modified by this endpoint.

Update user. PUT /users/{userId}. Update an existing user. The body must contain an object with a single property user which must be a User object. Fields that are not included in the requests will remain unchanged. While it's not possible to change which party a user is linked to, you can update the party itself by editing it dire