Skip to main content
Server path: /capsulecrm | Type: Application | PCID required: Yes

Tools

ToolDescription
capsulecrm_create_entryCreate a new entry
capsulecrm_create_opportunityCreate a new opportunity
capsulecrm_create_partyCreate a new party
capsulecrm_create_projectCreate a new project
capsulecrm_create_taskCreate a new task
capsulecrm_delete_entryDelete an entry
capsulecrm_delete_opportunityDelete an opportunity
capsulecrm_delete_partyDelete a party
capsulecrm_delete_projectDelete a project
capsulecrm_delete_taskDelete a task
capsulecrm_get_current_userShow current user
capsulecrm_get_entryShow an entry
capsulecrm_get_opportunityShow an opportunity
capsulecrm_get_partyShow a party
capsulecrm_get_projectShow a project
capsulecrm_get_taskShow a task
capsulecrm_get_userShow a user
capsulecrm_list_entriesList all entries
capsulecrm_list_opportunitiesList all opportunities
capsulecrm_list_opportunity_entriesList entries for an opportunity
capsulecrm_list_opportunity_tagsList opportunity tag definitions
capsulecrm_list_partiesList all parties (contacts)
capsulecrm_list_party_employeesList employees of an organisation
capsulecrm_list_party_entriesList entries for a party
capsulecrm_list_party_opportunitiesList opportunities for a party
capsulecrm_list_party_projectsList projects for a party
capsulecrm_list_party_tagsList party tag definitions
capsulecrm_list_project_entriesList entries for a project
capsulecrm_list_project_tagsList project tag definitions
capsulecrm_list_projectsList all projects
capsulecrm_list_tasksList all tasks
capsulecrm_list_usersList all users
capsulecrm_search_opportunitiesSearch opportunities
capsulecrm_search_partiesSearch parties
capsulecrm_search_projectsSearch projects
capsulecrm_update_entryUpdate an entry
capsulecrm_update_opportunityUpdate an opportunity
capsulecrm_update_partyUpdate a party
capsulecrm_update_projectUpdate a project
capsulecrm_update_taskUpdate a task

capsulecrm_create_entry

Create a new entry Parameters:
ParameterTypeRequiredDefaultDescription
entryobjectYesThe entry value

capsulecrm_create_opportunity

Create a new opportunity Parameters:
ParameterTypeRequiredDefaultDescription
embedstringNoComma-separated list of additional data to include.
opportunityobjectYesThe opportunity value

capsulecrm_create_party

Create a new party Parameters:
ParameterTypeRequiredDefaultDescription
embedstringNoComma-separated list of additional data to include.
partyobjectYesThe party value

capsulecrm_create_project

Create a new project Parameters:
ParameterTypeRequiredDefaultDescription
embedstringNoComma-separated list of additional data to include.
kaseobjectYesThe kase value

capsulecrm_create_task

Create a new task Parameters:
ParameterTypeRequiredDefaultDescription
embedstringNoComma-separated list of additional data to include.
taskobjectYesThe task value

capsulecrm_delete_entry

Delete an entry Parameters:
ParameterTypeRequiredDefaultDescription
entryIdintegerYesThe entry identifier.

capsulecrm_delete_opportunity

Delete an opportunity Parameters:
ParameterTypeRequiredDefaultDescription
opportunityIdintegerYesThe opportunity identifier.

capsulecrm_delete_party

Delete a party Parameters:
ParameterTypeRequiredDefaultDescription
partyIdintegerYesThe party identifier.

capsulecrm_delete_project

Delete a project Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe project identifier.

capsulecrm_delete_task

Delete a task Parameters:
ParameterTypeRequiredDefaultDescription
taskIdintegerYesThe task identifier.

capsulecrm_get_current_user

Show current user Parameters:
ParameterTypeRequiredDefaultDescription
embedstringNoComma-separated list of additional data to include: party.

capsulecrm_get_entry

Show an entry Parameters:
ParameterTypeRequiredDefaultDescription
entryIdintegerYesThe entry identifier.
embedstringNoComma-separated list of additional data to include.

capsulecrm_get_opportunity

Show an opportunity Parameters:
ParameterTypeRequiredDefaultDescription
opportunityIdintegerYesThe opportunity identifier.
embedstringNoComma-separated list of additional data to include.

capsulecrm_get_party

Show a party Parameters:
ParameterTypeRequiredDefaultDescription
partyIdintegerYesThe party identifier.
embedstringNoComma-separated list of additional data to include.

capsulecrm_get_project

Show a project Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe project identifier.
embedstringNoComma-separated list of additional data to include.

capsulecrm_get_task

Show a task Parameters:
ParameterTypeRequiredDefaultDescription
taskIdintegerYesThe task identifier.
embedstringNoComma-separated list of additional data to include.

capsulecrm_get_user

Show a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdintegerYesThe user identifier.
embedstringNoComma-separated list of additional data to include: party.

capsulecrm_list_entries

List all entries Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).
embedstringNoComma-separated list of additional data to include: party, kase, opportunity, creator, activityType.

capsulecrm_list_opportunities

List all opportunities Parameters:
ParameterTypeRequiredDefaultDescription
sincestringNoISO8601 date to filter entities modified after this date.
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).
embedstringNoComma-separated list of additional data to include: tags, fields, party, milestone, missingImportantFields.

capsulecrm_list_opportunity_entries

List entries for an opportunity Parameters:
ParameterTypeRequiredDefaultDescription
opportunityIdintegerYesThe opportunity identifier.
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-50 (default 50).
embedstringNoComma-separated list of additional data to include.

capsulecrm_list_opportunity_tags

List opportunity tag definitions Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).

capsulecrm_list_parties

List all parties (contacts) Parameters:
ParameterTypeRequiredDefaultDescription
sincestringNoISO8601 date to filter entities modified after this date.
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).
embedstringNoComma-separated list of additional data to include: tags, fields, organisation, missingImportantFields.

capsulecrm_list_party_employees

List employees of an organisation Parameters:
ParameterTypeRequiredDefaultDescription
partyIdintegerYesThe organisation identifier.
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).
embedstringNoComma-separated list of additional data to include.

capsulecrm_list_party_entries

List entries for a party Parameters:
ParameterTypeRequiredDefaultDescription
partyIdintegerYesThe party identifier.
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-50 (default 50).
embedstringNoComma-separated list of additional data to include.

capsulecrm_list_party_opportunities

List opportunities for a party Parameters:
ParameterTypeRequiredDefaultDescription
partyIdintegerYesThe party identifier.
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).
embedstringNoComma-separated list of additional data to include.

capsulecrm_list_party_projects

List projects for a party Parameters:
ParameterTypeRequiredDefaultDescription
partyIdintegerYesThe party identifier.
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).
embedstringNoComma-separated list of additional data to include.

capsulecrm_list_party_tags

List party tag definitions Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).

capsulecrm_list_project_entries

List entries for a project Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe project identifier.
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-50 (default 50).
embedstringNoComma-separated list of additional data to include.

capsulecrm_list_project_tags

List project tag definitions Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).

capsulecrm_list_projects

List all projects Parameters:
ParameterTypeRequiredDefaultDescription
sincestringNoISO8601 date to filter entities modified after this date.
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).
embedstringNoComma-separated list of additional data to include: tags, fields, party, opportunity, missingImportantFields.

capsulecrm_list_tasks

List all tasks Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).
embedstringNoComma-separated list of additional data to include: party, opportunity, kase, owner, nextTask.
statusstringNoFilter by status: open, completed, pending (comma-separated).

capsulecrm_list_users

List all users Parameters:
ParameterTypeRequiredDefaultDescription
embedstringNoComma-separated list of additional data to include: party.

capsulecrm_search_opportunities

Search opportunities Parameters:
ParameterTypeRequiredDefaultDescription
qstringYesSearch term.
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).
embedstringNoComma-separated list of additional data to include.

capsulecrm_search_parties

Search parties Parameters:
ParameterTypeRequiredDefaultDescription
qstringYesSearch term.
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).
embedstringNoComma-separated list of additional data to include.

capsulecrm_search_projects

Search projects Parameters:
ParameterTypeRequiredDefaultDescription
qstringYesSearch term.
pageintegerNoPage number (default 1).
perPageintegerNoResults per page, 1-100 (default 50).
embedstringNoComma-separated list of additional data to include.

capsulecrm_update_entry

Update an entry Parameters:
ParameterTypeRequiredDefaultDescription
entryIdintegerYesThe entry identifier.
entryobjectYesThe entry value

capsulecrm_update_opportunity

Update an opportunity Parameters:
ParameterTypeRequiredDefaultDescription
opportunityIdintegerYesThe opportunity identifier.
embedstringNoComma-separated list of additional data to include.
opportunityobjectYesThe opportunity value

capsulecrm_update_party

Update a party Parameters:
ParameterTypeRequiredDefaultDescription
partyIdintegerYesThe party identifier.
embedstringNoComma-separated list of additional data to include.
partyobjectYesThe party value

capsulecrm_update_project

Update a project Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe project identifier.
embedstringNoComma-separated list of additional data to include.
kaseobjectYesThe kase value

capsulecrm_update_task

Update a task Parameters:
ParameterTypeRequiredDefaultDescription
taskIdintegerYesThe task identifier.
embedstringNoComma-separated list of additional data to include.
taskobjectYesThe task value