Skip to main content
Nutshell
Nutshell
75 actions · 1 auth method
CRM

Authentication

API Key

Use your Nutshell email and API key for Basic Authentication.Guides: Connector Profile, Link Account
Actions
75 actions
Action
Description
List Users
Retrieve a list of all users in the Nutshell account
Get User
Retrieve a specific user by their ID
List Contacts
Retrieve a paginated list of contacts in Nutshell
List Contact Items
Retrieve all contacts in a list item format with additional filtering and sorting fields
Get Contact
Retrieve a specific contact by their ID
Create Contact
Create a new contact (person) in Nutshell
Update Contact
Update an existing contact by ID using JSON Patch operations
Delete Contact
Delete a contact from Nutshell
Undelete Contact
Restore a previously deleted contact by their ID
List Contact Fields
Retrieve the list of fields available for contacts
List Contact Custom Field Attributes
Retrieve all contact custom field definitions in the Nutshell instance
Get Contact Custom Fields
Retrieve custom field values for a specific contact
Create Contact Custom Field
Create a new custom field definition for contacts
List Accounts
Retrieve a paginated list of accounts in Nutshell
List Account Items
Retrieve all accounts in a list item format with additional filtering and sorting fields
Get Account
Retrieve a specific account by its ID
Create Account
Create a new account (company) in Nutshell
Update Account
Update an existing account by ID using JSON Patch operations
Delete Account
Delete an account from Nutshell
Undelete Account
Restore a previously deleted account by its ID
List Account Fields
Retrieve the list of fields available for accounts
List Account Types
Retrieve all account types in the Nutshell instance
List Industries
Retrieve the list of valid industries in Nutshell
List Account Custom Field Attributes
Retrieve all account custom field definitions in the Nutshell instance
Get Account Custom Fields
Retrieve custom field values for a specific account
Create Account Custom Field
Create a new custom field definition for accounts
List Leads
Retrieve a paginated list of leads in Nutshell
List Lead Items
Retrieve all leads in a list item format with additional filtering and sorting fields
Get Lead
Retrieve a specific lead by its ID
Create Lead
Create a new lead (sales opportunity) in Nutshell
Update Lead
Update an existing lead by ID using JSON Patch operations
Delete Lead
Delete a lead from Nutshell
Undelete Lead
Restore a previously deleted lead by its ID
Update Lead Status
Update the status of a lead including outcome, competitors, and products
Set Lead Pipeline
Assign a lead to a pipeline (stageset)
Reopen Lead
Reopen a previously closed lead
Watch Lead
Toggle notifications for a lead
Get Lead Stages
Retrieve the stage progression data for a specific lead
Get Leads Report
Generate a report for leads with customizable filtering and grouping
List Lead Fields
Retrieve the list of fields available for leads
List Lead Custom Field Attributes
Retrieve all lead custom field definitions in the Nutshell instance
Get Lead Custom Fields
Retrieve custom field values for a specific lead
Create Lead Custom Field
Create a new custom field definition for leads
List Outcomes
Retrieve a list of all lead outcomes in Nutshell
Get Outcome
Retrieve a specific lead outcome by its ID
List Activities
Retrieve a list of activities in Nutshell
Get Activity
Retrieve a specific activity by its ID
Create Activity
Create a new activity in Nutshell
Update Activity
Update an existing activity by its ID
List Activity Types
Retrieve all available activity types in Nutshell
List Tasks
Retrieve a paginated list of tasks in Nutshell
Get Task
Retrieve a specific task by its ID
Create Task
Create a new task in Nutshell
Update Task
Update an existing task by ID using JSON Patch operations
Delete Task
Delete a task from Nutshell
List Notes
Retrieve a paginated list of notes in Nutshell
Get Note
Retrieve a specific note by its ID
Create Note
Create a new note in Nutshell
Delete Note
Delete a note from Nutshell
Undelete Note
Restore a previously deleted note by its ID
List Tags
Retrieve a list of all tags in the Nutshell instance
Create Tag
Create a new tag in Nutshell
Delete Tag
Delete one or more tags from Nutshell
Undelete Tag
Restore a previously deleted tag by its ID
List Sources
Retrieve a list of lead sources in Nutshell
Create Source
Create a new lead source in Nutshell
Delete Source
Delete a lead source from Nutshell
Undelete Source
Restore a previously deleted lead source by its ID
List Products
Retrieve a list of products in Nutshell
Get Product
Retrieve a specific product by its ID
Delete Product
Delete a product from Nutshell
Undelete Product
Restore a previously deleted product by its ID
List Product Categories
Retrieve all product categories in Nutshell
Get Product Category
Retrieve a specific product category by its ID
Create Product Category
Create a new product category in Nutshell

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/nutshell/filled/png

Connector Profile

Nutshell - API Key
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/nutshell/filled/png

Link Account

Nutshell - API Key
4

Use Actions

Invoke actions using one of the methods below: