Nutshell

Retrieve a list of all users in the Nutshell account

Retrieve a specific user by their ID

Retrieve a paginated list of contacts in Nutshell

Retrieve all contacts in a list item format with additional filtering and sorting fields

Retrieve a specific contact by their ID

Create a new contact (person) in Nutshell

Update an existing contact by ID using JSON Patch operations

Delete a contact from Nutshell

Restore a previously deleted contact by their ID

Retrieve the list of fields available for contacts

Retrieve all contact custom field definitions in the Nutshell instance

Retrieve custom field values for a specific contact

Create a new custom field definition for contacts

Retrieve a paginated list of accounts in Nutshell

Retrieve all accounts in a list item format with additional filtering and sorting fields

Retrieve a specific account by its ID

Create a new account (company) in Nutshell

Update an existing account by ID using JSON Patch operations

Delete an account from Nutshell

Restore a previously deleted account by its ID

Retrieve the list of fields available for accounts

Retrieve all account types in the Nutshell instance

Retrieve the list of valid industries in Nutshell

Retrieve all account custom field definitions in the Nutshell instance

Retrieve custom field values for a specific account

Create a new custom field definition for accounts

Retrieve a paginated list of leads in Nutshell

Retrieve all leads in a list item format with additional filtering and sorting fields

Retrieve a specific lead by its ID

Create a new lead (sales opportunity) in Nutshell

Update an existing lead by ID using JSON Patch operations

Delete a lead from Nutshell

Restore a previously deleted lead by its ID

Update the status of a lead including outcome, competitors, and products

Assign a lead to a pipeline (stageset)

Reopen a previously closed lead

Toggle notifications for a lead

Retrieve the stage progression data for a specific lead

Generate a report for leads with customizable filtering and grouping

Retrieve the list of fields available for leads

Retrieve all lead custom field definitions in the Nutshell instance

Retrieve custom field values for a specific lead

Create a new custom field definition for leads

Retrieve a list of all lead outcomes in Nutshell

Retrieve a specific lead outcome by its ID

Retrieve a list of activities in Nutshell

Retrieve a specific activity by its ID

Create a new activity in Nutshell

Update an existing activity by its ID

Retrieve all available activity types in Nutshell

Retrieve a paginated list of tasks in Nutshell

Retrieve a specific task by its ID

Create a new task in Nutshell

Update an existing task by ID using JSON Patch operations

Delete a task from Nutshell

Retrieve a paginated list of notes in Nutshell

Retrieve a specific note by its ID

Create a new note in Nutshell

Delete a note from Nutshell

Restore a previously deleted note by its ID

Retrieve a list of all tags in the Nutshell instance

Create a new tag in Nutshell

Delete one or more tags from Nutshell

Restore a previously deleted tag by its ID

Retrieve a list of lead sources in Nutshell

Create a new lead source in Nutshell

Delete a lead source from Nutshell

Restore a previously deleted lead source by its ID

Retrieve a list of products in Nutshell

Retrieve a specific product by its ID

Delete a product from Nutshell

Restore a previously deleted product by its ID

Retrieve all product categories in Nutshell

Retrieve a specific product category by its ID

Create a new product category in Nutshell

Responds to Nutshell’s ping request with a 200 OK to confirm the webhook endpoint is active.

Emitted when a new contact (person) is created. Maps to Nutshell event where payloadType is contacts and action is `cr…

Emitted when a contact’s attributes are changed (name, address, phone, custom fields, owner, description, etc.). Maps to…

Emitted when a contact is deleted. Maps to Nutshell event where payloadType is contacts and action is delete.

Emitted when a new company (account) is created. Maps to Nutshell event where payloadType is accounts and action is `c…

Emitted when a company’s attributes are changed (name, address, industry, custom fields, owner, description, etc.). Maps…

Emitted when a company (account) is deleted. Maps to Nutshell event where payloadType is accounts and action is `delet…

Emitted when a new lead is created. Maps to Nutshell event where payloadType is leads and action is create.

Emitted when a lead’s attributes change (description, due time, confidence, stage, value, products, etc.). Maps to Nutsh…

Emitted when a lead is deleted. Maps to Nutshell event where payloadType is leads and action is delete.

Emitted when a new activity is created. Maps to Nutshell event where payloadType is activities and action is create.

Emitted when an activity’s details change (name, description, time, status). Maps to Nutshell event where payloadType is…

Emitted when an activity is deleted. Maps to Nutshell event where payloadType is activities and action is delete.

Emitted when an activity is logged (marked as completed). Maps to Nutshell event where payloadType is activities and a…

Emitted when a scheduled activity is cancelled. Maps to Nutshell event where payloadType is activities and action is `…

Emitted when a contact, lead, or account is assigned to a user. Maps to Nutshell event where payloadType is `assignments…

Emitted when an assignment is updated (reassigned to a different user). Maps to Nutshell event where payloadType is `ass…

Emitted when an assignment is removed. Maps to Nutshell event where payloadType is assignments and action is delete.

Emitted when a note is added to a contact, account, or lead. Maps to Nutshell event where payloadType is notes and act…

Emitted when a note is edited. Maps to Nutshell event where payloadType is notes and action is update.

Emitted when a note is deleted. Maps to Nutshell event where payloadType is notes and action is delete.

Emitted when two contacts are merged into one. The changes array contains the merged_with_id. Maps to Nutshell event whe…

Emitted when two companies (accounts) are merged into one. Maps to Nutshell event where payloadType is accounts and ac…

Emitted when two leads are merged into one. Maps to Nutshell event where payloadType is leads and action is merge.

Emitted when a file is uploaded to a contact, account, or lead. Maps to Nutshell event where payloadType is files and…

Emitted when a file is deleted from a contact, account, or lead. Maps to Nutshell event where payloadType is files and…