Nutshell

Delete an account by ID. Deleted accounts are removed from the companies tab, and can be restored from the trash within 30 days of deletion via the undelete endpoint. via DELETE /accounts/{id}

Delete a lead-competitor relationship via DELETE /competitormaps/{id}

Deletes a contact from Nutshell. Can be recovered by posting to /contacts/{id}/undelete via DELETE /contacts/{id}

Delete a lead by the ID provided. Can be restored with the undelete endpoint. via DELETE /leads/{id}

Delete a note by the ID provided. Can be restored with the undelete endpoint. via DELETE /notes/{id}

Delete a product on a lead via DELETE /productMaps/{id}

Delete a product via DELETE /products/{id}

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. via DELETE /sources/{id}

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. via DELETE /tags/{id}

Delete a task by the ID provided. via DELETE /tasks/{id}

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. via GET /accounts

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. via GET /accounts/{id}

Get a list of custom field values for an account by ID. Custom fields are user-defined fields that can be added to accounts. via GET /accounts/{id}/customfields

Get a list of all account custom fields in your Nutshell instance. Custom fields are user-defined fields that can be added to accounts. via GET /accounts/customfields/attributes

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. via GET /accounts/list

Get the list of fields that can possibly be associated with accounts, along with whether they are valid for filtering sorting. via GET /accounts/list/fields

Get a list of all account types in a Nutshell instance. via GET /accounttypes

Get activities via GET /activities

Get an activity via GET /activities/{id}

Get activity types via GET /activitytypes

Returns a list of all email marketing audiences in a Nutshell instance. via GET /audiences

Get a list of lead-competitor relationships via GET /competitormaps

Get a lead-competitor relationship via GET /competitormaps/{id}

Get a list of competitors via GET /competitors

Get a competitor via GET /competitors/{id}

Returns a number of contacts which is filterable based on their basic information. via GET /contacts

Returns a single contact based on the provided ID. via GET /contacts/{id}

Returns a list of custom fields for a contact. via GET /contacts/{id}/customfields

Get a list of all custom fields that can be applied to any contact. via GET /contacts/customfields/attributes

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. via GET /contacts/list

Get the list of fields that can possibly be associated with contacts, along with whether they are valid for filtering sorting. via GET /contacts/list/fields

Returns the JSON Schema used to configure dashboard cards and filters. The pipeline options at properties.stageset.enum are limited to pipelines available to the authenticated user. via GET /dashboards/list/fields

Get a list of editions via GET /editions

Get a single edition by its ID via GET /editions/{id}

Get an email via GET /emails/{id}

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. via GET /events

Retrieve a feed of every time an entity was deleted. via GET /events/deleted

Get saved filters via GET /filters

Get all non-archived nutshell forms along with the IDs of the fields used in each form. via GET /forms

Get a single form field by the ID provided. via GET /forms/{fieldId}

Get a single form by the ID provided. The fields used in the form are also returned in the response. via GET /forms/{id}

Retreives the list of valid industries to describe companies as belonging to. via GET /industries

Get a single industry by its ID via GET /industries/{id}

Get a list of invoices via GET /invoices

Get a single invoice by the ID provided. via GET /invoices/{id}

Get a list of all leads and associated data in your Nutshell Instance. via GET /leads

Get a single lead by the ID provided. via GET /leads/{id}

Get user-created custom fields applied to a lead. System-managed attribution identifiers are excluded and are available through the lead's attributionTracking property. via GET /leads/{id}/customfields

Returns the installment schedule for a lead. Requires lead installments on the account plan. via GET /leads/{id}/installments

Get all stages associated with a lead by the ID provided, including information like amount of time spent in each stage. via GET /leads/{id}/stages

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. via GET /leads/customfields/attributes

Get a list of all leads and associated data in your Nutshell Instance, in a list item format. List items have additional fields attached to them for filtering purposes. via GET /leads/list

Get the list of fields that can possibly be associated with leads, along with whether they are valid for filtering sorting. via GET /leads/list/fields

Get reports for a lead via GET /leads/report

Get a list of markets via GET /markets

Get a market by the ID via GET /markets/{id}

Get a list of notes. via GET /notes

Get a single note by the ID provided. via GET /notes/{id}

Get a list of lead outcomes via GET /outcomes

Get a lead outcome by ID via GET /outcomes/{id}

List all product categories via GET /productcategories

Get a product category via GET /productcategories/{id}

A product map is an instance of a product attached to a lead, including quantity and custom pricing information. This endpoint returns all mappings between products and leads. via GET /productmaps

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. via GET /productmaps/{id}

Without q, returns all active products and applies sort. With q, trims the value and performs a case-insensitive name or SKU search limited to 200 products; sort is not applied to search results. An empty q value returns an empty products array. via GET /products

Get a product via GET /products/{id}

Get a list of quotes via GET /quotes

Get a single quote by the ID provided. via GET /quotes/{id}

Returns a list of all possible sources for leads in your Nutshell instance. via GET /sources

Returns active stages from active pipelines that are visible to the authenticated user. OAuth access tokens require the read scope. When pipeline visibility is enabled, stages in restricted pipelines are omitted unless the authenticated user is an administrator or the pipeline is shared directly or through a team. via GET /stages

Returns every pipeline in the authenticated user's Nutshell instance, including archived pipelines. Pipelines are also known as stagesets. OAuth access tokens require the read scope. 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. via GET /stagesets

Get a CSV export of lead movements through a pipeline via GET /stagesets/{id}/export

Get a list of all tags in a Nutshell instance. via GET /tags

Get a list of tasks via GET /tasks

Get a single task by the ID provided. via GET /tasks/{id}

Get a list of territories via GET /territories

Returns the authenticated user's to-dos, or another viewable user's to-dos when filter[assignee] is provided. OAuth access tokens require the read scope. Date windows and facets use the assignee's Nutshell timezone. via GET /todos

Get a list of users via GET /users

Get a user via GET /users/{id}

Update an account by id. op is the operation to be performed, and path specifies what resource to patch. Use the path accounts/0/fieldName to update fields that are user-entered for this resource, i.e. name, description, etc. Use the path accounts/0/links/fieldName to update this account's links to other resources within Nutshell, i.e. contacts, owner, territory, etc. When performing an 'add', include a /- at the end of the path, i.e. accounts/0/links/fieldName/- . When using the remove operation, include the id at the end of the path (i.e. accounts/0/links/contacts/1-contacts) - no need to include a value. Value can alternatively be a list of objects, which can be used with the replace operation and the path accounts/0/urls, accounts/0/addresses, accounts/0/phones, or accounts/0/phones to replace the existing list with a list of new objects. Visit <a href='https://developers.nutshell.com/reference/get_accounts-id'>the account docs</a> for more detail on the structure of these objects. via PATCH /accounts/{id}

Update a lead-competitor relationship via PATCH /competitormaps/{id}

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 other resources within Nutshell, i.e. accounts, owner, territory, emAudiences, etc. When performing an 'add', include a /- at the end of the path, i.e. contacts/0/links/fieldName/- . When using the remove operation, include the id at the end of the path (i.e. contacts/0/links/accounts/1-accounts) - no need to include a value. Value can alternatively be a list of objects, which can be used with the replace operation and the path contacts/0/urls, contacts/0/addresses, contacts/0/phones, contacts/0/phones, contacts/0/links/emAudiences, or contacts/0/links/accounts to replace the existing list with a list of new objects. For certain replace operations like accounts and emAudiences, provide an array of strings as the value. Visit <a href='https://developers.nutshell.com/reference/get_contacts-id-3'>the contact docs</a> for more detail on the structure of these objects. via PATCH /contacts/{id}

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 resources within Nutshell, i.e. contacts, owner, tags, etc. When performing an 'add', include a /- at the end of the path, i.e. leads/0/links/fieldName/- . When using the remove operation, include the id at the end of the path (i.e. leads/0/links/contacts/1-contacts) - no need to include a value. To update the value of the lead with a replace operation, use the path leads/0/manualValue with a value of the amount as a string, or leads/0/valueToProductMode without a value to set the lead's value back to the sum of products. via PATCH /leads/{id}

A product map is an instance of a product attached to a lead, including quantity and custom pricing information which this endpoint allows you to modify. via PATCH /productmaps/{id}

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. via PATCH /tasks/{id}

Create a new account. Accounts are companies or organizations that you do business with, and are referred to as 'Companies' in the Nutshell UI. via POST /accounts

Undelete an account by id. via POST /accounts/{id}/undelete

Creates a custom field to use for accounts. via POST /accounts/customfield

Create an activity via POST /activities

Create an audience. Audiences are used to organize leads, contacts, and accounts into groups for marketing. via POST /audiences

Create a new contact, also known as a person, in Nutshell. Only one contact may be created at a time. via POST /contacts

Undelete a contact via POST /contacts/{id}/undelete

Creates a custom field to use for contacts. via POST /contacts/customfield

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. via POST /invoices/{id}/status

Create a new lead. Only one lead can be created at a time. via POST /leads

Replaces the lead's installment schedule. The request body is a JSON array of installment objects (`id`, `dueTime`, `description`, `value`, `isFailed`). `dueTime` is an ISO 8601 string. Requires lead installments on the account plan. via POST /leads/{id}/installments

Reopen a lead that was previously closed. via POST /leads/{id}/reopen

Pipelines are also known as stagesets. via POST /leads/{id}/stageset

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. via POST /leads/{id}/status

Undelete a lead via POST /leads/{id}/undelete

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. via POST /leads/{id}/watch

Creates a custom field to use for leads. via POST /leads/customfield

Create a note via POST /notes

Undelete a note by the ID provided. via POST /notes/{id}/undelete

Create a new product category. Product categories are used to organize products into groups. via POST /productcategories

Undelete a product via POST /products/{id}/undelete

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. via POST /quotes/{id}/invoice

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. via POST /quotes/{id}/status

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. via POST /sources

Undelete a source by id. via POST /sources/{id}/undelete

Create a tag. Tags are used to organize leads, contacts, and accounts into groups. via POST /tags

Undelete a tag by id. Tags can be restored from the trash within 30 days of deletion. via POST /tags/{id}/undelete

Create a new task via POST /tasks

Update an activity via PUT /activities/{id}