# Capsule CRM

Capsule CRM is a simple yet powerful CRM platform designed to help businesses manage customer relationships, sales pipelines, and tasks efficiently.

- **Category:** crm
- **Auth:** OAUTH2, API_KEY
- **Composio Managed App Available?** Yes
- **Tools:** 109
- **Triggers:** 0
- **Slug:** `CAPSULE_CRM`
- **Version:** 20260323_00

## Tools

### Add Project Party

**Slug:** `CAPSULE_CRM_ADD_PROJECT_PARTY`

Tool to add a party (person or organisation) to a project in Capsule CRM. Use when you need to associate an additional contact with a specific project beyond the primary assigned party.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `party_id` | integer | Yes | The unique identifier (integer ID) of the person or organisation to add to the project. |
| `project_id` | integer | Yes | The unique identifier (integer ID) of the project to add the party to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Capsule CRM Category

**Slug:** `CAPSULE_CRM_CREATE_CATEGORY`

Tool to create a new task category in Capsule CRM. Use when you need to add a new category for organizing tasks with a specific name and color.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the category |
| `colour` | string | Yes | The color of the category in hex format (e.g., #EF4444, #d1c21a, #444444). Must include the # prefix. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Custom Field Definition

**Slug:** `CAPSULE_CRM_CREATE_CUSTOM_FIELD_DEFINITION`

Tool to create a new custom field definition for parties, opportunities, or projects in Capsule CRM. Use when you need to extend standard entity fields with custom attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | object | No | Reference to a data tag for grouping custom fields. |
| `name` | string | Yes | The label/name for this custom field that will be displayed in the UI. |
| `type` | string ("text" | "date" | "list" | "multiselectlist" | "boolean" | "number" | "link") | Yes | Data type of the custom field. Determines how values are stored and displayed. |
| `entity` | string ("parties" | "opportunities" | "kases") | Yes | Entity type to create the custom field for. Use 'parties' for contacts, 'opportunities' for sales opportunities, or 'kases' for projects/cases. |
| `options` | array | No | List of valid values for 'list' or 'multiselectlist' field types. Required for those types, ignored for others. |
| `important` | boolean | No | Marks whether the field should be highlighted as critical or important in the UI. |
| `captureRule` | string ("person" | "organisation") | No | Restricts applicability of party custom fields to person or organisation. |
| `description` | string | No | Extended explanation of the field's purpose or usage instructions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Entry

**Slug:** `CAPSULE_CRM_CREATE_ENTRY`

Tool to create a new note entry in Capsule CRM. Note: Only note type entries can be created via API. Emails and tasks can be viewed but not created through this endpoint. Use when you need to add a new note record linked to a party, opportunity, or project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kase` | object | No | Project (kase) to link the entry to. Exactly one of party, opportunity, or kase must be provided. |
| `type` | string | Yes | Type of entry. Only 'note' is supported for creation via API. Emails and tasks can be viewed but not created through this endpoint. |
| `party` | object | No | Party (person or organisation) to link the entry to. Exactly one of party, opportunity, or kase must be provided. |
| `content` | string | Yes | Text content of the entry. |
| `entryAt` | string | No | Timestamp for the entry in ISO8601 format. Defaults to current time if not provided. |
| `attachments` | array | No | Array of attachment references with tokens from the Upload Attachment endpoint. |
| `opportunity` | object | No | Opportunity to link the entry to. Exactly one of party, opportunity, or kase must be provided. |
| `activityType` | integer | No | Activity type ID. Common values: -1 for Note, -4 for Task completed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Lost Reason

**Slug:** `CAPSULE_CRM_CREATE_LOST_REASON`

Tool to create a new lost reason in Capsule CRM. Use when you need to add a new reason option for tracking why opportunities were lost. Lost reasons help categorize unsuccessful deals and can be included or excluded from conversion rate calculations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the lost reason. This will appear in dropdown lists when marking opportunities as lost. |
| `includedForConversion` | boolean | No | Whether to include this lost reason in conversion rate calculations. Set to true to include, false to exclude. If omitted, defaults to the system setting. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Capsule CRM Milestone

**Slug:** `CAPSULE_CRM_CREATE_MILESTONE`

Tool to create a new milestone in Capsule CRM. Use when you need to add a new stage to a sales pipeline with defined probability and staleness criteria.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Milestone identifier name. This is the stage name that will be displayed in the sales pipeline. |
| `description` | string | No | Detailed explanation of the milestone. Provides additional context about what this stage represents. |
| `probability` | integer | Yes | Win probability percentage (0-100). Indicates the likelihood of closing deals at this stage. Required field. Note: Must be exactly 0 or 100 if the milestone represents a complete/closed stage. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Opportunity

**Slug:** `CAPSULE_CRM_CREATE_OPPORTUNITY`

Tool to create a new opportunity in Capsule CRM. Use when you need to track a potential sale with a party in the sales pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name/title of the opportunity. Required. |
| `tags` | array | No | Tags to associate with the opportunity. Optional. |
| `party` | object | Yes | Party (person or organisation) associated with this opportunity. Required. |
| `value` | object | No | Value of the opportunity. |
| `fields` | array | No | Custom field values for the opportunity. Optional. |
| `tracks` | array | No | List of tracks to associate with the opportunity. Optional. |
| `duration` | integer | No | Duration value (used with durationBasis). Optional. |
| `milestone` | object | Yes | Milestone in the sales pipeline. Required by API validation. |
| `description` | string | No | Description of the opportunity. Optional. |
| `probability` | integer | No | Probability percentage (0-100) of closing the deal. Optional. |
| `durationBasis` | string | No | Duration basis for the opportunity (e.g., 'DAY', 'WEEK', 'MONTH', 'YEAR'). Optional. |
| `expectedCloseOn` | string | No | Expected close date in ISO date format (YYYY-MM-DD). Optional. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Party to Opportunity

**Slug:** `CAPSULE_CRM_CREATE_OPPORTUNITY_PARTY`

Tool to add a party (person or organisation) to an opportunity in Capsule CRM. Use when you need to associate an additional party with an existing opportunity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `party_id` | integer | Yes | The unique identifier (integer ID) of the party (person or organisation) to add to the opportunity. |
| `opportunity_id` | integer | Yes | The unique identifier (integer ID) of the opportunity to add the party to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Capsule CRM Party

**Slug:** `CAPSULE_CRM_CREATE_PARTY`

Tool to create a Party in Capsule CRM. Use when you have collected a person's or organisation's details and need to add a new record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name for organisation when `type='organisation'`. |
| `tags` | array | No | List of tags to apply to the party. |
| `team` | object | No | Assign team ID or clear by setting `null`. |
| `type` | string ("person" | "organisation") | Yes | Set to 'person' or 'organisation'. |
| `about` | string | No | Free-text description. |
| `owner` | object | No | Assign owner user ID or clear by setting `null`. |
| `title` | string | No | Person title, e.g. 'Mr' or 'Ms'. |
| `fields` | array | No | List of custom fields for the party. |
| `jobTitle` | string | No | Job title for the person. |
| `lastName` | string | No | Required when `type='person'`. |
| `websites` | array | No | List of website URLs for the party. |
| `addresses` | array | No | List of postal addresses for the party. |
| `firstName` | string | No | Required when `type='person'`. |
| `organisation` | object | No | Link a person to an organisation by ID or name. |
| `phoneNumbers` | array | No | List of phone numbers for the party. |
| `emailAddresses` | array | No | List of email addresses for the party. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Project

**Slug:** `CAPSULE_CRM_CREATE_PROJECT`

Tool to create a new project (case) in Capsule CRM. Use when you need to create a project associated with a party (person or organisation) to track work or engagements.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the project. Required. |
| `party` | object | Yes | Party (person or organisation) to associate with the project. Required. |
| `stage` | integer | No | ID of the project stage. Optional. |
| `fields` | array | No | Custom field values for the project. Optional. |
| `status` | string | Yes | Project status. Common values: 'OPEN', 'CLOSED'. Required. |
| `tracks` | array | No | List of tracks to associate with the project. Optional. |
| `description` | string | No | Description of the project. Optional. |
| `opportunity` | object | No | Reference to an existing opportunity. |
| `expectedCloseOn` | string | No | Expected close date in ISO date format (YYYY-MM-DD). Optional. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Stage

**Slug:** `CAPSULE_CRM_CREATE_STAGE`

Tool to create a new stage in a board in Capsule CRM. Use when you need to add a new workflow stage to an existing board with a specific display order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the stage. This identifies the stage within the board. |
| `board` | integer | Yes | The board ID to which this stage belongs. Must be a valid existing board ID. |
| `description` | string | No | A description of what the stage represents. Provides context for the stage's purpose. |
| `displayOrder` | integer | Yes | The position of the stage in the board workflow. Lower numbers appear first. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Task

**Slug:** `CAPSULE_CRM_CREATE_TASK`

Tool to create a new task in Capsule CRM. Use when you need to add a task with a description and due date, optionally linking it to parties, opportunities, or projects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kase` | object | No | Project (case) to associate with the task. Only one of party, opportunity, or kase can be set. |
| `dueOn` | string | Yes | Due date in YYYY-MM-DD format (required) |
| `owner` | object | No | User to assign as task owner (specify by ID) |
| `party` | object | No | Party (contact/organization) to associate with the task. Only one of party, opportunity, or kase can be set. |
| `detail` | string | No | Additional details about the task |
| `repeat` | object | No | Set up recurring task with interval and frequency |
| `dueTime` | string | No | Due time in HH:MM:SS format (e.g., '14:30:00') |
| `category` | object | No | Task category to assign (specify by ID) |
| `description` | string | Yes | Short description of the task (required) |
| `opportunity` | object | No | Opportunity to associate with the task. Only one of party, opportunity, or kase can be set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Capsule CRM Title

**Slug:** `CAPSULE_CRM_CREATE_TITLE`

Tool to create a new custom person title in Capsule CRM. Use when you need to add a new title option (e.g., 'Madam', 'Sir', 'Dr') for person records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `personTitle` | object | Yes | Container object for the title data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Track

**Slug:** `CAPSULE_CRM_CREATE_TRACK`

Tool to create a new track in Capsule CRM by applying a track definition to a project or opportunity. Use when you need to apply a predefined sequence of tasks to a specific entity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kase` | integer | No | The project (kase) ID to apply the track to. Either kase or opportunity must be provided, not both. |
| `definition` | integer | Yes | The track definition ID to apply. Required. |
| `description` | string | No | Custom description for this track instance. Optional. |
| `opportunity` | integer | No | The opportunity ID to apply the track to. Either kase or opportunity must be provided, not both. |
| `trackDateOn` | string | Yes | The date to associate with the track, used to calculate task due dates. Format: YYYY-MM-DD. Required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Track Definition

**Slug:** `CAPSULE_CRM_CREATE_TRACK_DEFINITION`

Tool to create a new track definition in Capsule CRM. Use when you need to define a reusable sequence of tasks for business processes that can be applied to opportunities or projects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Comma-separated tags that will be automatically applied when the track is activated. |
| `direction` | string ("START_DATE") | Yes | Determines the reference point for task timing. Currently only START_DATE is supported. |
| `captureRule` | string ("OPPORTUNITY" | "KASE") | Yes | Specifies where the track can be applied. OPPORTUNITY: track is available for opportunities. KASE: track is available for projects. |
| `description` | string | Yes | Name/title of the track definition. This identifies the track template. |
| `taskDefinitions` | array | Yes | Collection of task definition templates. These define the tasks that will be created when the track is applied to an opportunity or project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Board

**Slug:** `CAPSULE_CRM_DELETE_BOARD`

Tool to delete (archive) a specific board in Capsule CRM. Use when you need to remove a board that is no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | The unique identifier (integer ID) of the board to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Category

**Slug:** `CAPSULE_CRM_DELETE_CATEGORY`

Tool to delete a category from Capsule CRM. Use when you need to remove a category that is no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | string | Yes | The unique identifier of the category to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Custom Field Definition

**Slug:** `CAPSULE_CRM_DELETE_CUSTOM_FIELD_DEFINITION`

Tool to delete a custom field definition from an entity type in Capsule CRM. This removes the field value from any parties, opportunities, or projects it was assigned to. Use when you need to permanently remove a custom field definition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity` | string ("parties" | "opportunities" | "kases") | Yes | The entity type to delete the custom field definition from. Must be one of: parties, opportunities, or kases. |
| `field_id` | integer | Yes | The unique identifier (integer ID) of the custom field definition to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Entity Tag

**Slug:** `CAPSULE_CRM_DELETE_ENTITY_TAG`

Tool to delete a tag from an entity type (parties, opportunities, or kases) in Capsule CRM. Use when you need to remove a specific tag from all entities of a given type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity` | string ("parties" | "opportunities" | "kases") | Yes | The entity type to delete the tag from. Must be one of: 'parties', 'opportunities', or 'kases'. |
| `tag_id` | integer | Yes | The unique numeric identifier of the tag to delete from the entity type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Entry

**Slug:** `CAPSULE_CRM_DELETE_ENTRY`

Tool to delete an entry (note, email, or task) from Capsule CRM. Use when you need to remove an entry by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique ID of the entry to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Lost Reason

**Slug:** `CAPSULE_CRM_DELETE_LOST_REASON`

Tool to delete a lost reason from Capsule CRM. The deleted reason remains available for historical reporting but cannot be assigned to new opportunities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lost_reason_id` | integer | Yes | The unique identifier (integer ID) of the lost reason to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Milestone

**Slug:** `CAPSULE_CRM_DELETE_MILESTONE`

Tool to delete a specific milestone from Capsule CRM. Use when you need to remove a milestone that is no longer needed. Note: Cannot delete a milestone while it is being used on an opportunity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `milestone_id` | integer | Yes | The unique identifier (integer ID) of the milestone to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Opportunity

**Slug:** `CAPSULE_CRM_DELETE_OPPORTUNITY`

Tool to delete an opportunity from Capsule CRM. The opportunity can be restored within 30 days via the web interface. Use when you need to remove an opportunity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `opportunity_id` | integer | Yes | The unique identifier (integer ID) of the opportunity to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Opportunity Party

**Slug:** `CAPSULE_CRM_DELETE_OPPORTUNITY_PARTY`

Tool to remove a party (person or organisation) from an opportunity in Capsule CRM. Use when you need to disassociate a contact from a specific opportunity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `party_id` | integer | Yes | The unique identifier (integer ID) of the person or organisation to remove from the opportunity. |
| `opportunity_id` | integer | Yes | The unique identifier (integer ID) of the opportunity from which to remove the party. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Party

**Slug:** `CAPSULE_CRM_DELETE_PARTY`

Tool to fully delete a specific party (person or organisation) from Capsule CRM. Use when you need to completely remove a party after confirming no active references remain.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `party_id` | integer | Yes | The unique identifier (integer ID) of the party (person or organisation) to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project

**Slug:** `CAPSULE_CRM_DELETE_PROJECT`

Tool to delete a project (case) from Capsule CRM. The project can be restored within 30 days via the web interface. Use when you need to remove a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | The unique identifier (integer ID) of the project to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project Party

**Slug:** `CAPSULE_CRM_DELETE_PROJECT_PARTY`

Tool to remove a party (person or organisation) from a project in Capsule CRM. Use when you need to disassociate a contact from a specific project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `party_id` | integer | Yes | The unique identifier (integer ID) of the person or organisation to remove from the project. |
| `project_id` | integer | Yes | The unique identifier (integer ID) of the project from which to remove the party. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Stage

**Slug:** `CAPSULE_CRM_DELETE_STAGE`

Tool to delete a specific stage from a board in Capsule CRM. Use when you need to remove a stage that is no longer needed. Note: Cannot delete a stage while it is being used by open projects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stage_id` | integer | Yes | The unique identifier (integer ID) of the stage to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Task

**Slug:** `CAPSULE_CRM_DELETE_TASK`

Tool to delete a specific task from Capsule CRM. Use when you need to remove a task by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | integer | Yes | The unique identifier (integer ID) of the task to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Title

**Slug:** `CAPSULE_CRM_DELETE_TITLE`

Tool to delete a specific title from Capsule CRM. Use when you need to remove a title that is no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title_id` | integer | Yes | The unique identifier (integer ID) of the title to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Track

**Slug:** `CAPSULE_CRM_DELETE_TRACK`

Tool to delete a specific track from Capsule CRM. Use when you need to remove a track that is no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `track_id` | integer | Yes | The unique identifier (integer ID) of the track to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Track Definition

**Slug:** `CAPSULE_CRM_DELETE_TRACK_DEFINITION`

Tool to delete a specific track definition from Capsule CRM. Use when you need to remove a track definition that is no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `track_definition_id` | integer | Yes | The unique identifier (integer ID) of the track definition to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Activity Type

**Slug:** `CAPSULE_CRM_GET_ACTIVITY_TYPE`

Tool to get a specific activity type by ID. Use when you need to retrieve details about a particular activity type including its name, icon, and whether it updates the last contacted date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `activityTypeId` | integer | Yes | The unique ID of the activity type to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Attachment

**Slug:** `CAPSULE_CRM_GET_ATTACHMENT`

Tool to retrieve a specific attachment by ID from Capsule CRM. Returns the file content along with metadata (filename, content type). Use when you need to download an attachment that is associated with an entry (note, email, or completed task).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachment_id` | integer | Yes | The unique identifier of the attachment to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Board

**Slug:** `CAPSULE_CRM_GET_BOARD`

Tool to get a specific board by ID from Capsule CRM. Use when you need to retrieve details of a particular board including its name, description, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `boardId` | integer | Yes | The unique identifier of the board to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Category

**Slug:** `CAPSULE_CRM_GET_CATEGORY`

Tool to get a specific category by ID. Use when you need to retrieve details of a particular category including its name and colour.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `categoryId` | integer | Yes | The unique identifier of the category to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current User

**Slug:** `CAPSULE_CRM_GET_CURRENT_USER`

Tool to retrieve the current authenticated user's details including id, username, name, locale, currency, status, timezone, lastLoginAt, and taskReminder settings. Use when you need to identify the current user or access their preferences and settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | array | No | List of additional data to embed. Use ['party'] to include full party details (addresses, phone numbers, email addresses, etc.). Without this parameter, only basic party info is returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Field Definition

**Slug:** `CAPSULE_CRM_GET_CUSTOM_FIELD_DEFINITION`

Tool to get a specific custom field definition by ID from Capsule CRM. Use when you need to retrieve details about a custom field including its type, options, and configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity` | string ("parties" | "opportunities" | "kases") | Yes | Entity type - must be 'parties', 'opportunities', or 'kases'. |
| `field_id` | integer | Yes | The unique identifier of the custom field definition. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Entity Tag

**Slug:** `CAPSULE_CRM_GET_ENTITY_TAG`

Tool to retrieve a specific tag by ID for an entity type (parties, opportunities, or kases) in Capsule CRM. Use when you need details about a specific tag associated with an entity type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity` | string ("parties" | "opportunities" | "kases") | Yes | The entity type to retrieve the tag from. Must be one of: 'parties', 'opportunities', or 'kases'. |
| `tag_id` | integer | Yes | The unique numeric identifier of the tag to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Entry

**Slug:** `CAPSULE_CRM_GET_ENTRY`

Tool to retrieve a specific entry by ID. Use when you need to fetch details of a note, email, or task entry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique ID of the entry to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Lost Reason

**Slug:** `CAPSULE_CRM_GET_LOST_REASON`

Tool to retrieve a specific lost reason by ID from Capsule CRM. Use when you need details about a particular lost reason, such as its name or conversion tracking status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lostReasonId` | integer | Yes | Numeric identifier for the specific lost reason to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Milestone

**Slug:** `CAPSULE_CRM_GET_MILESTONE`

Tool to get a specific milestone by ID from Capsule CRM. Use when you need to retrieve details of a particular milestone including its name, description, completion status, and probability.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `milestone_id` | integer | Yes | The unique identifier of the milestone to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Opportunity

**Slug:** `CAPSULE_CRM_GET_OPPORTUNITY`

Tool to retrieve a specific opportunity by its ID from Capsule CRM. Use when you need detailed information about a single opportunity including value, milestone, and associated parties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `opportunity_id` | integer | Yes | The unique ID of the opportunity to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Pipeline

**Slug:** `CAPSULE_CRM_GET_PIPELINE`

Tool to get a specific pipeline by ID from Capsule CRM. Use when you need to retrieve details of a particular pipeline including its name, description, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pipelineId` | integer | Yes | The unique identifier of the pipeline to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project

**Slug:** `CAPSULE_CRM_GET_PROJECT`

Tool to retrieve a specific project (case) by its ID from Capsule CRM. Use when you need detailed information about a single project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | The unique ID of the project to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stage

**Slug:** `CAPSULE_CRM_GET_STAGE`

Tool to get a specific stage by ID from Capsule CRM. Use when you need to retrieve details of a particular stage including its name, description, board, and display order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stageId` | integer | Yes | The unique identifier of the stage to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Task

**Slug:** `CAPSULE_CRM_GET_TASK`

Tool to get a specific task by ID. Use when you need to retrieve full details of a task including description, due date, status, and associations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | The unique ID of the task to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Track

**Slug:** `CAPSULE_CRM_GET_TRACK`

Tool to get a specific track by ID. Use when you need to retrieve details of a track including its description, date, direction, and optionally its associated tasks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | array | No | Array of strings to include related data. Allowed value: 'task' to include tasks associated with the track. |
| `trackId` | integer | Yes | The unique identifier of the track to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Track Definition

**Slug:** `CAPSULE_CRM_GET_TRACK_DEFINITION`

Tool to get a specific track definition by ID from Capsule CRM. Use when you need to retrieve details of a track definition including its description, capture rule, direction, and associated task definitions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trackDefinitionId` | integer | Yes | The unique identifier of the track definition to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User

**Slug:** `CAPSULE_CRM_GET_USER`

Tool to get a specific user by ID. Use when you need to retrieve full details of a user including username, email preferences, timezone settings, and optionally their associated party information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | array | No | List of additional data to embed. Use ['party'] to include full party details (createdAt, updatedAt, owner, team, addresses, phoneNumbers, emailAddresses, websites). Without this parameter, only basic party info (id, type, name, pictureURL) is returned. |
| `userId` | integer | Yes | The unique ID of the user to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Activity Type Icons

**Slug:** `CAPSULE_CRM_LIST_ACTIVITY_TYPE_ICONS`

Tool to list available activity type icons in Capsule CRM. Use when you need to retrieve the set of icons available for categorizing activities or when creating/updating activity types. Returns system and custom icons with their identifiers, display names, and order.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Activity Types

**Slug:** `CAPSULE_CRM_LIST_ACTIVITY_TYPES`

Tool to list all activity types on the Capsule account. Use when you need to retrieve available activity types for categorizing activities or understanding what activity classifications are available in the CRM.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Boards

**Slug:** `CAPSULE_CRM_LIST_BOARDS`

Tool to list all boards on the Capsule CRM account. Use when you need to fetch all boards to view their names, descriptions, and metadata.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Board Stages

**Slug:** `CAPSULE_CRM_LIST_BOARD_STAGES`

Tool to list stages associated with a board in Capsule CRM. Use when you need to retrieve all stages for a specific board with optional status filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Pagination control. Starts at 1. Default: 1. |
| `status` | string ("active" | "archived" | "all") | No | Status filter for stages. |
| `boardId` | integer | Yes | The unique identifier of the board. |
| `perPage` | integer | No | Results per page (1-100 range). Default: 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Categories

**Slug:** `CAPSULE_CRM_LIST_CATEGORIES`

Tool to list all task categories on the Capsule account. Use when you need to retrieve available categories for tasks or filter tasks by category.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Countries

**Slug:** `CAPSULE_CRM_LIST_COUNTRIES`

Tool to list all countries on the Capsule CRM account. Returns ISO country codes (alpha2, alpha3, numeric) and country names. Use when you need to reference valid country codes for addresses or other location-based data.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Currencies

**Slug:** `CAPSULE_CRM_LIST_CURRENCIES`

Tool to list all available currencies on the Capsule account. Returns ISO 4217 currency codes with their symbols and names. Use when you need to display currency options or validate currency codes for opportunities.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Custom Field Definitions

**Slug:** `CAPSULE_CRM_LIST_CUSTOM_FIELD_DEFINITIONS`

Tool to list all custom field definitions for parties, opportunities, or projects (kases). Use when you need to discover what custom fields are available for a specific entity type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity` | string ("parties" | "opportunities" | "kases") | Yes | Entity type to retrieve field definitions for. Must be 'parties', 'opportunities', or 'kases' (projects). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deleted Opportunities

**Slug:** `CAPSULE_CRM_LIST_DELETED_OPPORTUNITIES`

Tool to list opportunities deleted or restricted since a given date. Use when you need to identify recently deleted or restricted opportunities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since` | string | Yes | ISO8601 date/time. Returns only opportunities that have been deleted or made restricted after this date. This parameter is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List deleted parties

**Slug:** `CAPSULE_CRM_LIST_DELETED_PARTIES`

Tool to retrieve parties deleted since a given date. Use when you need to sync deletions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since` | string | Yes | The since date is required to return only entities that have been deleted after this date. Must be in ISO8601 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deleted Projects

**Slug:** `CAPSULE_CRM_LIST_DELETED_PROJECTS`

Tool to list projects deleted or restricted since a given date. Use when you need to identify recently deleted or restricted projects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since` | string | Yes | ISO8601 date/time. Returns only projects that have been deleted or made restricted after this date. This parameter is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Entity Entries

**Slug:** `CAPSULE_CRM_LIST_ENTITY_ENTRIES`

Tool to list entries (notes, emails, tasks) for a specific party, opportunity, or project. Use when you need to retrieve all activity entries associated with an entity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default: 1 |
| `embed` | array | No | List of additional data to embed in the response. Allowed values: 'party' (linked party), 'kase' (linked project), 'opportunity' (linked opportunity), 'creator' (user who created entry), 'activityType' (activity classification). |
| `entity` | string ("parties" | "opportunities" | "kases") | Yes | Entity type to list entries for: 'parties' (contacts), 'opportunities' (deals), or 'kases' (projects) |
| `perPage` | integer | No | Number of entries to return per page (1-50). Default: 50 |
| `entityId` | integer | Yes | ID of the party, opportunity, or project to list entries for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Entity Tags

**Slug:** `CAPSULE_CRM_LIST_ENTITY_TAGS`

Tool to list all tag definitions for a specific entity type (parties, opportunities, or kases). Use when you need to retrieve available tags that can be applied to entities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity` | string ("parties" | "opportunities" | "kases") | Yes | Entity type to list tags for. Must be one of: 'parties' (contacts), 'opportunities' (sales opportunities), or 'kases' (projects). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Entity Tracks

**Slug:** `CAPSULE_CRM_LIST_ENTITY_TRACKS`

Tool to list tracks applied to a specific opportunity or project. Use when you need to retrieve all tracks associated with an entity, optionally including their tasks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. Default: 1. |
| `embed` | array | No | Array of strings to include related data. Allowed value: 'task' to include tasks associated with the track. |
| `entity` | string ("opportunities" | "kases") | Yes | Entity type - must be 'opportunities' or 'kases' (projects) |
| `perPage` | integer | No | Number of results per page (1-100). Default: 50. |
| `entityId` | integer | Yes | The unique identifier for the specific opportunity or project |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Entries By Date

**Slug:** `CAPSULE_CRM_LIST_ENTRIES_BY_DATE`

Tool to list notes, emails, and completed party tasks in descending order by entry date. Use when you need the most recent entries first after authenticating.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. Default: 1 |
| `embed` | array | No | List of additional data to embed in the response. Allowed values: 'party' (linked party), 'kase' (linked project), 'opportunity' (linked opportunity), 'creator' (user who created entry), 'activityType' (activity classification). |
| `perPage` | integer | No | The number of entries to return per page (1-100). Default: 50 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Goals

**Slug:** `CAPSULE_CRM_LIST_GOALS`

Tool to list all goals on the Capsule account. Use when you need to retrieve goals with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. Default: 1. |
| `perPage` | integer | No | Number of goals per page (1-100). Default: 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Lost Reasons

**Slug:** `CAPSULE_CRM_LIST_LOST_REASONS`

Tool to list all lost reasons on the Capsule account. Use when you need to retrieve available reasons for marking opportunities as lost.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Milestones

**Slug:** `CAPSULE_CRM_LIST_MILESTONES`

Tool to list all milestones on the Capsule account. Use when you need to retrieve available milestones for pipelines or opportunities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. Default: 1. |
| `perPage` | integer | No | Number of milestones per page (1-100). Default: 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Opportunities

**Slug:** `CAPSULE_CRM_LIST_OPPORTUNITIES`

Tool to list all opportunities from Capsule CRM with pagination and filtering. Use when you need to retrieve sales opportunities with optional filters for date changes or embed additional data like tags, custom fields, party details, or milestones.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return (starts at 1). Default: 1. |
| `embed` | array | No | List of additional data to embed. Allowed values: 'tags', 'fields', 'party', 'milestone', 'missingImportantFields'. |
| `since` | string | No | Include only opportunities changed after this date (ISO8601 format, e.g., '2024-01-01T00:00:00Z'). |
| `perPage` | integer | No | Number of opportunities per page (1-100). Default: 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Opportunity Parties

**Slug:** `CAPSULE_CRM_LIST_OPPORTUNITY_PARTIES`

Tool to list additional parties associated with an opportunity in Capsule CRM. Use when you need to retrieve contacts related to a specific opportunity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number of results to return (>=1). Default: 1. |
| `embed` | array | No | List of additional data to embed. Allowed values: 'tags', 'fields', 'organisation', 'missingImportantFields'. |
| `perPage` | integer | No | Number of parties per page (1-100). Default: 50. |
| `opportunityId` | integer | Yes | The unique identifier of the opportunity to list parties for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Opportunity Projects

**Slug:** `CAPSULE_CRM_LIST_OPPORTUNITY_PROJECTS`

Tool to list projects (cases) associated with a specific opportunity in Capsule CRM. Use when you need to retrieve all projects linked to an opportunity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return (starts at 1). Default: 1. |
| `embed` | string | No | Comma-separated list of additional data to embed. Options: 'tags', 'fields', 'party', 'opportunity', 'missingImportantFields'. |
| `perPage` | integer | No | Number of projects per page (1-100). Default: 50. |
| `opportunityId` | integer | Yes | The unique identifier of the opportunity to retrieve projects for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Organisation Employees

**Slug:** `CAPSULE_CRM_LIST_ORG_EMPLOYEES`

Tool to list employees linked to a specific organisation (party). Use when you need to retrieve all employees under a given organisation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number of results to return, must be at least 1 |
| `embed` | array | No | List of additional data to include; allowed values: 'tags', 'fields', 'organisation', 'missingImportantFields' |
| `perPage` | integer | No | Number of results per page, must be between 1 and 100 |
| `party_id` | integer | Yes | ID of the organisation (party) to list employees for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Parties

**Slug:** `CAPSULE_CRM_LIST_PARTIES`

Tool to list all parties (contacts) on the account. Use when you need to fetch contacts with optional filters or embed additional related data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number of results to return (>=1). Default: 1. |
| `embed` | array | No | Comma-separated list of additional data to embed. Allowed values: 'tags', 'fields', 'organisation', 'missingImportantFields'. |
| `since` | string | No | Include only parties changed after this date (ISO8601 format). |
| `perPage` | integer | No | Number of parties per page (1-100). Default: 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Party Opportunities

**Slug:** `CAPSULE_CRM_LIST_PARTY_OPPORTUNITIES`

Tool to list all opportunities associated with a specific party in Capsule CRM. Use when you need to view all sales opportunities for a particular contact or organisation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `partyId` | integer | Yes | The ID of the party to list opportunities for. Required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Party Projects

**Slug:** `CAPSULE_CRM_LIST_PARTY_PROJECTS`

Tool to list projects associated with a specific party in Capsule CRM. Use when you need to retrieve all projects linked to a contact or organisation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return (starts at 1). Default: 1. |
| `embed` | string | No | Comma-separated list of additional data to embed. Options: 'tags', 'fields', 'party', 'opportunity', 'missingImportantFields'. |
| `partyId` | integer | Yes | The unique identifier of the party to retrieve projects for. |
| `perPage` | integer | No | Number of projects per page (1-100). Default: 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pipeline Milestones

**Slug:** `CAPSULE_CRM_LIST_PIPELINE_MILESTONES`

Tool to list milestones associated with a specific pipeline in Capsule CRM. Use when you need to retrieve all milestones for a pipeline to view their names, completion status, and probability.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. Default: 1. |
| `perPage` | integer | No | Number of milestones per page (1-100). Default: 50. |
| `pipelineId` | integer | Yes | The unique identifier of the pipeline. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pipelines

**Slug:** `CAPSULE_CRM_LIST_PIPELINES`

Tool to list all sales pipelines on the Capsule account. Pipelines contain milestones that track opportunity progress. Use when you need to retrieve available pipelines for opportunity management or to reference pipeline IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. Default: 1. |
| `perPage` | integer | No | Number of pipelines per page (1-100). Default: 50. |
| `includeDeleted` | boolean | No | Include archived/deleted pipelines in results. Default: false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Project Parties

**Slug:** `CAPSULE_CRM_LIST_PROJECT_PARTIES`

Tool to list parties associated with a specific project in Capsule CRM. Use when you need to retrieve all contacts linked to a project with optional filters and embedded data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return (starts at 1). Default: 1. |
| `embed` | array | No | Request additional data to embed. Allowed values: 'tags', 'fields', 'organisation', 'missingImportantFields'. |
| `perPage` | integer | No | Number of parties per page (1-100). Default: 50. |
| `projectId` | integer | Yes | The unique identifier of the project to retrieve parties for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `CAPSULE_CRM_LIST_PROJECTS`

List projects (cases) from Capsule CRM with pagination and filtering options. Projects (called 'kases' in the API) are used to track work or engagements related to parties. Supports filtering by status, search terms, date modified, and embedding additional data like tags, custom fields, party details, and opportunities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return (starts at 1). Default: 1. |
| `embed` | string | No | Comma-separated list of additional data to embed. Options: 'tags', 'fields', 'party', 'opportunity', 'missingImportantFields'. |
| `since` | string | No | ISO8601 date/datetime to filter projects modified after this date (e.g., '2024-01-01T00:00:00Z'). |
| `search` | string | No | Search term to filter project names or descriptions. |
| `status` | string | No | Filter by project status (e.g., 'OPEN', 'CLOSED'). |
| `perPage` | integer | No | Number of projects per page (1-100). Default: 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List REST Hooks

**Slug:** `CAPSULE_CRM_LIST_REST_HOOKS`

Tool to list all REST hook subscriptions on the Capsule CRM account. REST hooks are webhook subscriptions that notify your application of events like party/opportunity/project created/updated/deleted. Use when you need to view existing webhook configurations or audit active subscriptions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Site

**Slug:** `CAPSULE_CRM_LIST_SITE`

Tool to retrieve site (account) information for the authenticated Capsule CRM account. Returns the site URL, subdomain, and organization name. Use this when you need to identify which Capsule account is being accessed or retrieve basic account details.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Stages

**Slug:** `CAPSULE_CRM_LIST_STAGES`

Tool to list all stages on the Capsule CRM account. Use when you need to retrieve stages across all boards with optional status filtering and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Specifies which results page to retrieve. Default: 1. |
| `status` | string ("active" | "archived" | "all") | No | Status filter for stages. |
| `perPage` | integer | No | Sets the number of results per page (1-100 range). Default: 50. |
| `includeOnDeletedBoard` | boolean | No | When true, returns stages residing on archived boards. Default is false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tasks

**Slug:** `CAPSULE_CRM_LIST_TASKS`

Tool to list tasks on the Capsule account. Use when you need to retrieve tasks with filters or embedded related data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. Default: 1. |
| `embed` | array | No | Comma-separated list of additional data to embed. Allowed values: 'party', 'opportunity', 'kase', 'owner', 'nextTask'. |
| `status` | array | No | Comma-separated list of task statuses to filter by. Allowed values: 'open', 'completed', 'pending'. |
| `perPage` | integer | No | Number of tasks per page (1-100). Default: 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Teams

**Slug:** `CAPSULE_CRM_LIST_TEAMS`

Tool to list all teams on the Capsule CRM account. Returns team details including id, name, createdAt, and updatedAt timestamps. Optionally embed team membership information using the embed parameter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | string | No | Additional data to include in the response. Use 'memberships' to include team members information. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Titles

**Slug:** `CAPSULE_CRM_LIST_TITLES`

Tool to list all custom person titles on the Capsule account. Returns title IDs and text values. Use when you need to retrieve available title options for person records or reference title IDs for other operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Track Definitions

**Slug:** `CAPSULE_CRM_LIST_TRACK_DEFINITIONS`

Tool to list all track definitions on the Capsule account. Use when you need to retrieve track templates that define sequences of tasks for opportunities or projects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to return. Default: 1. |
| `perPage` | integer | No | Number of track definitions per page (1-100). Default: 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `CAPSULE_CRM_LIST_USERS`

List all users on the Capsule CRM account. Returns user details including id, username, name, locale, currency, status, timezone, lastLoginAt, and taskReminder settings. Optionally embed full party details (addresses, phone numbers, emails) using the embed parameter. Use this for user management, auditing, or when you need to reference user IDs for other operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | array | No | List of additional data to embed. Use ['party'] to include full party details (createdAt, updatedAt, owner, team, addresses, phoneNumbers, emailAddresses, websites). Without this parameter, only basic party info (id, type, name, pictureURL) is returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore Board

**Slug:** `CAPSULE_CRM_RESTORE_BOARD`

Tool to restore a deleted board in Capsule CRM. Use when you need to recover a previously deleted board. Requires Administrator role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | The unique identifier (integer ID) of the board to restore. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Filter Query

**Slug:** `CAPSULE_CRM_RUN_FILTER_QUERY`

Tool to run structured filter queries on parties, opportunities or kases. Use when you need to retrieve entities matching specific filter conditions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to return. Default is 1. |
| `embed` | array | No | Additional data to include, comma-separated list. Supported values vary by entity. |
| `entity` | string ("parties" | "opportunities" | "kases") | Yes | Entity type to filter: parties, opportunities, or kases (projects). |
| `filter` | object | Yes | Filter object containing conditions and optional sort order. |
| `perPage` | integer | No | Number of entities per page (1-100). Default is 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Opportunities

**Slug:** `CAPSULE_CRM_SEARCH_OPPORTUNITIES`

Tool to search for opportunities in Capsule CRM by query string. Use when you need to find specific opportunities by searching their names or descriptions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | The search query string to match against opportunity names and descriptions. |
| `page` | integer | No | The page of results to return (starts at 1). Default: 1. |
| `perPage` | integer | No | Number of opportunities per page (1-100). Default: 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Parties

**Slug:** `CAPSULE_CRM_SEARCH_PARTIES`

Tool to search for parties (contacts/organisations) in Capsule CRM by query string. Use when you need to find specific parties by searching their names, contact info, or tags.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | The search query string to match against party names, contact info, and tags. |
| `page` | integer | No | The page of results to return (starts at 1). Default: 1. |
| `perPage` | integer | No | Number of parties per page (1-100). Default: 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Projects

**Slug:** `CAPSULE_CRM_SEARCH_PROJECTS`

Tool to search for projects (cases) in Capsule CRM by query string. Use when you need to find specific projects by searching their names or descriptions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | The search query string to match against project names and descriptions. |
| `page` | integer | No | The page of results to return (starts at 1). Default: 1. |
| `perPage` | integer | No | Number of projects per page (1-100). Default: 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Capsule CRM Board

**Slug:** `CAPSULE_CRM_UPDATE_BOARD`

Tool to update an existing board in Capsule CRM. Use when you need to modify the name or description of a board. Requires Administrator role on the Capsule account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board` | object | Yes | Board object containing fields to update |
| `boardId` | integer | Yes | The ID of the board to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Capsule CRM Category

**Slug:** `CAPSULE_CRM_UPDATE_CATEGORY`

Tool to update an existing category in Capsule CRM. Use when you need to modify the name or color of a category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category` | object | Yes | Category object with fields to update (name and/or colour) |
| `categoryId` | integer | Yes | The ID of the category to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Custom Field Definition

**Slug:** `CAPSULE_CRM_UPDATE_CUSTOM_FIELD_DEFINITION`

Tool to update an existing custom field definition in Capsule CRM. Use when you need to modify the name or data tag association of a custom field for parties, opportunities, or projects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity` | string ("parties" | "opportunities" | "kases") | Yes | The entity type to update the custom field definition for. Must be one of: parties, opportunities, or kases. |
| `field_id` | integer | Yes | The unique identifier (integer ID) of the custom field definition to update. |
| `definition` | object | Yes | Field definition object containing the updated name and optionally a data tag |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Entity Tag

**Slug:** `CAPSULE_CRM_UPDATE_ENTITY_TAG`

Tool to update an existing tag for an entity type (parties, opportunities, or kases) in Capsule CRM. Use when you need to modify the name of a tag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | object | Yes | Tag object with fields to update (name) |
| `entity` | string ("parties" | "opportunities" | "kases") | Yes | The entity type to update the tag for. Must be one of: 'parties', 'opportunities', or 'kases'. |
| `tag_id` | integer | Yes | The unique numeric identifier of the tag to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Entry

**Slug:** `CAPSULE_CRM_UPDATE_ENTRY`

Tool to update an existing entry (note, email, or task) in Capsule CRM. Use when you need to modify the content of an entry or manage its attachments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique ID of the entry to update |
| `entry` | object | Yes | Fields to update on the entry object |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Capsule CRM Lost Reason

**Slug:** `CAPSULE_CRM_UPDATE_LOST_REASON`

Tool to update an existing lost reason in Capsule CRM. Use when you need to modify the name or conversion tracking setting of a lost reason after confirming its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lostReason` | object | Yes | Lost reason object containing name and includedForConversion fields |
| `lostReasonId` | integer | Yes | The ID of the lost reason to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Capsule CRM Milestone

**Slug:** `CAPSULE_CRM_UPDATE_MILESTONE`

Tool to update an existing milestone in Capsule CRM. Use when you need to modify the name, description, or probability of a milestone stage in the sales pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `milestone` | object | Yes | Milestone object containing fields to update |
| `milestoneId` | integer | Yes | The unique identifier of the milestone to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Opportunity

**Slug:** `CAPSULE_CRM_UPDATE_OPPORTUNITY`

Tool to update an existing opportunity in Capsule CRM. Use when you need to modify details such as name, value, milestone, probability, or custom fields after confirming the opportunity ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `opportunity` | object | Yes | Fields to update on the opportunity object |
| `opportunityId` | integer | Yes | Unique ID of the opportunity to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Capsule CRM Party

**Slug:** `CAPSULE_CRM_UPDATE_PARTY`

Tool to update an existing person or organisation (Party) in Capsule CRM. Use when you need to modify specific fields of a party after confirming its ID. Example: "Update party 11587 to remove phone number 12136 and add a new work email."

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | array | No | Additional data to embed in response: tags, fields, organisation, or missingImportantFields |
| `party` | object | Yes | Fields to update on the party object |
| `partyId` | integer | Yes | Unique ID of the party to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Capsule CRM Pipeline

**Slug:** `CAPSULE_CRM_UPDATE_PIPELINE`

Tool to update an existing pipeline in Capsule CRM. Use when you need to modify the name or description of a pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pipeline` | object | Yes | Pipeline object containing fields to update. Only included fields are modified. |
| `pipelineId` | integer | Yes | The unique identifier of the pipeline to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project

**Slug:** `CAPSULE_CRM_UPDATE_PROJECT`

Tool to update an existing project (case) in Capsule CRM. Use when you need to modify project details such as name, description, status, or custom fields after confirming the project ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kase` | object | Yes | Fields to update on the project object |
| `embed` | string | No | Comma-separated list of additional data to embed. Options: 'tags', 'fields', 'party', 'opportunity', 'missingImportantFields'. |
| `projectId` | integer | Yes | Unique ID of the project to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Capsule CRM Stage

**Slug:** `CAPSULE_CRM_UPDATE_STAGE`

Tool to update an existing stage in Capsule CRM. Use when you need to modify the name, description, or display order of a stage within a board. Requires Administrator role on the Capsule account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stage` | object | Yes | Stage object containing updatable fields |
| `stageId` | integer | Yes | The identifier of the stage to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Task

**Slug:** `CAPSULE_CRM_UPDATE_TASK`

Tool to update an existing task in Capsule CRM. Use when you need to modify task details, change status to completed, or update due dates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task` | object | Yes | Fields to update on the task object |
| `taskId` | integer | Yes | The unique ID of the task to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Capsule CRM Track

**Slug:** `CAPSULE_CRM_UPDATE_TRACK`

Tool to update an existing track in Capsule CRM. Use when you need to modify the description or trackDateOn of a track instance. Only description and trackDateOn can be modified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed` | array | No | Additional data to embed in response. Use 'task' to include tasks on the track. |
| `track` | object | Yes | Track object containing fields to update |
| `trackId` | integer | Yes | The unique identifier of the track to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Capsule CRM Track Definition

**Slug:** `CAPSULE_CRM_UPDATE_TRACK_DEFINITION`

Tool to update an existing track definition in Capsule CRM. Use when you need to modify the description or manage task definitions within a track.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trackDefinition` | object | Yes | Track definition object with fields to update (description and/or taskDefinitions) |
| `trackDefinitionId` | integer | Yes | The ID of the track definition to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User

**Slug:** `CAPSULE_CRM_UPDATE_USER`

Tool to update an existing user in Capsule CRM. Use when you need to modify user preferences such as task reminders, locale, currency, timezone, or email settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | object | Yes | User fields to update |
| `embed` | string | No | Comma-separated values to include additional data. Supported value: 'party' to include full party details |
| `userId` | integer | Yes | The unique ID of the user to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Attachment

**Slug:** `CAPSULE_CRM_UPLOAD_ATTACHMENT`

Tool to upload an attachment to Capsule CRM. Returns a token that can be used to associate the attachment with entries when creating or updating them. Maximum file size is 25MB.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | File to upload. Maximum file size is 25MB. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |