← Tools Reference

Capsule CRM

Capsule CRM integration (Productivity, Marketing). Imported from open-connector.

API key25 toolshttps://api.capsulecrm.com/api/v2
GET
capsule_crm_list_parties
List Capsule CRM parties with pagination, optional change filtering, and embeds.

/parties

4 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe page number of results to return.
perPageintegeroptionalThe number of records to return per page.
sincestringoptionalOnly include records changed after this ISO 8601 timestamp.
embedarrayoptionalAdditional related resources to embed in the Capsule CRM response.
GET
capsule_crm_search_parties
Search Capsule CRM parties by query text.

/parties/search

4 parameters
ParamTypeRequiredDescription
qstringrequiredThe search query.
pageintegeroptionalThe page number of results to return.
perPageintegeroptionalThe number of records to return per page.
embedarrayoptionalAdditional related resources to embed in the Capsule CRM response.
GET
capsule_crm_get_party
Read one Capsule CRM party by ID.

/parties/{readId}

2 parameters
ParamTypeRequiredDescription
idintegeroptionalThe unique Capsule CRM party ID.
readIdstringrequiredPath parameter: readId
POST
capsule_crm_create_party
Create a Capsule CRM party.

/parties

1 parameter
ParamTypeRequiredDescription
partyobjectoptionalThe Capsule CRM party payload to send.
PUT
capsule_crm_update_party
Update a Capsule CRM party.

/parties/{readId}

3 parameters
ParamTypeRequiredDescription
idintegeroptionalThe unique Capsule CRM party ID.
partyobjectoptionalThe Capsule CRM party payload to send.
readIdstringrequiredPath parameter: readId
DELETE
capsule_crm_delete_party
Delete a Capsule CRM party.

/parties/{readId}

2 parameters
ParamTypeRequiredDescription
idintegeroptionalThe unique Capsule CRM party ID.
readIdstringrequiredPath parameter: readId
GET
capsule_crm_list_opportunities
List Capsule CRM opportunities with pagination, optional change filtering, and embeds.

/opportunities

4 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe page number of results to return.
perPageintegeroptionalThe number of records to return per page.
sincestringoptionalOnly include records changed after this ISO 8601 timestamp.
embedarrayoptionalAdditional related resources to embed in the Capsule CRM response.
GET
capsule_crm_search_opportunities
Search Capsule CRM opportunities by query text.

/opportunities/search

4 parameters
ParamTypeRequiredDescription
qstringrequiredThe search query.
pageintegeroptionalThe page number of results to return.
perPageintegeroptionalThe number of records to return per page.
embedarrayoptionalAdditional related resources to embed in the Capsule CRM response.
GET
capsule_crm_get_opportunity
Read one Capsule CRM opportunity by ID.

/opportunities/{readId}

2 parameters
ParamTypeRequiredDescription
idintegeroptionalThe unique Capsule CRM opportunity ID.
readIdstringrequiredPath parameter: readId
POST
capsule_crm_create_opportunity
Create a Capsule CRM opportunity.

/opportunities

1 parameter
ParamTypeRequiredDescription
opportunityobjectoptionalThe Capsule CRM opportunity payload to send.
PUT
capsule_crm_update_opportunity
Update a Capsule CRM opportunity.

/opportunities/{readId}

3 parameters
ParamTypeRequiredDescription
idintegeroptionalThe unique Capsule CRM opportunity ID.
opportunityobjectoptionalThe Capsule CRM opportunity payload to send.
readIdstringrequiredPath parameter: readId
DELETE
capsule_crm_delete_opportunity
Delete a Capsule CRM opportunity.

/opportunities/{readId}

2 parameters
ParamTypeRequiredDescription
idintegeroptionalThe unique Capsule CRM opportunity ID.
readIdstringrequiredPath parameter: readId
GET
capsule_crm_list_tasks
List Capsule CRM tasks with pagination, status filtering, and embeds.

/tasks

4 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe page number of results to return.
perPageintegeroptionalThe number of records to return per page.
statusarrayoptionalTask statuses to include.
embedarrayoptionalAdditional related resources to embed in the Capsule CRM response.
GET
capsule_crm_get_task
Read one Capsule CRM task by ID.

/tasks/{readId}

2 parameters
ParamTypeRequiredDescription
idintegeroptionalThe unique Capsule CRM task ID.
readIdstringrequiredPath parameter: readId
POST
capsule_crm_create_task
Create a Capsule CRM task.

/tasks

1 parameter
ParamTypeRequiredDescription
taskobjectoptionalThe Capsule CRM task payload to send.
PUT
capsule_crm_update_task
Update a Capsule CRM task.

/tasks/{readId}

3 parameters
ParamTypeRequiredDescription
idintegeroptionalThe unique Capsule CRM task ID.
taskobjectoptionalThe Capsule CRM task payload to send.
readIdstringrequiredPath parameter: readId
DELETE
capsule_crm_delete_task
Delete a Capsule CRM task.

/tasks/{readId}

2 parameters
ParamTypeRequiredDescription
idintegeroptionalThe unique Capsule CRM task ID.
readIdstringrequiredPath parameter: readId
GET
capsule_crm_list_users
List Capsule CRM users.

/users

1 parameter
ParamTypeRequiredDescription
embedarrayoptionalAdditional related resources to embed in the Capsule CRM response.
GET
capsule_crm_get_current_user
Read the Capsule CRM user associated with the access token.

/users/current

1 parameter
ParamTypeRequiredDescription
embedarrayoptionalAdditional related resources to embed in the Capsule CRM response.
GET
capsule_crm_list_categories
List Capsule CRM task categories.

/categories

2 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe page number of results to return.
perPageintegeroptionalThe number of records to return per page.
GET
capsule_crm_list_countries
List countries supported by Capsule CRM.

/countries

GET
capsule_crm_list_currencies
List currencies supported by Capsule CRM.

/currencies

GET
capsule_crm_list_pipelines
List Capsule CRM sales pipelines.

/pipelines

3 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe page number of results to return.
perPageintegeroptionalThe number of records to return per page.
includeDeletedbooleanoptionalWhether to include deleted or archived pipelines.
GET
capsule_crm_list_pipeline_milestones
List milestones for a Capsule CRM pipeline.

/pipelines/{readPipelineId}/milestones

4 parameters
ParamTypeRequiredDescription
pipelineIdintegerrequiredThe unique Capsule CRM pipeline ID.
pageintegeroptionalThe page number of results to return.
perPageintegeroptionalThe number of records to return per page.
readPipelineIdstringrequiredPath parameter: readPipelineId
GET
capsule_crm_list_stages
List stages for a Capsule CRM board.

/stages

5 parameters
ParamTypeRequiredDescription
boardIdintegeroptionalThe unique Capsule CRM board ID used to list only board stages.
pageintegeroptionalThe page number of results to return.
perPageintegeroptionalThe number of records to return per page.
statusstringoptionalThe Capsule CRM stage status filter.
includeOnDeletedBoardbooleanoptionalWhether to include stages from archived boards.