NextCRM

MCP tools

Every tool the MCP server registers, with its input fields.

The MCP server registers 122 tools in 18 modules, every entry of allTools in lib/mcp/tools/index.ts. Fields come from each tool's zod schema. How to connect, authenticate and add a tool: MCP server.

ModuleFileTools
Accountslib/mcp/tools/crm-accounts.ts6
Activitieslib/mcp/tools/crm-activities.ts5
Campaignslib/mcp/tools/campaigns.ts19
Contactslib/mcp/tools/crm-contacts.ts6
Contractslib/mcp/tools/crm-contracts.ts5
Documentslib/mcp/tools/crm-documents.ts8
Email accountslib/mcp/tools/crm-email-accounts.ts1
Enrichmentlib/mcp/tools/crm-enrichment.ts4
Leadslib/mcp/tools/crm-leads.ts7
Opportunitieslib/mcp/tools/crm-opportunities.ts6
Orderslib/mcp/tools/crm-orders.ts8
Price listslib/mcp/tools/crm-price-lists.ts8
Productslib/mcp/tools/crm-products.ts5
Projectslib/mcp/tools/projects.ts18
Reportslib/mcp/tools/reports.ts2
Target listslib/mcp/tools/crm-target-lists.ts7
Targetslib/mcp/tools/crm-targets.ts6
Userslib/mcp/tools/crm-users.ts1

Accounts

crm_create_account

Create a new CRM account

FieldTypeRequiredDefaultDescription
descriptionstringno
emailstring (email)no
namestringyes
office_phonestringno
websitestringno

crm_delete_account

Soft-delete a CRM account by ID (sets deletedAt timestamp)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_get_account

Get a single CRM account by ID (visible to the authenticated user)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_list_accounts

List CRM accounts visible to the authenticated user

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0

crm_search_accounts

Search accounts visible to the authenticated user by name or website (substring match)

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0
querystringyes

crm_update_account

Update an existing CRM account by ID

FieldTypeRequiredDefaultDescription
assigned_tostring (uuid) | nullno
descriptionstringno
emailstring (email)no
idstring (uuid)yes
namestringno
office_phonestringno
websitestringno

Activities

crm_create_activity

Create a CRM activity (call/meeting/note/email/visit) and link to entities

FieldTypeRequiredDefaultDescription
datestring (date-time)yes
descriptionstringno
durationintegerno
linksobject[]no
outcomestringno
status"scheduled" | "completed" | "cancelled"no"scheduled"
titlestringyes
type"call" | "meeting" | "note" | "email" | "visit"yes

crm_delete_activity

Soft-delete a CRM activity by ID (sets deletedAt timestamp)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_get_activity

Get a single CRM activity by ID with entity links

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_list_activities

List CRM activities created by the authenticated user, or all activities on a linked entity the user can read

FieldTypeRequiredDefaultDescription
entityIdstring (uuid)no
entityTypestringno
limitnumberno20
offsetnumberno0
status"scheduled" | "completed" | "cancelled"no
type"call" | "meeting" | "note" | "email" | "visit"no

crm_update_activity

Update an existing CRM activity by ID

FieldTypeRequiredDefaultDescription
datestring (date-time)no
descriptionstringno
durationintegerno
idstring (uuid)yes
outcomestringno
status"scheduled" | "completed" | "cancelled"no
titlestringno

Campaigns

campaigns_assign_target_list

Assign a target list to a campaign

FieldTypeRequiredDefaultDescription
campaign_idstring (uuid)yes
target_list_idstring (uuid)yes

campaigns_create

Create a new campaign

FieldTypeRequiredDefaultDescription
descriptionstringno
from_namestringno
namestringyes
reply_tostring (email)no
template_idstring (uuid)no

campaigns_create_step

Add a step to a campaign sequence

FieldTypeRequiredDefaultDescription
campaign_idstring (uuid)yes
delay_daysintegerno0
orderintegeryes
send_to"all" | "non_openers"no"all"
subjectstringyes
template_idstring (uuid)yes

campaigns_create_template

Create a campaign email template

FieldTypeRequiredDefaultDescription
content_htmlstringyes
content_jsonunknownyes
descriptionstringno
namestringyes
subject_defaultstringno

campaigns_delete

Soft-delete a campaign (sets deletedAt timestamp)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

campaigns_delete_step

Delete a campaign step by ID (hard delete — step has no status field)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

campaigns_delete_template

Soft-delete a campaign template (sets deletedAt timestamp)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

campaigns_get

Get a campaign by ID with steps and stats summary

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

campaigns_get_stats

Get send/open/click/unsubscribe stats for a campaign

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

campaigns_get_template

Get a campaign template by ID

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

campaigns_list

List campaigns the caller is allowed to see

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0
status"draft" | "scheduled" | "sending" | "sent" | "paused"no

campaigns_list_templates

List campaign email templates the caller is allowed to see

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0

campaigns_pause

Pause an active/sending campaign

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

campaigns_remove_target_list

Remove a target list from a campaign

FieldTypeRequiredDefaultDescription
campaign_idstring (uuid)yes
target_list_idstring (uuid)yes

campaigns_resume

Resume a paused campaign

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

campaigns_send

Trigger sending a campaign. Campaign must be in draft or scheduled status.

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

campaigns_update

Update a campaign by ID

FieldTypeRequiredDefaultDescription
descriptionstringno
from_namestringno
idstring (uuid)yes
namestringno
reply_tostring (email)no
template_idstring (uuid)no

campaigns_update_step

Update a campaign step by ID

FieldTypeRequiredDefaultDescription
delay_daysintegerno
idstring (uuid)yes
orderintegerno
send_to"all" | "non_openers"no
subjectstringno
template_idstring (uuid)no

campaigns_update_template

Update a campaign template by ID

FieldTypeRequiredDefaultDescription
content_htmlstringno
content_jsonunknownno
descriptionstringno
idstring (uuid)yes
namestringno
subject_defaultstringno

Contacts

crm_create_contact

Create a new CRM contact

FieldTypeRequiredDefaultDescription
emailstring (email)no
first_namestringno
last_namestringyes
mobile_phonestringno
office_phonestringno
positionstringno

crm_delete_contact

Soft-delete a CRM contact by ID (sets deletedAt timestamp)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_get_contact

Get a single CRM contact by ID (visible to the authenticated user)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_list_contacts

List CRM contacts visible to the authenticated user

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0

crm_search_contacts

Search contacts visible to the authenticated user by name, email, or phone (substring match)

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0
querystringyes

crm_update_contact

Update an existing CRM contact by ID

FieldTypeRequiredDefaultDescription
accountstring (uuid) | nullno
assigned_tostring (uuid) | nullno
emailstring (email)no
first_namestringno
idstring (uuid)yes
last_namestringno
mobile_phonestringno
office_phonestringno
positionstringno

Contracts

crm_create_contract

Create a new CRM contract with optional line items

FieldTypeRequiredDefaultDescription
accountstring (uuid)no
assigned_tostring (uuid)no
currencystringno
descriptionstringno
endDatestring (date-time)no
lineItemsobject[]no
startDatestring (date-time)no
titlestringyes
typestringno
valuenumberyes

crm_delete_contract

Soft-delete a CRM contract (sets deletedAt timestamp)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_get_contract

Get a single CRM contract by ID with line items

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_list_contracts

List CRM contracts visible to the authenticated user

FieldTypeRequiredDefaultDescription
accountstring (uuid)no
limitnumberno20
offsetnumberno0
status"NOTSTARTED" | "INPROGRESS" | "SIGNED"no

crm_update_contract

Update an existing CRM contract by ID (does not modify line items — use separate operations)

FieldTypeRequiredDefaultDescription
accountstring (uuid)no
assigned_tostring (uuid)no
currencystringno
descriptionstringno
endDatestring (date-time)no
idstring (uuid)yes
startDatestring (date-time)no
status"NOTSTARTED" | "INPROGRESS" | "SIGNED"no
titlestringno
typestringno
valuenumberno

Documents

crm_create_document

Create a document record and get a presigned upload URL

FieldTypeRequiredDefaultDescription
contentTypestringyes
descriptionstringno
document_namestringyes
visibilitystringno

crm_delete_document

Soft-delete a document (sets status to DELETED)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_get_document

Get a single document by ID

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_get_download_url

Get a presigned download URL for a document

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_get_upload_url

Get a presigned upload URL for an existing document

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

Link a document to an entity (account, contact, lead, opportunity, or task)

FieldTypeRequiredDefaultDescription
document_idstring (uuid)yes
entityIdstring (uuid)yes
entityType"account" | "contact" | "lead" | "opportunity" | "task"yes

crm_list_documents

List documents, optionally filtered by linked entity type and ID

FieldTypeRequiredDefaultDescription
entityIdstring (uuid)no
entityType"account" | "contact" | "lead" | "opportunity" | "task"no
limitnumberno20
offsetnumberno0

Remove a document link from an entity

FieldTypeRequiredDefaultDescription
document_idstring (uuid)yes
entityIdstring (uuid)yes
entityType"account" | "contact" | "lead" | "opportunity" | "task"yes

Email accounts

crm_list_email_accounts

List the authenticated user's connected email accounts

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0

Enrichment

crm_enrich_contact

Enrich a single contact using Firecrawl + AI. Requires FIRECRAWL and OPENAI API keys configured. Returns enrichment record ID for tracking.

FieldTypeRequiredDefaultDescription
contactIdstring (uuid)yes
fieldsobject[]yes

crm_enrich_contact_bulk

Enrich multiple contacts in bulk (max 100). Dispatches async jobs.

FieldTypeRequiredDefaultDescription
contactIdsstring (uuid)[]yes
fieldsobject[]yes

crm_enrich_target

Enrich a single target with the E2B sandbox agent (async). Requires an ANTHROPIC key and E2B_API_KEY on the server.

FieldTypeRequiredDefaultDescription
fieldsobject[]yes
targetIdstring (uuid)yes

crm_enrich_target_bulk

Enrich multiple targets in bulk (max 100) with the E2B sandbox agent. Dispatches async jobs. Requires an ANTHROPIC key and E2B_API_KEY on the server.

FieldTypeRequiredDefaultDescription
fieldsobject[]yes
targetIdsstring (uuid)[]yes

Leads

crm_create_lead

Create a new CRM lead

FieldTypeRequiredDefaultDescription
campaignstringno
companystringno
descriptionstringno
emailstring (email)no
firstNamestringno
jobTitlestringno
lastNamestringyes
lead_source_idstring (uuid)no
lead_status_idstring (uuid)no
lead_type_idstring (uuid)no
phonestringno
refered_bystringno

crm_delete_lead

Soft-delete a CRM lead by ID (sets deletedAt timestamp)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_get_lead

Get a single CRM lead by ID (visible to the authenticated user)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_list_lead_options

List the lead statuses, sources and types configured in this CRM (id + name), for lead_status_id / lead_source_id / lead_type_id

No input fields.

crm_list_leads

List CRM leads visible to the authenticated user

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0

crm_search_leads

Search leads visible to the authenticated user by name, company, or email (substring match)

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0
querystringyes

crm_update_lead

Update an existing CRM lead by ID

FieldTypeRequiredDefaultDescription
assigned_tostring (uuid) | nullno
campaignstringno
companystringno
descriptionstringno
emailstring (email)no
firstNamestringno
idstring (uuid)yes
jobTitlestringno
lastNamestringno
lead_source_idstring (uuid) | nullno
lead_status_idstring (uuid) | nullno
lead_type_idstring (uuid) | nullno
phonestringno
refered_bystringno

Opportunities

crm_create_opportunity

Create a new CRM opportunity

FieldTypeRequiredDefaultDescription
budgetintegerno
close_datestring (date-time)no
currencystringno
descriptionstringno
expected_revenueintegerno
namestringyes
next_stepstringno

crm_delete_opportunity

Soft-delete a CRM opportunity by ID

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_get_opportunity

Get a single CRM opportunity by ID (visible to the authenticated user)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_list_opportunities

List CRM opportunities visible to the authenticated user

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0

crm_search_opportunities

Search opportunities visible to the authenticated user by name or description (substring match)

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0
querystringyes

crm_update_opportunity

Update an existing CRM opportunity by ID

FieldTypeRequiredDefaultDescription
accountstring (uuid) | nullno
assigned_tostring (uuid) | nullno
budgetintegerno
close_datestring (date-time)no
contactstring (uuid) | nullno
currencystringno
descriptionstringno
expected_revenueintegerno
idstring (uuid)yes
namestringno
next_stepstringno

Orders

crm_cancel_order

Cancel an order

FieldTypeRequiredDefaultDescription
idstringyes

crm_create_order

Create a draft order for an account; lines are priced from the customer's price list unless unitPrice is given

FieldTypeRequiredDefaultDescription
accountIdstringyes
contactIdstring | nullno
linesobject[]yes
notestring | nullno
requestedDeliveryDatestring | nullno
shipping_citystring | nullno
shipping_countrystring | nullno
shipping_postal_codestring | nullno
shipping_statestring | nullno
shipping_streetstring | nullno

crm_decide_order_approval

Approve or reject an order waiting for approval (manager or admin; a note is required to reject). Pass the order's updatedAt from crm_get_order to approve exactly the version you reviewed.

FieldTypeRequiredDefaultDescription
decision"APPROVED" | "REJECTED"yes
idstringyes
notestring | nullno
updatedAtstringno

crm_get_order

Get an order with its lines and the actions you may take

FieldTypeRequiredDefaultDescription
idstringyes

crm_list_orders

List orders you can see, newest first

FieldTypeRequiredDefaultDescription
accountIdstringno
limitnumberno20
offsetnumberno0
ownerIdstringno
status"DRAFT" | "PENDING_APPROVAL" | "READY" | "SENT" | "CONFIRMED" | "DELIVERED" | "INVOICED" | "PAID" | "CANCELLED" | "SYNC_FAILED"no

crm_set_order_status

Withdraw, reopen, retry, or advance an order to a later status (advance needs to)

FieldTypeRequiredDefaultDescription
action"withdraw" | "reopen" | "retry" | "advance"yes
idstringyes
to"DRAFT" | "PENDING_APPROVAL" | "READY" | "SENT" | "CONFIRMED" | "DELIVERED" | "INVOICED" | "PAID" | "CANCELLED" | "SYNC_FAILED"no

crm_submit_order

Submit a draft: READY, or PENDING_APPROVAL when a sales rep priced a line below the list

FieldTypeRequiredDefaultDescription
idstringyes

crm_update_order

Replace a draft order's header fields and full line list

FieldTypeRequiredDefaultDescription
contactIdstring | nullno
idstringyes
linesobject[]yes
notestring | nullno
requestedDeliveryDatestring | nullno
shipping_citystring | nullno
shipping_countrystring | nullno
shipping_postal_codestring | nullno
shipping_statestring | nullno
shipping_streetstring | nullno

Price lists

crm_archive_price_list

Archive a price list (manager or admin; not external lists)

FieldTypeRequiredDefaultDescription
idstringyes

crm_create_price_list

Create a price list (manager or admin)

FieldTypeRequiredDefaultDescription
currencystringyes
namestringyes

crm_delete_price_list_rule

Delete a price list rule (manager or admin; not external lists)

FieldTypeRequiredDefaultDescription
idstringyes

crm_get_price

Compute a product's price from a price list, or from the account's list (account list → default list → product price)

FieldTypeRequiredDefaultDescription
accountIdstringno
datestringno
priceListIdstringno
productIdstringyes
quantitynumberyes

crm_get_price_list

Get a price list with its rules

FieldTypeRequiredDefaultDescription
idstringyes

crm_list_price_lists

List price lists (active by default)

FieldTypeRequiredDefaultDescription
includeArchivedbooleanno
limitnumberno20
offsetnumberno0
source"CRM" | "EXTERNAL"no

crm_update_price_list

Rename a price list, change its currency or (de)activate it (manager or admin; not external lists)

FieldTypeRequiredDefaultDescription
currencystringno
idstringyes
isActivebooleanno
namestringno

crm_upsert_price_list_rule

Create or update a price list rule (Odoo-compatible fields; manager or admin; not external lists)

FieldTypeRequiredDefaultDescription
appliesTo"ALL" | "CATEGORY" | "PRODUCT"yes
base"LIST_PRICE" | "COST" | "PRICE_LIST"no
basePriceListIdstring | nullno
categoryIdstring | nullno
computePrice"FIXED" | "PERCENTAGE" | "FORMULA"yes
dateEndstring | nullno
dateStartstring | nullno
fixedPricenumber | nullno
minQuantitynumber | nullno
percentPricenumber | nullno
priceDiscountnumber | nullno
priceListIdstringyes
priceMaxMarginnumber | nullno
priceMinMarginnumber | nullno
priceRoundnumber | nullno
priceSurchargenumber | nullno
productIdstring | nullno
ruleIdstringno

Products

crm_create_product

Create a new CRM product

FieldTypeRequiredDefaultDescription
billing_period"MONTHLY" | "QUARTERLY" | "SEMIANNUALLY" | "ANNUALLY"no
categoryIdstring (uuid)no
currencystringyes
descriptionstringno
is_recurringbooleanno
namestringyes
skustringno
tax_ratenumberno
type"PRODUCT" | "SERVICE"yes
unitstringno
unit_costnumberno
unit_pricenumberyes

crm_delete_product

Soft-delete a CRM product (sets deletedAt timestamp)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_get_product

Get a single CRM product by ID

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_list_products

List CRM products (org-wide catalog)

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0
status"DRAFT" | "ACTIVE" | "ARCHIVED"no

crm_update_product

Update an existing CRM product by ID

FieldTypeRequiredDefaultDescription
billing_period"MONTHLY" | "QUARTERLY" | "SEMIANNUALLY" | "ANNUALLY"no
categoryIdstring (uuid)no
currencystringno
descriptionstringno
idstring (uuid)yes
is_recurringbooleanno
namestringno
skustringno
status"DRAFT" | "ACTIVE" | "ARCHIVED"no
tax_ratenumberno
type"PRODUCT" | "SERVICE"no
unitstringno
unit_costnumberno
unit_pricenumberno

Projects

projects_add_comment

Add a comment to a task

FieldTypeRequiredDefaultDescription
commentstringyes
taskstring (uuid)yes

projects_assign_document

Link a document to a task

FieldTypeRequiredDefaultDescription
document_idstring (uuid)yes
task_idstring (uuid)yes

projects_create_board

Create a new project board

FieldTypeRequiredDefaultDescription
descriptionstringyes
iconstringno
titlestringyes
visibilitystringno

projects_create_section

Add a section (column) to a board

FieldTypeRequiredDefaultDescription
boardstring (uuid)yes
titlestringyes

projects_create_task

Create a task in a board section

FieldTypeRequiredDefaultDescription
contentstringno
dueDateAtstring (date-time)no
prioritystringno"Normal"
sectionstring (uuid)yes
titlestringyes

projects_delete_board

Soft-delete a project board (sets deletedAt timestamp)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

projects_delete_section

Delete a section (must be empty — no tasks)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

projects_delete_task

Soft-delete a task (sets status to COMPLETE)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

projects_get_board

Get a project board with its sections and tasks

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

projects_get_task

Get a task by ID with comments and documents

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

projects_list_boards

List project boards the user owns or is shared with

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0

projects_list_comments

List comments on a task

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0
taskstring (uuid)yes

projects_list_tasks

List tasks, optionally filtered by board, section, user, or status

FieldTypeRequiredDefaultDescription
boardstring (uuid)no
limitnumberno20
offsetnumberno0
sectionstring (uuid)no
status"ACTIVE" | "PENDING" | "COMPLETE"no
userstring (uuid)no

projects_move_task

Move a task to a different section and/or position

FieldTypeRequiredDefaultDescription
idstring (uuid)yes
positionintegerno
sectionstring (uuid)yes

projects_update_board

Update a project board by ID

FieldTypeRequiredDefaultDescription
descriptionstringno
iconstringno
idstring (uuid)yes
titlestringno
visibilitystringno

projects_update_section

Update a section title or position

FieldTypeRequiredDefaultDescription
idstring (uuid)yes
positionintegerno
titlestringno

projects_update_task

Update a task by ID

FieldTypeRequiredDefaultDescription
contentstringno
dueDateAtstring (date-time)no
idstring (uuid)yes
prioritystringno
taskStatus"ACTIVE" | "PENDING" | "COMPLETE"no
titlestringno

projects_watch_board

Watch or unwatch a project board

FieldTypeRequiredDefaultDescription
board_idstring (uuid)yes
watchbooleannotrue

Reports

reports_list

List available report configurations

FieldTypeRequiredDefaultDescription
category"sales" | "leads" | "accounts" | "activity" | "campaigns" | "users"no
limitnumberno20
offsetnumberno0

reports_run

Run a report by category and get the data. Returns raw report data (use format param for CSV/PDF via the /api/reports/export endpoint).

FieldTypeRequiredDefaultDescription
category"sales" | "leads" | "accounts" | "activity" | "campaigns" | "users"yes
dateFromstring (date-time)no
dateTostring (date-time)no

Target lists

crm_add_to_target_list

Add one or more targets to a target list

FieldTypeRequiredDefaultDescription
target_idsstring (uuid)[]yes
target_list_idstring (uuid)yes

crm_create_target_list

Create a new target list

FieldTypeRequiredDefaultDescription
descriptionstringno
namestringyes

crm_delete_target_list

Soft-delete a target list (sets deletedAt timestamp)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_get_target_list

Get a target list by ID with its members

FieldTypeRequiredDefaultDescription
idstring (uuid)yes
limitnumberno20
offsetnumberno0

crm_list_target_lists

List target lists the caller is allowed to see

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0

crm_remove_from_target_list

Remove one or more targets from a target list

FieldTypeRequiredDefaultDescription
target_idsstring (uuid)[]yes
target_list_idstring (uuid)yes

crm_update_target_list

Update a target list by ID

FieldTypeRequiredDefaultDescription
descriptionstringno
idstring (uuid)yes
namestringno

Targets

crm_create_target

Create a new CRM target

FieldTypeRequiredDefaultDescription
companystringno
emailstring (email)no
first_namestringno
last_namestringyes
mobile_phonestringno
office_phonestringno
positionstringno

crm_delete_target

Soft-delete a CRM target by ID (sets deletedAt timestamp)

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_get_target

Get a single CRM target by ID

FieldTypeRequiredDefaultDescription
idstring (uuid)yes

crm_list_targets

List CRM targets created by the authenticated user

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0

crm_search_targets

Search targets by name, email, or company (substring match)

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0
querystringyes

crm_update_target

Update an existing CRM target by ID

FieldTypeRequiredDefaultDescription
companystringno
emailstring (email)no
first_namestringno
idstring (uuid)yes
last_namestringno
mobile_phonestringno
office_phonestringno
positionstringno

Users

crm_list_users

List NextCRM users, to resolve a person to the user ID needed by assigned_to. Returns active users by default. Managers and admins additionally see email, role, status and last login.

FieldTypeRequiredDefaultDescription
limitnumberno20
offsetnumberno0
querystringno
status"ACTIVE" | "INACTIVE" | "PENDING" | "ALL"no

On this page

Accountscrm_create_accountcrm_delete_accountcrm_get_accountcrm_list_accountscrm_search_accountscrm_update_accountActivitiescrm_create_activitycrm_delete_activitycrm_get_activitycrm_list_activitiescrm_update_activityCampaignscampaigns_assign_target_listcampaigns_createcampaigns_create_stepcampaigns_create_templatecampaigns_deletecampaigns_delete_stepcampaigns_delete_templatecampaigns_getcampaigns_get_statscampaigns_get_templatecampaigns_listcampaigns_list_templatescampaigns_pausecampaigns_remove_target_listcampaigns_resumecampaigns_sendcampaigns_updatecampaigns_update_stepcampaigns_update_templateContactscrm_create_contactcrm_delete_contactcrm_get_contactcrm_list_contactscrm_search_contactscrm_update_contactContractscrm_create_contractcrm_delete_contractcrm_get_contractcrm_list_contractscrm_update_contractDocumentscrm_create_documentcrm_delete_documentcrm_get_documentcrm_get_download_urlcrm_get_upload_urlcrm_link_documentcrm_list_documentscrm_unlink_documentEmail accountscrm_list_email_accountsEnrichmentcrm_enrich_contactcrm_enrich_contact_bulkcrm_enrich_targetcrm_enrich_target_bulkLeadscrm_create_leadcrm_delete_leadcrm_get_leadcrm_list_lead_optionscrm_list_leadscrm_search_leadscrm_update_leadOpportunitiescrm_create_opportunitycrm_delete_opportunitycrm_get_opportunitycrm_list_opportunitiescrm_search_opportunitiescrm_update_opportunityOrderscrm_cancel_ordercrm_create_ordercrm_decide_order_approvalcrm_get_ordercrm_list_orderscrm_set_order_statuscrm_submit_ordercrm_update_orderPrice listscrm_archive_price_listcrm_create_price_listcrm_delete_price_list_rulecrm_get_pricecrm_get_price_listcrm_list_price_listscrm_update_price_listcrm_upsert_price_list_ruleProductscrm_create_productcrm_delete_productcrm_get_productcrm_list_productscrm_update_productProjectsprojects_add_commentprojects_assign_documentprojects_create_boardprojects_create_sectionprojects_create_taskprojects_delete_boardprojects_delete_sectionprojects_delete_taskprojects_get_boardprojects_get_taskprojects_list_boardsprojects_list_commentsprojects_list_tasksprojects_move_taskprojects_update_boardprojects_update_sectionprojects_update_taskprojects_watch_boardReportsreports_listreports_runTarget listscrm_add_to_target_listcrm_create_target_listcrm_delete_target_listcrm_get_target_listcrm_list_target_listscrm_remove_from_target_listcrm_update_target_listTargetscrm_create_targetcrm_delete_targetcrm_get_targetcrm_list_targetscrm_search_targetscrm_update_targetUserscrm_list_users