> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Capsule CRM

> How to set up the Capsule CRM connector, plus the actions and events that are available.

![Capsule CRM](https://stackone-logos.com/api/capsule/filled/svg)

v6.0.0[See changelog](https://docs.stackone.com/connectors/capsulecrm/changelog.md)

[136 actions](#actions) · [19 events](#events) · 2 auth methods

CRM
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/capsulecrm/guides/connector-profile/api-key.md)
>
> Uses a Personal Access Token generated from your own Capsule user account — this is the value StackOne uses as the API k...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/capsulecrm/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an OAuth application on the Capsule Developer Portal, which signs in with a GitHub account rather t...

Optionally, configure receiving Events for Capsule CRM into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/capsulecrm/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/capsulecrm/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/capsulecrm/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

read

user\_preference

write

No scopes found

136 actions

ActionDescriptionRequired scopes

List Boards`capsulecrm_list_boards`

List all boards in Capsule CRM

`read`

Get Board`capsulecrm_get_board`

Get a specific board by ID

`read`

Create Board`capsulecrm_create_board`

Create a new board

`read``write`

Update Board`capsulecrm_update_board`

Update an existing board

`read``write`

Archive Board`capsulecrm_archive_board`

Archive a board

`read``write`

Restore Board`capsulecrm_restore_board`

Restore an archived board

`read``write`

List Task Categories`capsulecrm_list_task_categories`

List all task categories in Capsule CRM

`read`

Get Task Category`capsulecrm_get_task_category`

Get a specific task category by ID

`read`

Create Task Category`capsulecrm_create_task_category`

Create a new task category

`read``write`

Update Task Category`capsulecrm_update_task_category`

Update an existing task category

`read``write`

Delete Task Category`capsulecrm_delete_task_category`

Delete a task category

`read``write`

List Party Custom Fields`capsulecrm_list_party_custom_fields`

List all custom field definitions for parties

`read`

Get Party Custom Field`capsulecrm_get_party_custom_field`

Get a specific party custom field definition

`read`

Create Party Custom Field`capsulecrm_create_party_custom_field`

Create a new party custom field definition

`read``write`

Update Party Custom Field`capsulecrm_update_party_custom_field`

Update a party custom field definition

`read``write`

Delete Party Custom Field`capsulecrm_delete_party_custom_field`

Delete a party custom field definition

`read``write`

List Opportunity Custom Fields`capsulecrm_list_opportunity_custom_fields`

List all custom field definitions for opportunities

`read`

Get Opportunity Custom Field`capsulecrm_get_opportunity_custom_field`

Get a specific opportunity custom field definition

`read`

Create Opportunity Custom Field`capsulecrm_create_opportunity_custom_field`

Create a new opportunity custom field definition

`read``write`

Update Opportunity Custom Field`capsulecrm_update_opportunity_custom_field`

Update an opportunity custom field definition

`read``write`

Delete Opportunity Custom Field`capsulecrm_delete_opportunity_custom_field`

Delete an opportunity custom field definition

`read``write`

List Project Custom Fields`capsulecrm_list_project_custom_fields`

List all custom field definitions for projects

`read`

Get Project Custom Field`capsulecrm_get_project_custom_field`

Get a specific project custom field definition

`read`

Create Project Custom Field`capsulecrm_create_project_custom_field`

Create a new project custom field definition

`read``write`

Update Project Custom Field`capsulecrm_update_project_custom_field`

Update a project custom field definition

`read``write`

Delete Project Custom Field`capsulecrm_delete_project_custom_field`

Delete a project custom field definition

`read``write`

List Entries`capsulecrm_list_entries`

Retrieve all entries (notes, emails, completed tasks) by date

`read`

List Party Entries`capsulecrm_list_party_entries`

List entries for a specific party

`read`

List Opportunity Entries`capsulecrm_list_opportunity_entries`

List entries for a specific opportunity

`read`

List Project Entries`capsulecrm_list_project_entries`

List entries for a specific project

`read`

Get Entry`capsulecrm_get_entry`

Retrieve a specific entry by ID

`read`

Create Entry`capsulecrm_create_entry`

Create a new entry (note)

`read``write`

Update Entry`capsulecrm_update_entry`

Update an existing entry

`read``write`

Delete Entry`capsulecrm_delete_entry`

Delete an entry from Capsule CRM

`read``write`

Upload Attachment`capsulecrm_upload_attachment`

Upload a file attachment for use with entries

`read``write`

Get Attachment`capsulecrm_get_attachment`

Download an attachment by ID

`read`

List Activity Types`capsulecrm_list_activity_types`

List all activity types in Capsule CRM

`read`

Get Unified Credentials`capsulecrm_unified_get_me`

Return the authenticated identity and auth type for the current Capsule CRM connection. auth\_type is derived from the pr...

`read`

List Unified Groups`capsulecrm_unified_list_groups`

List every Capsule CRM Team as an IAM group. Capsule Teams are flat user-grouping buckets used for ownership and assignm...

`read`

Get Unified Group`capsulecrm_unified_get_group`

Retrieve a single Capsule Team (modeled as IAM group) by numeric id. Supports expand=users (passes embed=memberships to...

`read`

List Unified Organizations`capsulecrm_unified_list_organizations`

Return the single Capsule CRM site tied to the current connection as an IAM organization. Synthesized from /api/v2/site...

`read`

Get Unified Organization`capsulecrm_unified_get_organization`

Retrieve the Capsule CRM site bound to the current connection as an IAM organization. id is pinned to the literal "capsu...

`read`

List Unified Users`capsulecrm_unified_list_users`

List every user in the connected Capsule CRM account mapped to the IAM unified user schema, via GET /api/v2/users. Reque...

`read`

Get Unified User`capsulecrm_unified_get_user`

Retrieve a single Capsule CRM user by numeric id, mapped to the IAM unified user schema. Field coverage matches unified\_...

`read`

List Milestones`capsulecrm_list_milestones`

Retrieve all milestones from the oldest active pipeline

`read`

List Pipeline Milestones`capsulecrm_list_pipeline_milestones`

List milestones for a specific pipeline

`read`

Get Milestone`capsulecrm_get_milestone`

Retrieve a specific milestone by ID

`read`

Create Milestone`capsulecrm_create_milestone`

Create a new milestone

`read``write`

Update Milestone`capsulecrm_update_milestone`

Update an existing milestone

`read``write`

Delete Milestone`capsulecrm_delete_milestone`

Delete a milestone

`read``write`

List Opportunities`capsulecrm_list_opportunities`

Retrieve all opportunities (deals) in Capsule CRM

`read`

Get Opportunity`capsulecrm_get_opportunity`

Retrieve a specific opportunity by ID

`read`

Get Multiple Opportunities`capsulecrm_get_multiple_opportunities`

Retrieve multiple opportunities by IDs

`read`

Search Opportunities`capsulecrm_search_opportunities`

Search for opportunities by query term

`read`

List Party Opportunities`capsulecrm_list_party_opportunities`

List opportunities associated with a specific party

`read`

Create Opportunity`capsulecrm_create_opportunity`

Create a new opportunity (deal)

`read``write`

Update Opportunity`capsulecrm_update_opportunity`

Update an existing opportunity

`read``write`

Delete Opportunity`capsulecrm_delete_opportunity`

Delete an opportunity from Capsule CRM

`read``write`

List Deleted Opportunities`capsulecrm_list_deleted_opportunities`

List opportunities deleted since a specific date

`read`

List Opportunity Parties`capsulecrm_list_opportunity_parties`

List additional parties associated with an opportunity

`read`

Add Party To Opportunity`capsulecrm_add_opportunity_party`

Add an additional party to an opportunity

`read``write`

Remove Party From Opportunity`capsulecrm_remove_opportunity_party`

Remove an additional party from an opportunity

`read``write`

List Opportunity Projects`capsulecrm_list_opportunity_projects`

List projects associated with an opportunity

`read`

Filter Opportunities`capsulecrm_filter_opportunities`

Run an ad-hoc filter query on opportunities

`read`

List Lost Reasons`capsulecrm_list_lost_reasons`

List all lost reasons in Capsule CRM

`read`

List Parties`capsulecrm_list_parties`

Retrieve all parties (contacts) in Capsule CRM

`read`

Get Party`capsulecrm_get_party`

Retrieve a specific party by ID

`read`

Get Multiple Parties`capsulecrm_get_multiple_parties`

Retrieve multiple parties by their IDs

`read`

Search Parties`capsulecrm_search_parties`

Search for parties by query term

`read`

Create Party`capsulecrm_create_party`

Create a new party (person or organization)

`read``write`

Update Party`capsulecrm_update_party`

Update an existing party

`read``write`

Delete Party`capsulecrm_delete_party`

Delete a party from Capsule CRM

`read``write`

List Party Employees`capsulecrm_list_party_employees`

List employees (people) of an organization

`read`

List Deleted Parties`capsulecrm_list_deleted_parties`

List parties deleted since a specific date

`read`

Filter Parties`capsulecrm_filter_parties`

Run an ad-hoc filter query on parties

`read`

List Track Definitions`capsulecrm_list_track_definitions`

List all track definitions in Capsule CRM

`read`

Get Track Definition`capsulecrm_get_track_definition`

Get a specific track definition by ID

`read`

Create Track Definition`capsulecrm_create_track_definition`

Create a new track definition

`read``write`

Update Track Definition`capsulecrm_update_track_definition`

Update an existing track definition

`read``write`

Delete Track Definition`capsulecrm_delete_track_definition`

Delete a track definition

`read``write`

List Pipelines`capsulecrm_list_pipelines`

Retrieve all pipelines in Capsule CRM

`read`

Get Pipeline`capsulecrm_get_pipeline`

Retrieve a specific pipeline by ID

`read`

Get Multiple Pipelines`capsulecrm_get_multiple_pipelines`

Retrieve multiple pipelines by their IDs

`read`

Create Pipeline`capsulecrm_create_pipeline`

Create a new pipeline

`read``write`

Update Pipeline`capsulecrm_update_pipeline`

Update an existing pipeline

`read``write`

Archive Pipeline`capsulecrm_archive_pipeline`

Archive a pipeline

`read``write`

Restore Pipeline`capsulecrm_restore_pipeline`

Restore an archived pipeline

`read``write`

Duplicate Pipeline`capsulecrm_duplicate_pipeline`

Duplicate an existing pipeline

`read``write`

List Projects`capsulecrm_list_projects`

Retrieve all projects (cases) in Capsule CRM

`read`

Get Project`capsulecrm_get_project`

Retrieve a specific project by ID

`read`

Get Multiple Projects`capsulecrm_get_multiple_projects`

Retrieve multiple projects by their IDs

`read`

Search Projects`capsulecrm_search_projects`

Search for projects by query term

`read`

List Party Projects`capsulecrm_list_party_projects`

List projects associated with a specific party

`read`

Create Project`capsulecrm_create_project`

Create a new project (case)

`read``write`

Update Project`capsulecrm_update_project`

Update an existing project

`read``write`

Delete Project`capsulecrm_delete_project`

Delete a project from Capsule CRM

`read``write`

List Deleted Projects`capsulecrm_list_deleted_projects`

List projects deleted since a specific date

`read`

List Project Parties`capsulecrm_list_project_parties`

List parties associated with a project

`read`

Add Party To Project`capsulecrm_add_project_party`

Add a party to a project

`read``write`

Remove Party From Project`capsulecrm_remove_project_party`

Remove a party from a project

`read``write`

Filter Projects`capsulecrm_filter_projects`

Run an ad-hoc filter query on projects

`read`

Get Site`capsulecrm_get_site`

Retrieve site information

`read`

List Stages`capsulecrm_list_stages`

List all stages in Capsule CRM

`read`

List Board Stages`capsulecrm_list_board_stages`

List stages for a specific board

`read`

Get Stage`capsulecrm_get_stage`

Get a specific stage by ID

`read`

Create Stage`capsulecrm_create_stage`

Create a new stage

`read``write`

Update Stage`capsulecrm_update_stage`

Update an existing stage

`read``write`

Delete Stage`capsulecrm_delete_stage`

Delete a stage

`read``write`

List Party Tags`capsulecrm_list_party_tags`

List all tag definitions for parties

`read`

Get Party Tag`capsulecrm_get_party_tag`

Retrieve a specific party tag definition by ID

`read`

Create Party Tag`capsulecrm_create_party_tag`

Create a new tag definition for parties

`read``write`

Update Party Tag`capsulecrm_update_party_tag`

Update a party tag definition

`read``write`

Delete Party Tag`capsulecrm_delete_party_tag`

Delete a party tag definition

`read``write`

List Opportunity Tags`capsulecrm_list_opportunity_tags`

List all tag definitions for opportunities

`read`

Get Opportunity Tag`capsulecrm_get_opportunity_tag`

Retrieve a specific opportunity tag definition by ID

`read`

Create Opportunity Tag`capsulecrm_create_opportunity_tag`

Create a new tag definition for opportunities

`read``write`

Update Opportunity Tag`capsulecrm_update_opportunity_tag`

Update an opportunity tag definition

`read``write`

Delete Opportunity Tag`capsulecrm_delete_opportunity_tag`

Delete an opportunity tag definition

`read``write`

List Project Tags`capsulecrm_list_project_tags`

List all tag definitions for projects

`read`

Get Project Tag`capsulecrm_get_project_tag`

Retrieve a specific project tag definition by ID

`read`

Create Project Tag`capsulecrm_create_project_tag`

Create a new tag definition for projects

`read``write`

Update Project Tag`capsulecrm_update_project_tag`

Update a project tag definition

`read``write`

Delete Project Tag`capsulecrm_delete_project_tag`

Delete a project tag definition

`read``write`

List Tasks`capsulecrm_list_tasks`

Retrieve all tasks in Capsule CRM

`read`

Get Task`capsulecrm_get_task`

Retrieve a specific task by ID

`read`

Create Task`capsulecrm_create_task`

Create a new task

`read``write`

Update Task`capsulecrm_update_task`

Update an existing task

`read``write`

Delete Task`capsulecrm_delete_task`

Delete a task from Capsule CRM

`read``write`

List Teams`capsulecrm_list_teams`

Retrieve all teams in the Capsule CRM account

`read`

Get Team`capsulecrm_get_team`

Retrieve a specific team by ID

`read`

List Tracks`capsulecrm_list_tracks`

List tracks applied to a party, opportunity or project

`read`

Create Track`capsulecrm_create_track`

Apply a track definition to a party, opportunity or project

`read``write`

List Users`capsulecrm_list_users`

Retrieve all users in the Capsule CRM account

`read`

Get Current User`capsulecrm_get_current_user`

Retrieve the current authenticated user

`read`

Get User`capsulecrm_get_user`

Retrieve a specific user by ID

`read`

Update User`capsulecrm_update_user`

Update a user's preferences

`read``write``user_preference`

## Events

Tags

Select all
|
Clear

Opportunities

Parties

Projects

Tasks

Users

Webhooks

No tags found

19 events

EventDescriptionTags

Party Created Webhook`capsulecrm_webhook_party_created`

Processes Capsule party/created events.

PartiesWebhooks

Party Updated Webhook`capsulecrm_webhook_party_updated`

Processes Capsule party/updated events.

PartiesWebhooks

Party Deleted Webhook`capsulecrm_webhook_party_deleted`

Processes Capsule party/deleted events.

PartiesWebhooks

Project Created Webhook`capsulecrm_webhook_kase_created`

Processes Capsule kase/created events.

ProjectsWebhooks

Project Updated Webhook`capsulecrm_webhook_kase_updated`

Processes Capsule kase/updated events.

ProjectsWebhooks

Project Deleted Webhook`capsulecrm_webhook_kase_deleted`

Processes Capsule kase/deleted events.

ProjectsWebhooks

Project Closed Webhook`capsulecrm_webhook_kase_closed`

Processes Capsule kase/closed events.

ProjectsWebhooks

Project Moved Webhook`capsulecrm_webhook_kase_moved`

Processes Capsule kase/moved events.

ProjectsWebhooks

Opportunity Created Webhook`capsulecrm_webhook_opportunity_created`

Processes Capsule opportunity/created events.

OpportunitiesWebhooks

Opportunity Updated Webhook`capsulecrm_webhook_opportunity_updated`

Processes Capsule opportunity/updated events.

OpportunitiesWebhooks

Opportunity Deleted Webhook`capsulecrm_webhook_opportunity_deleted`

Processes Capsule opportunity/deleted events.

OpportunitiesWebhooks

Opportunity Closed Webhook`capsulecrm_webhook_opportunity_closed`

Processes Capsule opportunity/closed events.

OpportunitiesWebhooks

Opportunity Moved Webhook`capsulecrm_webhook_opportunity_moved`

Processes Capsule opportunity/moved events.

OpportunitiesWebhooks

Task Created Webhook`capsulecrm_webhook_task_created`

Processes Capsule task/created events.

TasksWebhooks

Task Updated Webhook`capsulecrm_webhook_task_updated`

Processes Capsule task/updated events.

TasksWebhooks

Task Completed Webhook`capsulecrm_webhook_task_completed`

Processes Capsule task/completed events.

TasksWebhooks

User Created Webhook`capsulecrm_webhook_user_created`

Processes Capsule user/created events.

UsersWebhooks

User Updated Webhook`capsulecrm_webhook_user_updated`

Processes Capsule user/updated events.

UsersWebhooks

User Deleted Webhook`capsulecrm_webhook_user_deleted`

Processes Capsule user/deleted events.

UsersWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.