Capsule CRM

Capsule CRM Delete Opportunity

Permanently delete a sales opportunity from Capsule CRM by its ID. This is a destructive, irreversible action — the opportunity and its associations are removed. Use this to clean up test data, remove duplicate records, or discard opportunities that were created in error. The API returns an empty response on success (HTTP 204). Example: delete opportunity 4321 after confirming it is a duplicate of opportunity 4320.

Capsule CRM Delete Party

Permanently delete a party (person or organisation) from Capsule CRM by its numeric ID. This is an irreversible operation — the party record and all directly owned data (notes, history entries owned solely by this party) will be removed. Use with caution; prefer archiving or merging when the contact may still be needed for historical reference.

Capsule CRM Delete Project

Permanently delete a project (case) from Capsule CRM by its ID. This is a destructive, irreversible action — the project and its associations are removed. Use this to clean up test data, remove duplicate records, or discard projects that were created in error. The API returns an empty response on success (HTTP 204). Example: delete project 5678 after confirming it is a duplicate of project 5677.

Capsule CRM Delete Task

Permanently delete a task from Capsule CRM by its ID. Use this tool when a task is no longer relevant and should be removed entirely rather than marked as completed. This action is irreversible — the task and its history will be permanently removed from the CRM. Example: delete task 42 by passing taskId=42.

Capsule CRM List Activity Types

Retrieve all activity types defined in Capsule CRM for tracking various engagement forms like meetings, calls, emails, or notes. Use this when you need to see what activity categories are available before logging an interaction, or when building activity reports. Returns type details including IDs, names, and icons. Example: call this to discover available types like 'Phone Call', 'Meeting', 'Email' before recording a new activity on a contact.

Capsule CRM List Boards

Retrieve all project boards defined in your Capsule CRM account. Use this when you need to see available boards for organizing projects or cases, or to find a board's ID before querying its stages. Returns board details including IDs, names, and descriptions. Example: call this to discover all boards, then use list_stages_by_board to inspect a specific board's workflow.

Capsule CRM List Categories

List all available categories for organizing records in Capsule CRM, such as contact types (Customer, Vendor, Partner) or project types. Use this when setting up or refining organizational structures, or when you need a category ID to assign to a record. Returns category details including IDs, names, and colours. Example: call this to see all categories before tagging a new contact as 'Customer' or 'Lead'.

Capsule CRM List Countries

Retrieve the list of all countries recognized by Capsule CRM. Use this when you need valid country names for populating address fields on contacts or organizations, or for validating country input before creating/updating records. Returns the full list of country names. Example: call this to get the exact country name format Capsule expects before setting a contact's address.

Capsule CRM List Currencies

Retrieve all currencies supported by Capsule CRM. Use this when you need to know which currency codes are valid for opportunity values, or to present currency options in a form. Returns currency details including codes and names. Example: call this to confirm that 'USD', 'GBP', or 'EUR' are available before setting a monetary value on an opportunity.

Capsule CRM List Custom Fields

Retrieve custom field definitions for a specific entity type in Capsule CRM. Use this when you need to understand what custom data is tracked on contacts, opportunities, or projects, or when building forms that need to match the CRM schema. Specify the entity parameter: 'parties' for contacts/organizations, 'opportunities' for sales deals, or 'kases' for projects. Returns field definitions including IDs, names, types, and visibility settings. Example: pass entity='parties' to see all custom fiel

Capsule CRM List Employees

Retrieve a paginated list of all people (employees) linked to a specific organisation in Capsule CRM. Use this when you have an organisation's party ID and need to see every person associated with it — for example, to find the right contact at a company or to audit team membership. Returns person records including IDs, names, job titles, and contact details.

Capsule CRM List Entries

Retrieve a paginated list of history/note entries attached to a party, opportunity, or case in Capsule CRM. Entries record interactions such as notes, emails, meetings, and phone calls linked to a specific record. Use this tool when you need to review the activity history of a contact, deal, or project. Specify the parent entity type (parties, opportunities, or kases) and its ID. Returns entry details including type, content, timestamps, and creator info. Example: list all entries for party 123

Capsule CRM List Goals

Retrieve all goals defined in your Capsule CRM account. Goals track sales targets and performance metrics for teams and individuals. Use this when you need to review current targets, build performance dashboards, or audit goal configurations. Returns goal details including IDs, names, targets, and progress. Example: call this to see all active sales goals like 'Q1 Revenue Target' or 'Monthly New Deals' and their current progress.

Capsule CRM List Lost Reasons

List all predefined reasons for lost sales opportunities in Capsule CRM. Use this when analyzing why deals are being lost, building reports on loss patterns, or preparing to mark an opportunity as lost. Returns lost reason details including IDs and names. Example: call this to see reasons like 'Price too high', 'Went with competitor', 'No budget' before recording a loss.

Capsule CRM List Milestones

List all milestones across every sales pipeline in your Capsule CRM account. Use this when you need a global view of all pipeline milestones, their probabilities, and sequencing. Returns milestone details including IDs, names, probability percentages, and the pipeline they belong to. Example: call this to audit milestone definitions across all pipelines or find a milestone ID for filtering opportunities.

Capsule CRM List Milestones By Pipeline

Retrieve all milestones for a specific sales pipeline by its ID. Use this when you need to see the stages within one particular pipeline, such as understanding the deal progression from lead to close. More targeted than the global list_milestones endpoint. Returns milestone details including names, probabilities, and sequence order. Example: pass pipelineId=42 to see milestones like 'Qualified', 'Proposal Sent', 'Won' for that pipeline.

Capsule CRM List Opportunities

Retrieve a paginated list of all sales opportunities in Capsule CRM. Use this to audit the sales pipeline, build reports on open deals, or sync opportunity data to external systems. Supports filtering by modification date via 'since' for incremental syncs, and embedding related resources (tags, fields, party, milestone) to enrich results in a single call. Returns an array of opportunity objects with IDs, names, values, milestones, and expected close dates. Example: list all opportunities modifie

Capsule CRM List Opportunities By Party

Retrieve all sales opportunities associated with a specific party (contact or organisation) in Capsule CRM. Use this to see every deal linked to a particular customer or company, enabling account-level pipeline reviews. Supports pagination and embedding related resources for enriched results. Example: list all opportunities for party 9876 with embedded milestone data to assess that customer's deal progression.

Capsule CRM List Parties

Retrieve a paginated list of all parties (people and organisations) stored in Capsule CRM. Use this tool when you need to browse the full contact database, perform incremental syncs via the 'since' parameter, or export party records in bulk. Supports embedding related data such as tags, custom fields, and organisation details to reduce follow-up requests. Returns an array of party objects with IDs, names, contact information, and any embedded resources.

Capsule CRM List Pipelines

Retrieve all sales pipelines defined in your Capsule CRM account. Use this when you need to understand how your sales process is structured, identify which pipelines exist, or find a specific pipeline's ID before querying its milestones or opportunities. Returns pipeline details including IDs, names, and associated milestones. Example: call this to get an overview of all active sales workflows, then drill into a specific pipeline with show_pipeline.

Capsule CRM List Projects

Retrieve a paginated list of all projects (cases) in Capsule CRM. Use this to audit active and closed projects, build status reports, or sync project data to external systems. Supports filtering by modification date via 'since' for incremental syncs, and embedding related resources (tags, fields, party) to enrich results in a single call. Returns an array of project objects with IDs, names, statuses, and associated parties. Example: list all projects modified in the last 30 days with embedded pa

Capsule CRM List Projects By Party

Retrieve all projects (cases) associated with a specific party (contact or organisation) in Capsule CRM. Use this to see every project linked to a particular customer or company, enabling account-level project reviews. Supports pagination and embedding related resources for enriched results. Example: list all projects for party 9876 with embedded tags to assess that customer's project portfolio.

Capsule CRM List Stages

List all project board stages across every board in your Capsule CRM account. Use this when you need a global view of project workflow stages, such as 'To Do', 'In Progress', or 'Done'. Returns stage details including IDs, names, and the board they belong to. Example: call this to audit all stage definitions before creating or moving projects between stages.

Capsule CRM List Stages By Board

Retrieve all stages for a specific project board by its ID. Use this when you need to see the workflow columns within one particular board, such as understanding how projects flow from intake to completion. More targeted than the global list_stages endpoint. Returns stage details including names and sequence order. Example: pass boardId=5 to see stages like 'Backlog', 'In Progress', 'Review', 'Complete' for that board.