# Nutshell integration

> Nutshell CRM REST API: accounts (companies), contacts, leads, activities, tasks, notes, products, pipelines, quotes, invoices, tags and events.

- Authentication: apiKey

## Tools (114)

- **Create a account custom field**: Creates a custom field to use for accounts.
- **Create a contact**: Create a new contact (person). Only one contact may be created at a time.
- **Create a contact custom field**: Creates a custom field to use for contacts.
- **Create a lead**: Create a new lead. Only one lead can be created at a time.
- **Create a lead custom field**: Creates a custom field to use for leads.
- **Create an account**: Create a new account (company).
- **Create an activity**: Create an activity
- **Create an audience**: Create an audience. Audiences are used to organize leads, contacts, and accounts into groups for marketing.
- **Create a new source**: Create a new source for leads in your Nutshell instance. Sources are used to track how leads arrive at your website and learn about your business.
- **Create a new task**: Create a new task
- **Create an invoice from a quote**: Creates a new invoice by duplicating the quote (same as in-app create invoice from quote). Line items, recipient, and most document fields are copied from the quote; invoice template defaults apply for payment/body/footer fields. No request body is required.
- **Create a note**: Create a note
- **Create a product category**: Create a new product category. Product categories are used to organize products into groups.
- **Create a tag**: Create a tag. Tags are used to organize leads, contacts, and accounts into groups.
- **Delete a contact**: Deletes a contact from Nutshell. Can be recovered by posting to /contacts/{id}/undelete
- **Delete a lead**: Delete a lead by the ID provided. Can be restored with the undelete endpoint.
- **Delete a lead-competitor relationship**: Delete a lead-competitor relationship
- **Delete an account**: Delete an account by ID. Restorable within 30 days via the undelete endpoint.
- **Delete a note**: Delete a note by the ID provided. Can be restored with the undelete endpoint.
- **Delete a product**: Delete a product
- **Delete a product on a lead**: Delete a product on a lead
- **Delete a Source**: Delete a source by ID. Deleted sources are removed from the sources tab, and can be restored from the trash within 30 days of deletion via the undelete endpoint.
- **Delete a tag**: Delete a tag by id. Deleted tags are removed from the list of tags, and can be restored from the trash within 30 days of deletion via the undelete endpoint.
- **Delete a task**: Delete a task by the ID provided.
- **Get a competitor**: Get a competitor
- **Get a contact**: Returns a single contact based on the provided ID.
- **Get a CSV export of lead movements through a pipeline**: Get a CSV export of lead movements through a pipeline
- **Get activities**: Get activities
- **Get activity types**: Get activity types
- **Get a form**: Get a single form by the ID provided. The fields used in the form are also returned in the response.
- **Get a form field**: Get a single form field by the ID provided.
- **Get a lead**: Get a single lead by the ID provided.
- **Get a lead-competitor relationship**: Get a lead-competitor relationship
- **Get a lead outcome by ID**: Get a lead outcome by ID
- **Get a lead's custom fields**: Get user-created custom fields applied to a lead. System-managed attribution identifiers are excluded and are available through the lead's attributionTracking property.
- **Get a list of accounts**: Get all accounts and associated data in your Nutshell instance. Accounts are companies or organizations that you do business with, and are referred to as 'Companies' in the Nutshell UI.
- **Get a list of account types**: Get a list of all account types in a Nutshell instance.
- **Get a list of audiences**: Returns a list of all email marketing audiences in a Nutshell instance.
- **Get a list of competitors**: Get a list of competitors
- **Get a list of contacts**: Returns a number of contacts which is filterable based on their basic information.
- **Get a list of custom fields**: Get a list of all account custom fields in your Nutshell instance.
- **Get a list of editions**: Get a list of editions
- **Get a list of events**: Retrieve a feed of events. Events, also known as change logs, are a record of everything that happened in Nutshell. They're used to power notifications and timelines among other things.
- **Get a list of industries**: Retreives the list of valid industries to describe companies as belonging to.
- **Get a list of invoices**: Get a list of invoices
- **Get a list of lead-competitor relationships**: Get a list of lead-competitor relationships
- **Get a list of lead outcomes**: Get a list of lead outcomes
- **Get a list of leads**: Get a list of all leads and associated data in your Nutshell Instance.
- **Get a list of markets**: Get a list of markets
- **Get a list of notes**: Get a list of notes.
- **Get a list of pipelines**: Returns every pipeline in the authenticated user's Nutshell instance, including archived pipelines. Pipelines are also known as stagesets. When pipeline visibility is enabled, restricted pipelines are omitted unless the authenticated user is an administrator or the pipeline is shared directly or through a team.
- **Get a list of quotes**: Get a list of quotes
- **Get a list of sources**: Returns a list of all possible sources for leads in your Nutshell instance.
- **Get a list of stages**: Returns active stages from active pipelines visible to the authenticated user.
- **Get a list of tags**: Get a list of all tags in a Nutshell instance.
- **Get a list of tasks**: Get a list of tasks
- **Get a list of territories**: Get a list of territories
- **Get a list of users**: Get a list of users
- **Get all forms**: Get all non-archived nutshell forms along with the IDs of the fields used in each form.
- **Get all stages associated with lead**: Get all stages associated with a lead, including time spent in each stage.
- **Get a market by the ID**: Get a market by the ID
- **Get an account**: Get an account by ID. Accounts are companies or organizations that you do business with, and are referred to as 'Companies' in the Nutshell UI. The returned arrays creators, owners, origins, contacts, accountTypes, and industries contain additional information corresponding to the requested accounts
- **Get an activity**: Get an activity
- **Get an email**: Get an email
- **Get an invoice**: Get a single invoice by the ID provided.
- **Get a note**: Get a single note by the ID provided.
- **Get applicable custom fields**: Get a list of all custom fields that can be applied to any contact.
- **Get applicable custom fields for leads**: Get user-created custom fields that can be applied to leads. System-managed attribution identifiers are excluded and are available through the lead's attributionTracking property.
- **Get a product**: Get a product
- **Get a product category**: Get a product category
- **Get a quote**: Get a single quote by the ID provided.
- **Get a single edition by its ID**: Get a single edition by its ID
- **Get a single industry by its ID**: Get a single industry by its ID
- **Get a task**: Get a single task by the ID provided.
- **Get a user**: Get a user
- **Get contact custom fields**: Returns a list of custom fields for a contact.
- **Get custom fields**: Get a list of custom field values for an account by ID.
- **Get dashboard field definitions**: Returns the JSON Schema used to configure dashboard cards and filters.
- **Get deletion events**: Retrieve a feed of every time an entity was deleted.
- **Get installments for a lead**: Returns the installment schedule for a lead. Requires lead installments on the account plan.
- **Get lead product**: A product map is an instance of a product attached to a lead, including quantity and custom pricing information. This endpoint returns a single mapping between a particular product and lead.
- **Get lead products**: Returns all mappings between products and leads (product maps).
- **Get list items for all accounts**: Get a list of all accounts and associated data in your Nutshell Instance, in a list item format. List items have additional fields attached to them for filtering purposes.
- **Get list items for all contacts**: Get a list of all contacts and associated data in your Nutshell Instance, in a list item format. List items have additional fields attached to them for filtering purposes. Contacts are people that you do business with, and are referred to as 'People' in the Nutshell UI.
- **Get list items for all leads**: Get a list of all leads in list item format, with additional fields for filtering.
- **Get reports for a lead**: Get reports for a lead
- **Get saved filters**: Get saved filters
- **Get tasks and sales process steps**: Returns the authenticated user's to-dos, or another viewable user's to-dos when filter[assignee] is provided. Date windows and facets use the assignee's Nutshell timezone.
- **Get the fields for a contact**: Get the list of fields that can possibly be associated with contacts, along with whether they are valid for filtering sorting.
- **Get the fields for a lead**: Get the list of fields that can be associated with leads, and whether they are valid for filtering and sorting.
- **Get the fields for an account**: Get the list of fields that can possibly be associated with accounts, along with whether they are valid for filtering sorting.
- **List all product categories**: List all product categories
- **List or search products**: Without q, returns all active products and applies sort. With q, case-insensitive name or SKU search limited to 200 products.
- **Reopen a lead**: Reopen a lead that was previously closed.
- **Set the pipeline for a lead**: Pipelines are also known as stagesets.
- **Undelete a contact**: Undelete a contact
- **Undelete a lead**: Undelete a lead
- **Undelete an account**: Undelete an account by id.
- **Undelete a note**: Undelete a note by the ID provided.
- **Undelete a product**: Undelete a product
- **Undelete a Source**: Undelete a source by id.
- **Undelete a tag**: Undelete a tag by id. Tags can be restored from the trash within 30 days of deletion.
- **Update a contact**: Update a contact by id. op is the operation to be performed, and path specifies what resource to patch. Use the path contacts/0/fieldName to update fields that are user-entered for this resource, i.e. name, description, etc. Use the path contacts/0/links/fieldName to update this contact's links to o
- **Update a lead**: Update a lead by id. op is the operation to be performed, and path specifies what resource to patch. Use the path leads/0/fieldName to update fields that are user-entered for this resource, i.e. name, description, etc. Use the path leads/0/links/fieldName to update this lead's links to other resourc
- **Update a lead-competitor relationship**: Update a lead-competitor relationship
- **Update a lead's product information**: Modify the quantity and custom pricing of a product attached to a lead (product map).
- **Update an account**: Update an account by id using JSON Patch operations.
- **Update an activity**: Update an activity
- **Update a task**: Update a task by id. op is the operation to be performed, and path specifies what resource to patch. Use the path tasks/0/links/assignee to update the assigned user, using their ID.
- **Update installments for a lead**: Replaces the lead's installment schedule. Requires lead installments on the account plan.
- **Update the status of a lead**: Update the status of a lead, for example, close a lead as won or lost. Also allows for setting the outcome of the lead, and competitor and product maps.
- **Update the status of an invoice**: Updates an invoice to a native Nutshell status (READY, SENT, REVOKED, ACCEPTED, ARCHIVED). ACCEPTED marks the invoice as paid. Optional comment is stored as payment/completion metadata.
- **Update the status of a quote**: Updates a quote to a native Nutshell status (READY, SENT, REVOKED, ACCEPTED, ARCHIVED). Odoo-specific fulfillment states should be stored on the lead via custom fields.
- **Watch a lead**: Watch/unwatch a lead to receive (or stop receiving) notifications about it. The user this change is made for is the authenticated user when making the api call.

Connect Nutshell in General Input: https://www.generalinput.com/apps/nutshell