Skip to main content
Nutshell logo
  • Category: crm
  • Auth: BASIC
  • Composio-managed OAuth available? N/A
  • Tools: 78
  • Triggers: 0
  • Slug: NUTSHELL
  • Version: 20261101_00

Tools

Slug: NUTSHELL_CREATE_ACCOUNTSTool to create one or more accounts in Nutshell. Use when you need to add new company accounts. Each account must have at least one of: name, phone, email, address, or url.

Input Parameters

array
required
Array of account objects to create. Each account must have at least one of: name, phone, email, address, or url.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_CREATE_ACCOUNTS_CUSTOMFIELDSTool to create a custom field for accounts in Nutshell. Use when you need to add new custom fields to track additional information on company accounts. Supports Text, LongText, Currency, Date, and Decision field types.

Input Parameters

string
required
The name/ID of the custom field to create. Must be unique within accounts.
string
required
The type of custom field. For accounts, valid values are: ‘Text’, ‘LongText’, ‘Currency’, ‘Date’, ‘Decision’ (for dropdowns). IMPORTANT: Values must be capitalized exactly as shown (e.g., ‘Text’ not ‘text’ or ‘string’). Note: Email, location, phone, and URL types are only applicable to leads, not accounts.
string
Display title for the custom field. If not provided, defaults to the name value.
array
For Decision (enum) type only. The possible values for the dropdown. Required when creating Decision-type custom fields.
boolean
For Decision (enum) type only. Whether the custom field can have multiple values selected. Only applicable when field_type is ‘Decision’ and choices are provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_CREATE_ACTIVITIESTool to create one or more activities in Nutshell CRM. Use when you need to log a completed activity or schedule a future activity such as phone calls, meetings, emails, or notes. All activity fields are optional except the activities array itself. At minimum, provide a name or activityType for meaningful activities.

Input Parameters

array
required
Array of activities to create. At least one activity is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_CREATE_CONTACTSCreate a contact in Nutshell CRM. Each contact must have at least one identifier field: name, phone, email, address, or URL.

Input Parameters

array
required
Array of contact objects to create. Each contact must have at least one of: name, phone, email, address, or url

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_CREATE_LEADSTool to create a lead in Nutshell CRM using the JSON-RPC API. Use when you need to add a new lead to the system. The description field is required, while other fields like manualValue, dueTime, customFields, and links are optional.

Input Parameters

Links to related entities.
object
Due time information for the lead.
string
required
Description of the lead. This is the only required field
string
Manual value or estimated revenue for the lead
object
Custom field values as key-value pairs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_CREATE_LEADS_CUSTOMFIELDTool to create a custom field for leads in Nutshell. Use when you need to add new custom fields to track additional information on leads. Supports Text, Email, Currency, and Date field types.

Input Parameters

string
required
The name/title of the custom field to create
string
required
The type of custom field. For leads, valid values are: Text, Email, Currency, Date. Note: Values must be capitalized exactly as shown (case-sensitive).
array
Reserved for future use. Currently not applicable for leads custom fields.
boolean
Reserved for future use. Currently not applicable for leads custom fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_CREATE_NOTESTool to create a note in Nutshell. Use when you need to add notes to contacts, leads, accounts, or other entities in Nutshell CRM. The note will be attached to the specified parent entity.

Input Parameters

string
required
The text content to display on the note.
string
required
The entity ID to attach the note to. Format: ‘{id}-{entity_type}’ where entity_type can be ‘contacts’, ‘leads’, ‘accounts’, ‘competitors’, etc. Example: ‘3-contacts’ attaches the note to contact with ID 3.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_CREATE_SOURCESTool to create new sources in Nutshell CRM. Use when you need to add source tracking for leads or contacts. Sources help categorize where leads originate (e.g., organic search, paid ads).

Input Parameters

array
required
Array of source objects to create. Each source must have a name and optionally a channel ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_CREATE_TAGSTool to create one or more tags in Nutshell. Use when you need to create new tags for categorizing leads, contacts, or accounts. Each tag requires a name and tagType (1=leads, 2=contacts, 3=accounts).

Input Parameters

array
required
Array of tag objects to create. Each tag requires a name and tagType (1=leads, 2=contacts, 3=accounts)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_DELETE_ACCOUNTDelete a Nutshell account by ID. Deleted accounts can be restored from the trash within 30 days via the undelete endpoint.

Input Parameters

string
required
The ID of the account to delete. IDs are of the form ‘n-accounts’, where n is an integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_DELETE_CONTACTSTool to delete a contact by ID. Use when you need to remove a contact from Nutshell. Returns success confirmation upon deletion.

Input Parameters

string
required
The unique identifier of the contact to delete. Example: ‘23-contacts’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_DELETE_LEADSTool to delete a lead from Nutshell CRM. Use when you need to remove a lead. Note: Nutshell soft-deletes leads by default, allowing for potential recovery.

Input Parameters

string
required
Lead ID to delete. The unique identifier of the lead in Nutshell CRM

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_DELETE_NOTESDelete a note from Nutshell CRM by ID. Deleted notes can be restored via the undelete endpoint; returned note details may be limited when the response has no content.

Input Parameters

string
required
The ID of the note to delete. Format: numeric-id followed by ‘-notes’ (e.g., ‘71-notes’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_DELETE_PRODUCTMAPSDelete a product mapping from a lead in Nutshell. The response may include details of the deleted product map.

Input Parameters

string
required
The ID of the product map to delete. Format: {number}-productMaps (e.g., ‘7-productMaps’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_DELETE_TASKSTool to delete a task from Nutshell CRM. Use when you need to remove a task. Note: Nutshell soft-deletes tasks by default, allowing for potential recovery.

Input Parameters

string
required
Task ID to delete. The unique identifier of the task in Nutshell CRM

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_EDIT_ACCOUNTTool to edit an existing account in Nutshell CRM. Updates specified fields of an account using the account ID and revision identifier. Supports file uploads via two-step process: specify file in request, receive upload URI in response, POST file to URI. Use when you need to modify account details like name, description, tags, contact information, or associations.

Input Parameters

string
required
The revision identifier of the account. This must match the current revision of the account (obtained from getAccount or findAccounts). Used for optimistic concurrency control.
object
required
Object containing the fields to update. Only include fields you want to change.
integer
required
The ID of the account to edit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_GET_ACCOUNTTool to retrieve an account from Nutshell. Use when you need to get details about a specific account. Supports retrieving multiple accounts by providing comma-separated IDs.

Input Parameters

string
required
The ID of the account to retrieve. API IDs are of the form ‘n-accounts’, where n is an integer. Multiple IDs can be listed in comma-separated format to retrieve multiple accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_GET_ACCOUNTS_CUSTOMFIELDSTool to retrieve custom fields for a specific account in Nutshell. Use when you need to view custom field definitions and values associated with an account.

Input Parameters

string
required
The ID of the account to retrieve custom fields for. IDs are of the form ‘n-accounts’, where n is an integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_GET_ACTIVITIESTool to retrieve a single activity by ID from Nutshell CRM. Use when you need to get details about a specific activity. The activity ID must be in the format ‘{integer}-activities’ (e.g., ‘7-activities’).

Input Parameters

string
required
Activity ID in the format ‘{integer}-activities’. Example: ‘7-activities’ for activity with ID 7.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_GET_CONTACTSTool to retrieve a specific contact by ID from Nutshell CRM. Use when you need to get detailed information about a contact.

Input Parameters

string
required
Contact ID in the format ‘number-contacts’ (e.g., ‘3-contacts’, ‘23-contacts’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_GET_CONTACTS_CUSTOMFIELDSRetrieve custom field IDs and values for a specific contact in Nutshell.

Input Parameters

string
required
The ID of the contact to retrieve custom fields for. IDs are of the form ‘n-contacts’, where n is an integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_GET_LEADSTool to retrieve a specific lead by ID from Nutshell CRM. Use when you need to get detailed information about a lead.

Input Parameters

string
required
Lead ID in the format ‘number-leads’ (e.g., ‘1003-leads’, ‘45-leads’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_GET_LEADS_CUSTOMFIELDSRetrieve user-created custom fields for a specific lead in Nutshell CRM. System-managed attribution identifiers are available through the lead’s attributionTracking property instead.

Input Parameters

string
required
Lead ID in the format ‘{integer}-leads’. Example: ‘1003-leads’ for lead with ID 1003.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_GET_NOTESTool to retrieve a single note by ID from Nutshell CRM. Use when you need to get details about a specific note. The note ID must be in the format ‘{integer}-notes’ (e.g., ‘3-notes’).

Input Parameters

string
required
Note ID in the format ‘{integer}-notes’. Example: ‘3-notes’ for note with ID 3.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_GET_PRODUCTCATEGORIESTool to retrieve a single product category by ID from Nutshell CRM. Use when you need to get details about a specific product category. The product category ID must be in the format ‘{integer}-productCategories’ (e.g., ‘3-productCategories’).

Input Parameters

string
required
Product Category ID in the format ‘{integer}-productCategories’. Example: ‘3-productCategories’ for product category with ID 3.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_GET_TASKSTool to retrieve a single task by ID from Nutshell CRM. Use when you need to get details about a specific task. The task ID must be in the format ‘{integer}-tasks’ (e.g., ‘7-tasks’).

Input Parameters

string
required
Task ID in the format ‘{integer}-tasks’. Example: ‘7-tasks’ for task with ID 7.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_ACCOUNTS_CUSTOMFIELD_ATTRIBUTESTool to retrieve all account custom field attributes from Nutshell CRM. Use when you need to discover what custom fields are available for account records and their metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_ACCOUNTS_FIELDSTool to retrieve all available fields for accounts in Nutshell. Use when you need to discover what fields are available for account records, their types, and capabilities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_ACCOUNTS_LIST_ITEMSTool to retrieve list items for all accounts in Nutshell CRM. Use when you need to get a list of accounts with optional filtering and sorting.

Input Parameters

string
Used to search all related info on an entity. Returns all entities that are similar to the query term.
array
Sort the returned list by a chosen field. Use a ’-’ before the field name to sort in descending order.
object
Filter the returned accounts based on various criteria. Use /rest/accounts/list/fields to get a full list of valid filter keys.
integer
The page of results to return. Indexing is 0-based.
integer
How many results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_ACCOUNTTYPESTool to retrieve a list of all account types from Nutshell CRM. Use when you need to see available account type options or get account type IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_ACTIVITIESTool to retrieve a list of activities from Nutshell CRM. Use when you need to get multiple activities with optional filtering by participants, status, date range, or other criteria.

Input Parameters

string
String search query to find activities across related information.
integer
Maximum number of activities to return.
array
Filter activities by status. Provide a list of status values.
boolean
When true, only return flagged activities.
string
Filter for the latest activity to return. Provide date in ISO format (e.g., ‘2024-12-31’).
string
Filter for the earliest activity to return. Provide date in ISO format (e.g., ‘2024-01-01’).
array
Filter activities by participant IDs. Provide a list of participant IDs to filter by.
boolean
When true, only return activities marked as important.
array
Filter by activity types. Provide a list of activity type values.
string
Filter to only return activities related to hot leads. Must be ‘hot’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_ACTIVITYTYPESTool to retrieve a list of all activity types from Nutshell CRM. Use when you need to see available activity type options or get activity type IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_COMPETITORMAPSTool to get a list of lead-competitor relationships from Nutshell CRM. Use when you need to retrieve competitor mapping information for leads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_COMPETITORSTool to get a list of competitors from Nutshell CRM. Use when you need to retrieve all competitors or search for specific competitors by name.

Input Parameters

string
String to search for in competitor name. Use this to filter competitors by name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_CONTACTSTool to get a list of contacts from Nutshell CRM. Use when you need to retrieve multiple contacts with optional filtering, searching, sorting, and pagination.

Input Parameters

string
Returns contacts with a piece of information similar to the provided string, such as name, email, location, etc.
string ("accountType" | "-accountType" | "accounts" | "-accounts" | "createdTime" | "-createdTime" | "email" | "-email" | "industry" | "-industry" | "lastContactedTime" | "-lastContactedTime" | "name" | "-name" | "owner" | "-owner" | "phone" | "-phone" | "postalCode" | "-postalCode" | "territory" | "-territory")
What criteria to order the returned list of results. Use ’-’ prefix for descending order.
string
Returns contacts with the provided email address.
object
Filter the returned contacts based on various criteria. Use /rest/contacts/list/fields to get a full list of valid filter keys.
integer
The page of results to return. Indexing is 0-based.
integer
How many results to return per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_CONTACTS_CUSTOMFIELD_ATTRIBUTESRetrieve available contact custom field IDs in Nutshell to discover which custom fields can be used with contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_CONTACTS_FIELDSTool to retrieve all available fields for contacts in Nutshell. Use when you need to discover what fields are available for contact records, their types, and capabilities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_CONTACTS_LIST_ITEMSRetrieve contact list items from Nutshell with optional filtering and sorting. Returned item fields are limited to URLs, avatar URL, and initials.

Input Parameters

string
Used to search all related info on an entity. Returns all entities that are similar to the query term.
array
Sort the returned list by a chosen field. Use a ’-’ before the field name to sort in descending order.
object
Filter the returned contacts based on various criteria. Use /rest/contacts/list/fields to get a full list of valid filter keys.
integer
The page of results to return. Indexing is 0-based.
integer
How many results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_DELETED_EVENTSTool to get a feed of deletion events from Nutshell CRM. Use when you need to track which entities have been deleted and when.

Input Parameters

string
Reverse the order of returned results. Use ‘-change_time’ to sort by change time in descending order.
integer
The maximum number of events to return. Use for controlling pagination size.
string
Retrieve events with an ID less than or equal to the specified ID. Used for pagination.
integer
Retrieve events that occurred before the specified Unix timestamp (in seconds).
string
Retrieve events with an ID greater than the specified ID. Used for pagination.
integer
Retrieve events that occurred after the specified Unix timestamp (in seconds).
string
Retrieve a feed of events related to a specific type of entity. Must be one of the supported entity types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_EDITIONSTool to retrieve a list of all editions from Nutshell CRM. Use when you need to see available edition options or get edition IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_EVENTSTool to get a list of events from Nutshell CRM. Use when you need to retrieve activity feed events with optional filtering by time range, entity, event types, or creator.

Input Parameters

integer
The maximum number of events to return. Use for controlling pagination size.
array
Opt in to additional event types. Available types: comments, mailchimp, followup, constantContact, emailInteraction, assignments, formSubmissions.
string
Retrieve a feed of events with an ID less than or equal to the specified ID. Used for pagination.
integer
Retrieve a feed of events that occurred before the specified Unix timestamp (in seconds).
string
Retrieve a feed of events with an ID greater than the specified ID. Used for pagination.
string
Retrieve a feed of events related to a specific entity. Use entity ID format like ‘{integer}-{entityType}’.
integer
Retrieve a feed of events that occurred after the specified Unix timestamp (in seconds).
array
Retrieve a feed of events caused by a specific user or team. Use user/team IDs.
array
Retrieve a feed of events related to a type of entity. Filter by payload type.
array
Whether to receive email sent or received events. Requires a creator filter. Values can be ‘sent’ or ‘received’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_FILTERSTool to get saved filters from Nutshell CRM. Use when you need to retrieve saved filters for reports or entity lists (leads, contacts, accounts).

Input Parameters

string
Additional filter options to apply when retrieving saved filters.
string
The user ID to get saved filters for. If not provided, returns filters for all users.
string ("report_*" | "entity_list_leads" | "entity_list_contacts" | "entity_list_accounts")
The type of saved filters to get. Use ‘report_*’ to get all report filters, or ‘entity_list_leads’, ‘entity_list_contacts’, ‘entity_list_accounts’ to get filters for the given entity type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_FORMSRetrieve the non-archived forms in a Nutshell instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_INDUSTRIESTool to retrieve a list of all industries from Nutshell CRM. Use when you need to see available industry options or get industry IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_INVOICESTool to get a list of invoices from Nutshell CRM. Use when you need to retrieve invoices with optional filtering by lead, date range, and pagination.

Input Parameters

string
Request a specific page of results, for pagination. Used in conjunction with page_limit. Indexing is 0-based.
string
Limit the number of results returned, for pagination.
string
Filter invoices by lead ID.
string
Filter invoices created before this date. Date expected in the format YYYY-MM-DD.
string
Filter invoices created after this date. Date expected in the format YYYY-MM-DD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_LEADSTool to get a list of leads from Nutshell CRM. Use when you need to retrieve multiple leads with optional filtering, searching, sorting, and pagination.

Input Parameters

string
Search query to find leads. Returns all entities similar to the query term across all related info.
string
Sort the returned list by a chosen field. Use a ’-’ before the field name to sort in descending order. Examples: ‘name’, ‘-value’, ‘-closedTime’
object
Filter the returned leads based on various criteria. Use /rest/leads/list/fields to get a full list of valid filter keys.
integer
The page of results to return. Indexing is 0-based. Used for pagination.
integer
How many results to return per page. Used for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_LEADS_CUSTOMFIELD_ATTRIBUTESTool to retrieve all applicable custom field attributes for leads in Nutshell CRM. Use when you need to see available custom field definitions, types, and configuration for leads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_LEADS_FIELDSTool to retrieve all available fields for leads in Nutshell. Use when you need to discover what fields are available for lead records, their types, and capabilities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_LEADS_LIST_ITEMSRetrieve lead list items from Nutshell with optional filtering and sorting. Returned item fields are limited to URLs, avatar URL, and initials.

Input Parameters

string
Used to search all related info on an entity. Returns all entities that are similar to the query term.
array
Sort the returned list by a chosen field. Use a ’-’ before the field name to sort in descending order.
object
Filter the returned leads based on various criteria. Use /rest/leads/list/fields to get a full list of valid filter keys.
integer
The page of results to return. Indexing is 0-based.
integer
How many results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_LEADS_REPORTTool to get reports for leads from Nutshell CRM. Use when you need to generate analytics or reporting data about leads, such as sales reports, losses, new leads, forecasts, or attribution reports with optional segmentation and time bucketing.

Input Parameters

string
Search query to find reports. Returns all reports that are similar to the query term.
string ("d" | "w" | "m" | "y" | "q")
The bucket size of the report. Options: ‘d’ (day), ‘w’ (week), ‘m’ (month), ‘y’ (year), ‘q’ (quarter).
string
Sort the returned list by a chosen field. Use a ’-’ before the field name to sort in descending order.
string
The format of the report output. Only ‘json’ is supported.
string
The facet to sort values on.
string ("sales" | "losses" | "newleads" | "forecast" | "attribution" | "custom")
The type of report to generate. Options: sales, losses, newleads, forecast, attribution, custom.
string
Filter results by lead name. Visit the filters guide for more information on how to filter by other terms.
string
The field to group leads by. Sales or losses reports should use ‘closedTime’, new leads and custom reports should use ‘createdTime’.
boolean
When calculating lead values, use their weighted confidence value or not.
string ("outcomes" | "competitors" | "products" | "productCategories" | "assignees" | "territories" | "sources" | "tags" | "channels")
Ways to break down the report to compare across different variables. Use to answer questions like: Who has made the most sales? Which products are earning the most? Where are our leads coming from?

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_LEADS_STAGESTool to retrieve all stages associated with a specific lead in Nutshell CRM. Use when you need to get the stage progression or workflow stages for a lead.

Input Parameters

string
required
Lead ID in the format ‘number-leads’ (e.g., ‘1003-leads’, ‘45-leads’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_MARKETSTool to retrieve a list of all markets from Nutshell CRM. Use when you need to see available markets or get market IDs and currency information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_NOTESTool to get a list of notes from Nutshell CRM. Use when you need to retrieve multiple notes with optional pagination.

Input Parameters

string
Request a specific page of results, for pagination. Used in conjunction with page_limit. Indexing is 0-based.
string
Limit the number of results returned, for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_OUTCOMESTool to retrieve a list of lead outcomes from Nutshell CRM. Use when you need to see available outcome options for leads or get outcome IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_PRODUCTCATEGORIESTool to get a list of all product categories from Nutshell CRM. Use when you need to retrieve all available product categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_PRODUCTMAPSTool to get a list of lead products from Nutshell CRM. Use when you need to retrieve product mapping information for leads.

Input Parameters

integer
The page of results to return. Indexing is 0-based.
integer
How many results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_PRODUCTSList or search Nutshell CRM products by name or SKU. Without a query, returns active products with optional sorting; search results are limited to 200 and are not sorted by the requested sort.

Input Parameters

string
Filter for matching name or SKU. Returns products where the name or SKU contains the query string.
string ("name" | "-name" | "sku" | "-sku")
Sort the returned list by name or SKU. Use ’-’ prefix for descending order.
integer
The page of results to return. Indexing is 0-based.
integer
How many results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_QUOTESTool to get a list of quotes from Nutshell CRM. Use when you need to retrieve quotes with optional filtering by lead, date range, and pagination.

Input Parameters

string
Request a specific page of results, for pagination. Used in conjunction with page_limit. Indexing is 0-based.
string
Limit the number of results returned, for pagination.
string
Filter quotes by lead ID.
string
Filter quotes created before this date. Date expected in the format YYYY-MM-DD.
string
Filter quotes created after this date. Date expected in the format YYYY-MM-DD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_SOURCESTool to retrieve a list of sources from Nutshell CRM. Use when you need to get all possible sources for leads in your Nutshell instance, with optional filtering by name.

Input Parameters

string
Query string to search for sources that match a specific string. Filters sources by name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_STAGESList active stages from active Nutshell pipelines visible to the authenticated user, including stage IDs for lead management.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_STAGESETSTool to retrieve a list of all pipelines (stagesets) from Nutshell CRM. Use when you need to see available pipelines or get pipeline IDs for lead management.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_TAGSTool to retrieve a list of tags from Nutshell CRM. Use when you need to get tags with optional filtering by name or type (leads, contacts, accounts).

Input Parameters

string
Search query string to filter tags by name. Returns tags that match the query string.
integer
The page of results to return. Indexing is 0-based.
integer
How many results to return per page.
string ("leads" | "contacts" | "accounts")
Filter tags by their type. Use ‘leads’ for lead tags, ‘contacts’ for contact tags, or ‘accounts’ for account tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_TERRITORIESTool to retrieve a list of all territories from Nutshell CRM. Use when you need to see available territories or get territory IDs for assignment or filtering purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_LIST_USERSTool to get a list of all users from Nutshell CRM. Use when you need to retrieve all users in the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_REOPEN_LEADSTool to reopen a lead in Nutshell CRM. Use when you need to reopen a previously closed or won lead.

Input Parameters

string
required
Lead ID to reopen. The unique identifier of the lead in Nutshell CRM in the format ‘number-leads’ (e.g., ‘1003-leads’, ‘45-leads’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_SET_PIPELINE_LEADSTool to set the pipeline (stageset) for a lead in Nutshell CRM. Use when you need to assign a lead to a specific pipeline. Requires the lead ID and stageset ID to update the lead’s pipeline assignment.

Input Parameters

string
required
Lead ID to update. The unique identifier of the lead in Nutshell CRM
string
required
ID of the stageset (pipeline) to set for the lead. Identifies which pipeline to assign the lead to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_UNDELETE_ACCOUNTSTool to undelete a previously deleted account in Nutshell. Use when you need to restore a deleted account. Returns the restored account object with deletedTime set to null.

Input Parameters

string
required
The ID of the account to undelete. IDs are of the form ‘n-accounts’, where n is an integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_UNDELETE_CONTACTSTool to undelete a previously deleted contact in Nutshell CRM. Use when you need to restore a contact that was deleted.

Input Parameters

string
required
Contact ID to undelete. Must be the numeric ID of a previously deleted contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_UNDELETE_LEADSTool to undelete a previously deleted lead from Nutshell CRM. Use when you need to restore a soft-deleted lead.

Input Parameters

string
required
Lead ID to undelete. The unique identifier of the lead in Nutshell CRM

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_UNDELETE_NOTESTool to undelete a previously deleted note in Nutshell CRM. Use when you need to restore a note that was deleted. The note ID must be in the format ‘{integer}-notes’ (e.g., ‘75-notes’).

Input Parameters

string
required
Note ID in the format ‘{integer}-notes’. Example: ‘75-notes’ for note with ID 75.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_UNDELETE_SOURCESTool to undelete a source by ID. Use when you need to restore a previously deleted source in Nutshell.

Input Parameters

string
required
The ID of the source to undelete. IDs are of the form ‘n-sources’, where n is an integer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_UNDELETE_TAGSTool to undelete a previously deleted tag in Nutshell. Use when you need to restore a deleted tag.

Input Parameters

string
required
Tag ID to undelete in the format ‘n-tags’ where n is an integer (e.g., ‘83-tags’, ‘123-tags’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_UPDATE_ACCOUNTSTool to update an account in Nutshell using JSON Patch operations. Use when you need to modify specific account fields like description, name, or relationships. Supports RFC 6902 JSON Patch format with operations: add, remove, replace, move, copy.

Input Parameters

string
required
The ID of the account to update. IDs are of the form ‘n-accounts’, where n is an integer.
array
required
Array of JSON Patch operations to apply to the account. Each operation specifies what change to make.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_UPDATE_CONTACTSTool to update a contact using JSON Patch operations. Use when you need to modify specific fields of an existing contact such as name, description, or links to other entities. Supports updating custom fields and standard fields.

Input Parameters

string
required
The unique identifier of the contact to update. Format: ‘n-contacts’ where n is an integer.
array
required
Array of JSON Patch operations to apply to the contact. Each operation modifies a specific field or relationship.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_UPDATE_LEADSUpdate specific fields of a Nutshell lead using JSON Patch operations, including custom fields. Supports add, remove, and replace operations.

Input Parameters

string
required
Lead ID to update. The unique identifier of the lead in Nutshell CRM in the format ‘number-leads’ (e.g., ‘1007-leads’, ‘123-leads’)
array
required
Array of JSON Patch operations to apply to the lead. Each operation specifies how to modify a specific field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_UPDATE_STATUS_LEADSTool to update the status of a lead in Nutshell CRM. Use when you need to change the outcome status of a lead (e.g., mark as won, lost, or other custom outcomes). Optionally associate competitor maps and product maps when updating the status.

Input Parameters

string
required
Lead ID to update status. The unique identifier of the lead in Nutshell CRM in the format ‘number-leads’ (e.g., ‘1003-leads’, ‘45-leads’)
string
required
ID of the outcome to set for the lead. Required field that determines the status outcome in the format ‘number-outcomes’ (e.g., ‘1-outcomes’)
array
Array of product maps to associate with the lead. Each product map can specify product ID, price, quantity, and other properties. When specifying price, quantity, or other root level productMap properties, you need to specify the productType as well
array
Array of competitor map IDs to associate with the lead when updating status

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_UPDATE_TASKSTool to update a task in Nutshell using JSON Patch operations. Use when you need to modify task fields like title, description, or due time. Supports RFC 6902 JSON Patch format with operations: add, remove, replace, move, copy.

Input Parameters

string
required
The ID of the task to update. IDs are of the form ‘n-tasks’, where n is an integer.
array
required
Array of JSON Patch operations to apply to the task. Each operation specifies what change to make.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NUTSHELL_WATCH_LEADSTool to watch a lead in Nutshell CRM. Use when you need to start watching a lead for updates and notifications.

Input Parameters

string
required
Lead ID to watch. The unique identifier of the lead in Nutshell CRM in the format ‘number-leads’ (e.g., ‘1003-leads’, ‘45-leads’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not