# Capsule CRM integration

> Capsule CRM API v2: contacts (people and organisations), sales opportunities, projects, tasks, notes and activity entries, pipelines, tags, custom fields, tracks and REST hooks.

- Authentication: apiKey

## Tools (133)

- **Add additional party**: Add a person or organisation as an additional contact to the opportunity.
- **Add additional party (project)**: Add a person or organisation as an additional contact to the project.
- **Archive board**: Archive the specific board. Requires the Administrator role.
- **Archive pipeline**: Archive the specific pipeline. Requires the Administrator role.
- **Create activity type**: Creates a new activity type. Body is an object with a single property `activityType`. Only possible on a teams edition Capsule account.
- **Create board**: Creates a new board. The body must contain an object with a single property `board` which must be a [Board object](https://developer.capsulecrm.com/v2/models/board). Capsule accounts can have at most 30 active (non-archived) boards at any one time. This operation requires the authenticated user to h
- **Create custom field**: Creates a party, opportunity or project custom field. The `entity` URL parameter must be `parties`, `opportunities` or `kases`. Body is an object with a single property `definition`.
- **Create custom title**: Create a new custom person title. Body is an object with a single property `personTitle`. At most 50 custom titles; requires the Administrator role.
- **Create entry**: Creates a new entry. The body must contain an object with a single property `entry` which must be an [Entry object](https://developer.capsulecrm.com/v2/models/entry). The note needs to be created for a party, project or opportunity, so exactly one of these needs to be included in the body of the req
- **Create goal**: Creates a new goal. The body must contain an object with a single property `goal`.
- **Create lost reason**: Creates a new lost reason. The body must contain an object with a single property `lostReason` which must be a [Lost Reason object](https://developer.capsulecrm.com/v2/models/lost_reason). This operation requires the authenticated user has an Administrator role on the Capsule account.
- **Create milestone**: Creates a new opportunity milestone. Body is an object with a single property `milestone`.
- **Create opportunity**: Creates a new opportunity. The body must contain an object with a single property `opportunity`. Tracks can be applied via a `tracks` array.
- **Create party**: Creates a new person or organisation. The body must contain an object with a single property `party`. Supports tags, custom fields, tracks and organisation linking.
- **Create pipeline**: Creates a new pipeline. Body is an object with a single property `pipeline`. At most 30 active pipelines per account. Requires the Administrator role.
- **Create project**: Creates a new project. The body must contain an object with a single property `kase`. Tracks can be applied via a `tracks` array.
- **Create stage**: Creates a new stage on a board. Body is an object with a single property `stage`. Requires the Administrator role.
- **Create tag definition**: 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](https://developer.capsulec
- **Create task**: Creates a new task. The body must contain an object with a single property `task`.
- **Create task category**: Creates a new task category. Body is an object with a single property `category`.
- **Create track**: Applies a [Track definition](https://developer.capsulecrm.com/v2/models/track_definition) to a party, opportunity or project to create a track.
- **Create track definition**: Create a track definition. Body is an object with a single property `trackDefinition`.
- **Delete activity type**: Removes an activity type from the Capsule account.
- **Delete custom field**: 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 custom title**: 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 entry**: Remove an entry from the Capsule account and any associated attachments.
- **Delete goal**: Removes a goal from the Capsule account.
- **Delete lost reason**: Removes a lost reason from the Capsule account. It may be kept for historical reporting but can no longer be selected. Requires the Administrator role.
- **Delete milestone**: 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**: Fully delete a specific opportunity from Capsule.
- **Delete party**: Fully delete the specific party from Capsule.
- **Delete project**: Fully delete the specific project from Capsule.
- **Delete stage**: Removes a stage from the Capsule account. A stage in use on an open project cannot be deleted. Requires the Administrator role.
- **Delete tag definition**: Removes a tag from the Capsule account, including from every party, opportunity and project it was assigned to.
- **Delete task**: Fully delete the specific task from Capsule.
- **Delete task category**: Removes a category from the Capsule account. Any tasks under this category will be retained but will become uncategorized.
- **Delete track**: Remove a track and its related tasks from a party, opportunity or project.
- **Delete track definition**: Delete a track definition.
- **Duplicate pipeline**: Duplicate a specific pipeline. Requires the Administrator role.
- **List activity types**: The collection of all the activity types on this Capsule account.
- **List additional parties**: The collection of additional parties related to this opportunity.
- **List additional parties (project)**: The collection of additional parties related to this project.
- **List associated projects**: The collection of projects related to this opportunity.
- **List boards**: The collection of boards on the Capsule account.
- **List by date**: List notes, emails and completed party task details across the account, most recent entry first.
- **List 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**: Collection of ISO currency code options available in Capsule; useful for populating and displaying the opportunities' value. The same for all Capsule accounts.
- **List custom fields**: 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.
- **List custom titles**: List custom titles for this Capsule account.
- **List deleted opportunities**: 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.
- **List deleted parties**: Parties deleted from Capsule since the date in the `since` parameter, plus parties made restricted for the calling user.
- **List deleted projects**: Projects deleted from Capsule since the date in the `since` parameter, plus projects made restricted for the calling user.
- **List employees**: The collection of employees linked to this organisation.
- **List entries**: List notes, emails and completed tasks for `parties`, `kases` (projects) and `opportunities`. The `entity` parameter in the URL must be one of `parties`, `opportunities` or `kases`; `entityId` is the id of that record.
- **List goal periods**: The collection of all the goal periods for a specific goal.
- **List goals**: The collection of all the goals on this Capsule account.
- **List icons**: List of icons that can be associated with activity types.
- **List lost reasons**: The collection of all the lost reasons on this Capsule account.
- **List milestones**: Milestones on the oldest active pipeline (kept for backwards compatibility; use List milestones by pipeline for a specific pipeline).
- **List milestones by pipeline**: List milestones associated with a pipeline.
- **List opportunities**: The collection of Opportunities on the Capsule account.
- **List opportunities by party**: The collection of all opportunities associated with the given party.
- **List parties**: The collection of Parties (people and organisations) on the Capsule account.
- **List pipelines**: The collection of pipelines on the Capsule account.
- **List projects**: The collection of Projects (kases) on the Capsule account.
- **List projects by party**: The collection of all projects associated with the given party.
- **List REST hooks**: The REST hooks currently subscribed on the account. With a registered application, only that application's hooks are returned.
- **List stages**: The collection of stages on the Capsule account.
- **List stages by board**: List stages associated with a board.
- **List tag definitions**: The collection of all tags on this Capsule account. The `entity` URL parameter must be `parties`, `opportunities` or `kases`.
- **List task categories**: The collection of all the task categories on this Capsule account.
- **List tasks**: The collection of Tasks on the Capsule account. Only open tasks by default; use `status` for pending or completed ones.
- **List teams**: List all the teams on this Capsule account.
- **List track definitions**: List track definitions, optionally filtered to parties, opportunities or projects.
- **List tracks**: List tracks for a specific party, opportunity or project. The `entity` URL parameter must be `parties`, `opportunities` or `kases`.
- **List users**: List all the users on this Capsule account.
- **Remove additional party**: Remove that person or organisation as an additional contact of the opportunity.
- **Remove additional party (project)**: Remove a specific person or organisation as an additional contact of the project.
- **Restore board**: Restore an archived board. Requires the Administrator role.
- **Restore pipeline**: Restore an archived pipeline. Requires the Administrator role.
- **Run query**: Runs a filter query and returns the matching results. The `entity` URL parameter must be `parties`, `opportunities` or `kases`; the body `conditions` field holds the search criteria.
- **Search opportunities**: Search for opportunities on the Capsule account. Returns the same results as the global search inside Capsule.
- **Search parties**: Search for parties on the Capsule account. Returns the same results as the global search inside Capsule.
- **Search projects**: Search for projects on the Capsule account. Returns the same results as the global search inside Capsule.
- **Show activity type**: Show a specific activity type.
- **Show attachment**: 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.
- **Show board**: Show a specific board.
- **Show current user**: Shows the details of the user the provided access token is associated with. Embed `party` for contact details.
- **Show custom field**: Show a specific custom field.
- **Show entry**: Show a specific note, email or the details of a completed party task.
- **Show goal**: Show a specific goal.
- **Show job**: Status of a long-running job returned by a 202 Accepted response.
- **Show lost reason**: Show a specific lost reason.
- **Show milestone**: Show a specific milestone.
- **Show multiple opportunities**: 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.
- **Show multiple parties**: 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.
- **Show multiple pipelines**: Load a list of pipelines by their unique ids. `pipelineIds` is a comma separated list of integers, at most 10 values.
- **Show multiple projects**: Load a list of projects by their unique ids. `projectIds` is a comma separated list of integers, at most 10 values.
- **Show opportunity**: Returns a specific opportunity.
- **Show party**: Show a specific person or organisation.
- **Show pipeline**: Show a specific pipeline.
- **Show project**: Show a specific project.
- **Show REST hook**: Show a specific REST hook. The REST hook is only visible to users authenticated via the registered application that subscribed it.
- **Show site address**: Shows the details of the site address the provided access token is associated with.
- **Show stage**: Show a specific stage.
- **Show tag definition**: Show a specific tag. The `entity` URL parameter must be `parties`, `opportunities` or `kases`.
- **Show task**: Show a specific task.
- **Show task category**: Show a specific task category.
- **Show team**: Show a specific team.
- **Show track**: Show a specific track.
- **Show track definition**: Show a specific track definition.
- **Show user**: Retrieve a specific user. Embed `party` for the user's contact details.
- **Subscribe REST hook**: Subscribes to an event in Capsule (maximum 20 REST hooks per account). Body is an object with a single property `restHook`. Requires an Administrator authenticated via a registered application.
- **Unsubscribe REST hook**: Unsubscribes a REST hook, stopping all events immediately. Requires an Administrator authenticated via the same registered application that subscribed the hook.
- **Update activity type**: Updates an existing activity type. Body is an object with a single property `activityType`. Omitted fields stay unchanged.
- **Update board**: Update an existing board. The body must contain an object with a single property `board`. Fields not included remain unchanged. Requires the Administrator role.
- **Update custom field**: 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](https://developer.capsulecrm.com/v2/models/field_definition).
- **Update entry**: Update the content of notes and emails. The body must contain an object with a single property `entry`. Only applies to entries of type `email` or `note`.
- **Update goal**: Update an existing goal. Body is an object with a single property `goal`. Goal assignee, type, pipeline and milestone cannot be changed.
- **Update lost reason**: Update the name and inclusion in conversion calculation of a lost reason. The body must contain an object with a single property `lostReason`. Requires the Administrator role.
- **Update milestone**: Update the name, description or probability of a milestone. Body is an object with a single property `milestone`.
- **Update opportunity**: Updates an existing opportunity. Body is an object with a single property `opportunity`. Omitted fields stay unchanged; tags and custom fields can be added, changed or removed with `_delete`.
- **Update party**: Update an existing party. Body is an object with a single property `party`. Omitted fields stay unchanged; nested collections (addresses, phone numbers, websites, emails, tags, fields) can be added, changed or removed with `_delete`.
- **Update pipeline**: Update an existing pipeline. The body must contain an object with a single property `pipeline` which must be a [Pipeline object](https://developer.capsulecrm.com/v2/models/pipeline). Fields that are not included in the request will remain unchanged. This operation requires the authenticated user to
- **Update project**: Updates an existing project. The body must contain an object with a single property `kase` which must be a [Project object](https://developer.capsulecrm.com/v2/models/project). Fields that are not included in the request will remain unchanged. An `owner` and/or `team` are required on a project. To a
- **Update stage**: 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](https://developer.capsulecrm.com/v2/models/stage). This operation requires the authenticated user to have an Administrator role on the Capsule account.
- **Update tag definition**: Update the details of a party, opportunity or project tag. Body is an object with a single property `tag`.
- **Update task**: Update the specified task. Body is an object with a single property `task`. Omitted fields stay unchanged.
- **Update task category**: Rename or change the colour of a task category. Body is an object with a single property `category`.
- **Update track**: Updates basic details about the track - only `description` and `trackDateOn` can be modified by this endpoint.
- **Update track definition**: Update the details of a track definition. Body is an object with a single property `trackDefinition`. Task definitions can be added, changed or removed with `_delete`.
- **Update user**: Update an existing user's preferences. Body is an object with a single property `user`. The token needs the `user_preference` scope.
- **Upload attachment**: Upload a file and get a token to attach it to an entry. Raw file bytes in the body with Content-Type, Content-Length and X-Attachment-Filename headers.

Connect Capsule CRM in General Input: https://www.generalinput.com/apps/capsule-crm