Capsule CRM

These are the Capsule CRM actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Add Party to Opportunity

  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.

• Create Capsule CRM 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.

• Create Capsule CRM 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.

• Create Capsule CRM 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.

• Create Capsule CRM 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• Delete Category

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

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• List deleted parties

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

• 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.

• 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.

• 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.

• 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.

• 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.

• Restore Board

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

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• Delete Task

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

• Delete Title

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

• Delete Track

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

• 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.

• 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.

• 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).

• 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.

• 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.

• 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.

• 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.

• Get Entry

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

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• List Goals

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

• 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.

• List Milestones

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

• 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.

• 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.

• List Organisation Employees

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

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• List Tasks

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

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• Update Capsule CRM 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.

• Update Capsule CRM Category

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

• Update Capsule CRM 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.

• Update Capsule CRM 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.

• Update Capsule CRM 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."

• Update Capsule CRM Pipeline

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

• Update Capsule CRM 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.

• Update Capsule CRM 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.

• Update Capsule CRM 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.

• 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.

• 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.

• 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.

• 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.

• 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.