Reference

Create Accounts

Add new company accounts to your Nutshell CRM with essential contact information like name, phone, email, or website details.

List Accounts

Retrieves all accounts from your Nutshell CRM with optional filtering and sorting capabilities, allowing you to access your complete customer database on demand.

Create Custom Field for Accounts

Add custom fields to your company accounts in Nutshell to track information specific to your business needs, such as industry details, partnership status, or budget limits.

Delete Account

Permanently removes an account from your Nutshell CRM, which is useful when you need to clean up your customer database or end a business relationship. This action cannot be reversed, so use it carefully when you're certain the account should be deleted.

Edit Nutshell Account

Update account information in your CRM such as company name, description, tags, contact details, or associations. This keeps your customer records current and organized without manually navigating your CRM interface.

Get Account

Retrieve detailed information about a specific customer account in Nutshell, including contact details, company information, and account history. This helps you quickly access customer data without navigating the platform manually.

Get Account Custom Fields

Retrieve all custom field definitions and values for a specific account in Nutshell, allowing you to access account-specific data that extends beyond standard fields.

List Account Custom Field Attributes

Retrieve all custom fields available for account records in your Nutshell CRM, including their names, types, and configuration details. Use this to understand what account data you can track and manage within your CRM system.

List Account Fields

Retrieves all available custom and standard fields for account records in Nutshell, including their data types and configurations. Use this to understand what account information you can store and manage in your CRM.

List Account Types

Retrieve all available account types configured in your Nutshell CRM system. Use this to understand what account classification options are available for organizing and categorizing your contacts.

Undelete Account

Restore a previously deleted account in your CRM system, bringing back all associated account information and contact history. Use this when you need to reactivate a customer relationship that was accidentally removed or is returning to do business.

Update Account with JSON Patch

Modify specific fields in a Nutshell account record using targeted updates without changing the entire record. Use this to keep account details like names, descriptions, and relationships current as your business evolves.

Create Activities

Log phone calls, meetings, emails, and notes in your CRM to maintain a complete activity history with your contacts and leads. Use this to track customer interactions and keep your team aligned on relationship progress.

Get Activity

Retrieve detailed information about a specific activity in your Nutshell CRM, such as calls, emails, meetings, or tasks associated with your contacts and deals.

List Activities

Retrieve all activities from your Nutshell CRM with optional filtering by participants, status, or date range to track customer interactions and follow-ups.

List Activity Types

Retrieve all activity types available in your Nutshell CRM system to understand what types of customer interactions you can track and log.

List Competitor Maps

Retrieve all competitor mappings associated with your leads to understand which competitors are engaged in each deal. This helps you track competitive threats and adjust your sales strategy accordingly.

List Competitors

Retrieve a list of all competitors tracked in your Nutshell CRM or search for specific competitors by name to stay informed about your competitive landscape.

List Editions

Retrieve all available editions from your Nutshell CRM account to understand pricing tiers and feature sets. Use this when evaluating which edition matches your business needs or managing multiple team editions.

List Filters

Retrieve all saved filters from your Nutshell CRM to quickly access pre-configured views and segments for leads, contacts, and accounts. This helps you reuse filtering logic across reports and data lists without manually recreating filters each time.

List Industries

Retrieve all available industry classifications from your Nutshell CRM to understand what options are available for categorizing your contacts and accounts.

List Markets

Retrieve all available markets from your Nutshell CRM system to view market details and currency information for your sales operations.

List Territories

Retrieve all territories configured in your Nutshell CRM to view your sales regions and get territory identifiers for assigning leads or organizing your team.

Create Contacts

Add new contacts to your Nutshell CRM with email, phone, or other identifying information so you can track and manage relationships with prospects and customers.

List Contacts

Retrieve your contacts from Nutshell CRM with filtering and search capabilities to find specific people in your database. Use this when you need to access contact information for outreach, reporting, or workflow automation.

Delete Contact

Remove a contact from your Nutshell CRM when you no longer need to maintain their information, such as when a prospect is no longer interested or a business relationship ends.

Get Contact

Retrieve detailed information about a specific contact from your Nutshell CRM by their ID, including their contact details, communication history, and associated data.

Get Contact Custom Fields

Retrieve custom field definitions and values for a specific contact in Nutshell, allowing you to view all personalized data attributes stored for that contact.

List Contact Custom Field Attributes

Retrieve all custom field attributes available for contacts in your Nutshell CRM, allowing you to see which custom fields you can use to store and organize contact information.

List Contact Fields

Retrieve all available contact fields in Nutshell to understand what data attributes you can store and manage for each contact record.

List Contacts

Retrieve all contacts from your Nutshell CRM with optional filtering and sorting capabilities. Use this to access your contact database for analysis, reporting, or integration with other business tools.

Undelete Contact

Restore a previously deleted contact in Nutshell CRM to regain access to their information and communication history. Use this when you accidentally delete a contact or need to reactivate a relationship with a past customer.

Update Nutshell Contact

Modify specific details of an existing contact in your CRM, including name, description, custom fields, and relationships to other entities.

List Deleted Events

Retrieve a feed of deleted events from your Nutshell CRM to track which contacts, deals, or other records have been removed and when they were deleted.

List Events

Retrieve a list of events from your Nutshell CRM to track customer interactions, activity history, and team actions. Useful for staying updated on what's happening with your contacts and deals.

List Forms

Retrieve all available forms from your Nutshell CRM account to view, manage, or integrate your lead capture forms.

List Invoices

Retrieve a list of invoices from your Nutshell CRM with optional filtering by lead, date range, and pagination to track billing activity and financial records.

Create Lead

Add a new lead to your Nutshell CRM with essential contact information and optional custom details. Use this to quickly capture and organize new prospects in your sales pipeline.

List Leads

Retrieve and view multiple leads from your Nutshell CRM database with the ability to filter, search, and organize results to find specific prospects.

Update Lead

Modify specific lead information in Nutshell CRM, such as contact details, status, or custom fields, without affecting other lead data.

Create Custom Field for Leads

Add custom fields to your lead records in Nutshell to track information specific to your business needs, such as referral sources, lead scores, or industry type.

Delete Lead

Remove a lead from your Nutshell CRM when it's no longer relevant or a duplicate. Nutshell safely soft-deletes leads so you can recover them if needed.

Get Lead

Retrieve detailed information about a specific lead in your Nutshell CRM by ID. Use this when you need to access a lead's contact details, interaction history, or status to follow up or make business decisions.

Get Lead's Custom Fields

Retrieve all custom field data associated with a specific lead in Nutshell CRM, allowing you to access lead-specific information stored in your custom fields.

Get Leads Report

Generate analytics and reports on your leads in Nutshell CRM, including sales performance, pipeline status, new lead activity, and forecasts with optional filtering by date ranges and segments.

List Lead Custom Field Attributes

Retrieves all custom field definitions and configurations available for leads in your Nutshell CRM, helping you understand what data fields you can track and manage for your leads.

List Lead Fields

Retrieve all available fields and their properties for lead records in Nutshell to understand what data you can capture and work with. Useful for planning your lead management strategy and ensuring you're collecting the right customer information.

List Leads

Retrieve all leads from your Nutshell CRM with optional filtering and sorting capabilities, allowing you to access your prospect database on demand.

Reopen Lead

Reopen a lead that was previously closed or marked as won, allowing you to re-engage with prospects or customers who are relevant again. This is useful when deals fall through, customers want to revisit opportunities, or leads need further follow-up.

Undelete Lead

Restore a lead that was previously deleted from your Nutshell CRM, bringing back all associated contact information and history so you can continue working with that prospect.

Update Lead Status

Move leads through your sales pipeline by updating their status to reflect where they stand in your sales process, such as marking them as won, lost, or any custom outcome stage you've defined.

Watch Lead

Monitor a lead in Nutshell CRM to receive real-time updates and notifications about their activity and status changes.

Create Notes

Attach notes to contacts, leads, accounts, or other entities in your Nutshell CRM to keep important context and communication history organized in one place.

Delete Note

Permanently remove notes from Nutshell CRM when they're no longer needed or contain outdated information. This helps keep your customer records clean and organized by removing clutter from deal and contact histories.

Get Note

Retrieve a specific note from your Nutshell CRM to access stored details, context, or follow-up information about a customer interaction or deal.

List Notes

Retrieve a list of notes from your Nutshell CRM, with optional filtering and pagination to manage large volumes of customer interactions and follow-ups.

Undelete Note

Restore a previously deleted note in your Nutshell CRM so you don't lose important customer interaction details. This is useful when notes are accidentally removed or you need to recover important information.

List Lead Outcomes

Retrieve all available lead outcome options from your Nutshell CRM to understand what statuses or results you can assign to leads in your pipeline.

List Lead Stages

Retrieves all workflow stages associated with a specific lead in your Nutshell CRM, helping you track where each prospect stands in your sales pipeline. Use this to understand the complete journey of a lead from initial contact through conversion.

List Pipelines

Retrieve all sales pipelines from your Nutshell CRM to see your available sales stages and manage leads across different pipeline workflows.

List Stages

Retrieves all available sales pipeline stages from your Nutshell CRM, allowing you to understand your sales process workflow and reference stage IDs for lead management tasks.

Set Lead Pipeline

Assign a lead to a specific sales pipeline in Nutshell CRM to organize prospects according to your sales process and track their progress through different stages.

Delete Product Map

Remove a product from a lead's record when it's no longer relevant or was added by mistake, with permanent deletion of that association.

Get Product Category

Retrieves detailed information about a specific product category from your Nutshell CRM, including its properties and settings. Use this when you need to verify category details or access category information for reporting or integration purposes.

List Product Categories

Retrieve all product categories configured in your Nutshell CRM to view your complete product taxonomy and organization structure.

List Product Maps

Retrieves the list of product mappings in your Nutshell CRM, showing which products are associated with leads and deals. This helps you understand your product portfolio and track product-customer relationships.

List Products

Retrieve your product catalog from Nutshell CRM with optional filtering by name or SKU to quickly access inventory details. Useful for finding specific products or reviewing your complete product lineup.

List Quotes

Retrieve a list of quotes from your Nutshell CRM with optional filtering by lead, date range, and pagination to track all your sales proposals in one place.

Create Sources

Create new lead sources in Nutshell CRM to track and categorize where your leads originate, helping you understand which marketing channels and strategies are most effective.

List Sources

Retrieve all available lead sources from your Nutshell CRM to understand where your contacts are coming from and manage lead attribution.

Undelete Source

Restore a previously deleted lead source in your Nutshell CRM, allowing you to reactivate tracking channels that were accidentally removed or are needed again.

Create Tags

Create new organizational tags in Nutshell to categorize and segment your leads, contacts, or accounts for better organization and targeting. This helps you quickly sort and filter your database by custom categories relevant to your business.

List Tags

Retrieve all available tags from your Nutshell CRM, with the ability to filter by name or type to find specific tags used for organizing leads, contacts, and accounts.

Undelete Tag

Restore a tag that was previously deleted in Nutshell, allowing you to recover your tagging structure without losing your organizational system.

Delete Task

Remove a task from your Nutshell CRM when it's no longer needed or completed. Deleted tasks are soft-deleted, meaning you can recover them if necessary.

Get Task

Retrieve detailed information about a specific task in your Nutshell CRM, including status, due dates, and assigned details.

Update Task with JSON Patch

Modify task details in Nutshell such as titles, descriptions, and due dates using standard JSON Patch format. Ideal for automating task updates triggered by other business events or workflows.

List Users

Retrieve all users currently set up in your Nutshell CRM account to manage team access and understand who has data visibility across your organization.