/capsulecrm | Type: Application | PCID required: Yes
Tools
capsulecrm_create_entry
Create a new entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entry | object | Yes | — | The entry value |
capsulecrm_create_opportunity
Create a new opportunity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
embed | string | No | — | Comma-separated list of additional data to include. |
opportunity | object | Yes | — | The opportunity value |
capsulecrm_create_party
Create a new party Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
embed | string | No | — | Comma-separated list of additional data to include. |
party | object | Yes | — | The party value |
capsulecrm_create_project
Create a new project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
embed | string | No | — | Comma-separated list of additional data to include. |
kase | object | Yes | — | The kase value |
capsulecrm_create_task
Create a new task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
embed | string | No | — | Comma-separated list of additional data to include. |
task | object | Yes | — | The task value |
capsulecrm_delete_entry
Delete an entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryId | integer | Yes | — | The entry identifier. |
capsulecrm_delete_opportunity
Delete an opportunity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
opportunityId | integer | Yes | — | The opportunity identifier. |
capsulecrm_delete_party
Delete a party Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
partyId | integer | Yes | — | The party identifier. |
capsulecrm_delete_project
Delete a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The project identifier. |
capsulecrm_delete_task
Delete a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | integer | Yes | — | The task identifier. |
capsulecrm_get_current_user
Show current user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
embed | string | No | — | Comma-separated list of additional data to include: party. |
capsulecrm_get_entry
Show an entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryId | integer | Yes | — | The entry identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_get_opportunity
Show an opportunity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
opportunityId | integer | Yes | — | The opportunity identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_get_party
Show a party Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
partyId | integer | Yes | — | The party identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_get_project
Show a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The project identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_get_task
Show a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | integer | Yes | — | The task identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_get_user
Show a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | integer | Yes | — | The user identifier. |
embed | string | No | — | Comma-separated list of additional data to include: party. |
capsulecrm_list_entries
List all entries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include: party, kase, opportunity, creator, activityType. |
capsulecrm_list_opportunities
List all opportunities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
since | string | No | — | ISO8601 date to filter entities modified after this date. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include: tags, fields, party, milestone, missingImportantFields. |
capsulecrm_list_opportunity_entries
List entries for an opportunity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
opportunityId | integer | Yes | — | The opportunity identifier. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-50 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_list_opportunity_tags
List opportunity tag definitions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
capsulecrm_list_parties
List all parties (contacts) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
since | string | No | — | ISO8601 date to filter entities modified after this date. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include: tags, fields, organisation, missingImportantFields. |
capsulecrm_list_party_employees
List employees of an organisation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
partyId | integer | Yes | — | The organisation identifier. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_list_party_entries
List entries for a party Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
partyId | integer | Yes | — | The party identifier. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-50 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_list_party_opportunities
List opportunities for a party Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
partyId | integer | Yes | — | The party identifier. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_list_party_projects
List projects for a party Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
partyId | integer | Yes | — | The party identifier. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_list_party_tags
List party tag definitions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
capsulecrm_list_project_entries
List entries for a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The project identifier. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-50 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_list_project_tags
List project tag definitions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
capsulecrm_list_projects
List all projects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
since | string | No | — | ISO8601 date to filter entities modified after this date. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include: tags, fields, party, opportunity, missingImportantFields. |
capsulecrm_list_tasks
List all tasks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include: party, opportunity, kase, owner, nextTask. |
status | string | No | — | Filter by status: open, completed, pending (comma-separated). |
capsulecrm_list_users
List all users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
embed | string | No | — | Comma-separated list of additional data to include: party. |
capsulecrm_search_opportunities
Search opportunities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | Yes | — | Search term. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_search_parties
Search parties Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | Yes | — | Search term. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_search_projects
Search projects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | Yes | — | Search term. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
capsulecrm_update_entry
Update an entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryId | integer | Yes | — | The entry identifier. |
entry | object | Yes | — | The entry value |
capsulecrm_update_opportunity
Update an opportunity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
opportunityId | integer | Yes | — | The opportunity identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
opportunity | object | Yes | — | The opportunity value |
capsulecrm_update_party
Update a party Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
partyId | integer | Yes | — | The party identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
party | object | Yes | — | The party value |
capsulecrm_update_project
Update a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The project identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
kase | object | Yes | — | The kase value |
capsulecrm_update_task
Update a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | integer | Yes | — | The task identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
task | object | Yes | — | The task value |

