# Nutshell Documentation

> Documentation for Nutshell

## Guides
- [🟢 Get started with Nutshell’s APIs](https://developers.nutshell.com/docs/getting-started.md): Discover how our APIs help you connect with the data you store in Nutshell
- [🔒 API authentication](https://developers.nutshell.com/docs/api-authentication.md)
- [Nutshell terms](https://developers.nutshell.com/docs/nutshell-terms.md): Here's a quick introduction to the terms and data you'll encounter inside of Nutshell. These definitions are focused toward developers who are integrating with Nutshell.
- [API IDs](https://developers.nutshell.com/docs/api-ids.md): Nutshell uses identifiers to refer to various entities
- [Filters](https://developers.nutshell.com/docs/filters.md)
- [Links](https://developers.nutshell.com/docs/links.md)
- [Audience management](https://developers.nutshell.com/docs/audience-management.md)
- [Quickstart](https://developers.nutshell.com/docs/quickstart.md): Get started right away using Nutshell's REST API with these common operations!
- [Get started with the JSON-RPC API](https://developers.nutshell.com/docs/get-started-with-the-json-rpc-api.md)
- [Working with webhooks](https://developers.nutshell.com/docs/working-with-webhooks.md): Nutshell can emit webhooks during various changes in the app: subscribe for HTTP updates when contacts are edited, leads are won, and more.
- [Sample webhook payload](https://developers.nutshell.com/docs/sample-webhook-payload.md)

## API Reference
- [Get an account](https://developers.nutshell.com/reference/e011fe1a74d2ca75e6294040b98423f1.md): 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.  <br> <br> The returned arrays creators, owners, origins, contacts, accountTypes, and industries contain additional information corresponding to the requested accounts.
- [Delete an account](https://developers.nutshell.com/reference/2ab29d8b08add12de00c9075a1dc934f.md): 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.
- [Update an account](https://developers.nutshell.com/reference/48bf7b1de74805c35713fb7b3a9f1e52.md): Update an account by id. <br><br> op is the operation to be performed, and path specifies what resource to patch. <br><br> Use the path accounts/0/fieldName to update fields that are user-entered for this resource, i.e. name, description, etc. <br> <br> 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/- .  <br><br> 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. <br><br> 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.
- [Get custom fields](https://developers.nutshell.com/reference/31ef0f539b00b82d394f351491b80103.md): Get a list of custom field values for an account by ID. Custom fields are user-defined fields that can be added to accounts.
- [Get a list of custom fields](https://developers.nutshell.com/reference/09c7340848e47c8b7727d7e316702d3d.md): Get a list of all account custom fields in your Nutshell instance. Custom fields are user-defined fields that can be added to accounts.
- [Create a custom field](https://developers.nutshell.com/reference/aa09106535968abeb7ea879a5774eec7.md): Creates a custom field to use for accounts.
- [Get list items for all accounts](https://developers.nutshell.com/reference/fea99eec1a11b79a75fd3c6092ea1c95.md): 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 a list of accounts](https://developers.nutshell.com/reference/ee7a9535ab7ae30da91d6d9cebe2ed85.md): 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.
- [Create an account](https://developers.nutshell.com/reference/0e0199fef8e93c05437d3a33104886d1.md): Create a new account. Accounts are companies or organizations that you do business with, and are referred to as 'Companies' in the Nutshell UI.
- [Undelete an account](https://developers.nutshell.com/reference/23c63a8f80517c993fb93e50e216167b.md): Undelete an account by id.
- [Get a list of account types](https://developers.nutshell.com/reference/73f17127f4378721e7a57e7a7890b1b3.md): Get a list of all account types in a Nutshell instance.
- [Get a list of industries](https://developers.nutshell.com/reference/7e2ccf9488b1ee4f602c7059eee817e5.md): Retreives the list of valid industries to describe companies as belonging to.
- [Get the fields for an account](https://developers.nutshell.com/reference/4eb956de07606de9ea86f6b39feeff20.md): Get the list of fields that can possibly be associated with accounts, along with whether they are valid for filtering sorting.
- [Get activities](https://developers.nutshell.com/reference/afbafbf6832a5c50439963afb493230f.md)
- [Create an activity](https://developers.nutshell.com/reference/245ac4db7d1ce9919113871e1fd9d14c.md)
- [Get an activity](https://developers.nutshell.com/reference/386cd1704288a91f21d7ea531d7cdcf6.md)
- [Get activity types](https://developers.nutshell.com/reference/e09bcf63999a97ba02d8f461039bbba2.md)
- [Update an activity](https://developers.nutshell.com/reference/cc696feb60257dd8d550082b06513c14.md)
- [Get a list of audiences](https://developers.nutshell.com/reference/0e172d1fdc100344130d7c677ea0b498.md): Returns a list of all email marketing audiences in a Nutshell instance.
- [Create an audience](https://developers.nutshell.com/reference/9e1046e87d298eda177cb6323ddaa01c.md): Create an audience. Audiences are used to organize leads, contacts, and accounts into groups for marketing.
- [Get a competitor](https://developers.nutshell.com/reference/c7625772e8320ae9d155b40b1974291b.md)
- [Get a list of competitors](https://developers.nutshell.com/reference/3013cdcf2331b70ff8d2cebc7a4c3c81.md)
- [Get a lead-competitor relationship](https://developers.nutshell.com/reference/b1d85dde464bf9f894809bdafc72560e.md)
- [Delete a lead-competitor relationship](https://developers.nutshell.com/reference/851afdd2aef2a992349827409b2e6771.md)
- [Update a lead-competitor relationship](https://developers.nutshell.com/reference/ba720a5972ac5167437e05f71e3592d0.md)
- [Get a list of lead-competitor relationships](https://developers.nutshell.com/reference/e1accd46a9067a71fe5617536bda2103.md)
- [Get a lead's custom fields](https://developers.nutshell.com/reference/83433994d9721607dea58b99daf963ee.md): Get a list of custom fields that are applied to a lead.
- [Get applicable custom fields for leads](https://developers.nutshell.com/reference/653f973376f3b7ecfdf95585605ddc40.md): Get a list of custom fields that can be applied to leads.
- [Create a custom field](https://developers.nutshell.com/reference/91e474dc9fbb7fc3414b76130994d575.md): Creates a custom field to use for leads.
- [Get a lead](https://developers.nutshell.com/reference/8e55836889bb7d432d5fe3d9bfe608b7.md): Get a single lead by the ID provided.
- [Delete a lead.](https://developers.nutshell.com/reference/2ac175944b197a9c18dd9f6e9a53cb88.md): Delete a lead by the ID provided. Can be restored with the undelete endpoint.
- [Update a lead](https://developers.nutshell.com/reference/5a47a634e21ffbad6a5c268af67a63ae.md): Update a lead by id. <br><br> op is the operation to be performed, and path specifies what resource to patch. <br><br> Use the path leads/0/fieldName to update fields that are user-entered for this resource, i.e. name, description, etc. <br> <br> 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/- .  <br><br> 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. <br><br> 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.
- [Get list items for all leads](https://developers.nutshell.com/reference/3b3fb3c15cb2f6f9bd67ecae3cb0baa9.md): 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.
- [Get a list of leads](https://developers.nutshell.com/reference/132e65861bebcb3781c3d37e66aff309.md): Get a list of all leads and associated data in your Nutshell Instance.
- [Create a lead](https://developers.nutshell.com/reference/7d9961f8fbd457ba5670721926517135.md): Create a new lead. Only one lead can be created at a time.
- [Get reports for a lead](https://developers.nutshell.com/reference/c7d33a5a9825ea23ef5a75587cc4a9bd.md)
- [Get all stages associated with lead](https://developers.nutshell.com/reference/3cc07d39be52c9a287e147e138f88446.md): Get all stages associated with a lead by the ID provided, including information like amount of time spent in each stage.
- [Reopen a lead](https://developers.nutshell.com/reference/104d97bbcf04ea8a2ac72428fbdaa10b.md): Reopen a lead that was previously closed.
- [Update the status of a lead.](https://developers.nutshell.com/reference/74bb9b0e446b6a0a9913e5b8f8bca628.md): 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.
- [Set the pipeline for a lead](https://developers.nutshell.com/reference/ac69339d38f3809791db2340e47bff9b.md): Pipelines are also known as stagesets.
- [Watch a lead](https://developers.nutshell.com/reference/cb65d8c1aa9bba020e669ab84d846887.md): 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.
- [Undelete a lead](https://developers.nutshell.com/reference/3e509411f0439f11ffa52e726354b3b9.md)
- [Get a lead outcome by ID](https://developers.nutshell.com/reference/a02ff2477ba693ce337ed58c2f7cb2d4.md)
- [Get a list of lead outcomes](https://developers.nutshell.com/reference/023ebfb59f2c7fe37eb81dc618d24af0.md)
- [Get the fields for a lead](https://developers.nutshell.com/reference/1ef7499bb48d0b6d9aedccfeb6053b95.md): Get the list of fields that can possibly be associated with leads, along with whether they are valid for filtering sorting.
- [Get installments for a lead](https://developers.nutshell.com/reference/7c4277bf7ac3a1e50fb98c713565bc36.md): Returns the installment schedule for a lead. Requires lead installments on the account plan.
- [Update installments for a lead](https://developers.nutshell.com/reference/32aed6101ab1c412a24275e076aaba1f.md): 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.
- [Get a contact](https://developers.nutshell.com/reference/8a291bf9a1a7e4a7fd1ca0cabfdaa8a7.md): Returns a single contact based on the provided ID.
- [Delete a contact](https://developers.nutshell.com/reference/2b3d155b2889d34aa67235e67aa91d3f.md): Deletes a contact from Nutshell. Can be recovered by posting to /contacts/{id}/undelete
- [Update a contact](https://developers.nutshell.com/reference/cb995ae09d7e0e99e91b122bcc9358ed.md): Update a contact by id. <br><br> op is the operation to be performed, and path specifies what resource to patch. <br><br> Use the path contacts/0/fieldName to update fields that are user-entered for this resource, i.e. name, description, etc. <br> <br> 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/- .  <br><br> 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. <br><br> 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. <br><br> 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.
- [Get contact custom fields](https://developers.nutshell.com/reference/66abde512928a58ff9e3d7fac51a236e.md): Returns a list of custom fields for a contact.
- [Get applicable custom fields](https://developers.nutshell.com/reference/6f66fdf709475681e4e16528980ec105.md): Get a list of all custom fields that can be applied to any contact.
- [Create a custom field](https://developers.nutshell.com/reference/e156619e0c6caae9203e0c505a33bcad.md): Creates a custom field to use for contacts.
- [Get a list of contacts](https://developers.nutshell.com/reference/cde301caba6b033521a71e6bed772a58.md): Returns a number of contacts which is filterable based on their basic information.
- [Create a contact](https://developers.nutshell.com/reference/376a09558c05d3d4d273459f15a57326.md): Create a new contact, also known as a person, in Nutshell. Only one contact may be created at a time.
- [Undelete a contact](https://developers.nutshell.com/reference/c56447f926210f833c484e8ba7486e8c.md)
- [Get list items for all contacts](https://developers.nutshell.com/reference/7416ffd79a200377cb6276e02b1f5ddb.md): 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 the fields for a contact](https://developers.nutshell.com/reference/a2e78cb11ef577ef33e5c162da51ab51.md): Get the list of fields that can possibly be associated with contacts, along with whether they are valid for filtering sorting.
- [Get a list of editions](https://developers.nutshell.com/reference/4a302c8065d7f9015251d17f23bb237e.md)
- [Get a single edition by its ID](https://developers.nutshell.com/reference/7975bcc74536182c42a0ceca95dcbc35.md)
- [Get an email](https://developers.nutshell.com/reference/43ba2d674b5cc459bb8cdf42698d303f.md)
- [Get a list of events](https://developers.nutshell.com/reference/975fac2bed2a6a346717a88cfcdb9324.md): 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 deletion events](https://developers.nutshell.com/reference/eade9331abb11f33feaeb9e9d8ae89a7.md): Retrieve a feed of every time an entity was deleted.
- [Get saved filters](https://developers.nutshell.com/reference/9bbf17f9beb5e7eebe638a634e861945.md): Get saved filters
- [Get all forms](https://developers.nutshell.com/reference/b0fec1131366b61118593ec9e86a4c9e.md): Get all non-archived nutshell forms along with the IDs of the fields used in each form.
- [Get a form](https://developers.nutshell.com/reference/c150c11fa75e601f12a5d0c3291b7e9c.md): Get a single form by the ID provided. The fields used in the form are also returned in the response.
- [Get a form field](https://developers.nutshell.com/reference/8218d4f193a6ef911f41a9ffdfbd4eb4.md): Get a single form field by the ID provided.
- [Get a single industry by its ID](https://developers.nutshell.com/reference/3d6ab32d8162c8d9fd58cd0f40888de4.md)
- [Get an invoice](https://developers.nutshell.com/reference/b9c9d23692da5d58d025a29911416b8f.md): Get a single invoice by the ID provided.
- [Get a list of invoices](https://developers.nutshell.com/reference/44a63cb9277feafb979ccef9038cd6d5.md)
- [Update the status of an invoice](https://developers.nutshell.com/reference/d35e25a23af6446bdc10dffb07a59c79.md): 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.
- [Get a market by the ID](https://developers.nutshell.com/reference/1ea697bdc341c343978370e0465ec30a.md)
- [Get a list of markets](https://developers.nutshell.com/reference/9768a284fcd11af320b20036afca17d6.md)
- [Get a note](https://developers.nutshell.com/reference/7cda4297fad55a1bd186049667840325.md): Get a single note by the ID provided.
- [Delete a note.](https://developers.nutshell.com/reference/836127953fcc40da01ecc8c605bad12a.md): Delete a note by the ID provided. Can be restored with the undelete endpoint.
- [Undelete a note.](https://developers.nutshell.com/reference/56325ab1a38cdcc6bcbbdbe540a78907.md): Undelete a note by the ID provided.
- [Get a list of notes](https://developers.nutshell.com/reference/c855c6708aa8bb59e12dd00ac6afbd04.md): Get a list of notes.
- [Create a note](https://developers.nutshell.com/reference/d75ec624406914f4ac17a0cf1fc38d05.md)
- [Get a product](https://developers.nutshell.com/reference/e524bd8b37d52ef8fa586cadacfbbe63.md)
- [Delete a product](https://developers.nutshell.com/reference/1fb8ea517bd0df4cfe5fedda69e56084.md)
- [Undelete a product](https://developers.nutshell.com/reference/799d14014dfe97d25006bd23aa1955de.md)
- [List all products](https://developers.nutshell.com/reference/09a50065f621a61a55b5bc5c0df3f338.md)
- [Get lead product](https://developers.nutshell.com/reference/741f6e4eb5abcbdfc94754dd76257d9e.md): 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.
- [Update a lead's product information.](https://developers.nutshell.com/reference/427685c90f14ed7ca22515715a03b4e4.md): 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.
- [Delete a product on a lead](https://developers.nutshell.com/reference/7aa410de8a00f46edf22043fee324e39.md)
- [Get lead products](https://developers.nutshell.com/reference/4bc737ff6f91aab43dc7617f2c36ab3c.md): 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.
- [List all product categories](https://developers.nutshell.com/reference/717f48307abd255776158e66cbbe8656.md)
- [Create a product category](https://developers.nutshell.com/reference/6b6ddd29d78bb86bfa27c73614f601ff.md): Create a new product category. Product categories are used to organize products into groups.
- [Get a product category](https://developers.nutshell.com/reference/e35b57d17d5dad46410b632e6e4a539d.md)
- [Get a quote](https://developers.nutshell.com/reference/4c251930a518927960cce7d1211a0945.md): Get a single quote by the ID provided.
- [Get a list of quotes](https://developers.nutshell.com/reference/1aee48fe1472d38116c60c87e2ca4161.md)
- [Update the status of a quote](https://developers.nutshell.com/reference/9809f001604e5cbe8f478e14b6ec6295.md): 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.
- [Create an invoice from a quote](https://developers.nutshell.com/reference/8ce989ecb071d43420747aa852f155db.md): 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.
- [Delete a Source](https://developers.nutshell.com/reference/4d0d83bd963cdf17734d5dacc8fe4235.md): 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.
- [Undelete a Source](https://developers.nutshell.com/reference/80894cc152322d74d5a4115aca5297f9.md): Undelete a source by id.
- [Get a list of sources](https://developers.nutshell.com/reference/2d07cb07b45de2ae13701b873b26cf9e.md): Returns a list of all possible sources for leads in your Nutshell instance.
- [Create a new source](https://developers.nutshell.com/reference/cd431c40f2b57127c71b15044d270a13.md): 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.
- [Get a list of stages](https://developers.nutshell.com/reference/14af5dd687ab31f65e5af1a2b1fa5527.md)
- [Get a list of pipelines](https://developers.nutshell.com/reference/7e925de7233253ea915fdf486fb23321.md): Gets a list of pipelines that leads can be assigned to. Pipelines are also known as stagesets.
- [Get a CSV export of lead movements through a pipeline](https://developers.nutshell.com/reference/add7f9ef66629fa4ccee5dcc0479795b.md): Get a CSV export of lead movements through a pipeline
- [Delete a tag](https://developers.nutshell.com/reference/796b8e738949a2a0563da5032e29a12c.md): 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.
- [Get a list of tags](https://developers.nutshell.com/reference/422aa2c0d6493b41248e46c6ac93a43b.md): Get a list of all tags in a Nutshell instance.
- [Create a tag](https://developers.nutshell.com/reference/88c135d662e0a79e2a0c5fdf337ba537.md): Create a tag. Tags are used to organize leads, contacts, and accounts into groups.
- [Undelete a tag](https://developers.nutshell.com/reference/f09a0e050d70fe8d55b68a0ddddd3df0.md): Undelete a tag by id. Tags can be restored from the trash within 30 days of deletion.
- [Get a task](https://developers.nutshell.com/reference/04c249286f1032bdf6d8178e0e9f384c.md): Get a single task by the ID provided.
- [Delete a task.](https://developers.nutshell.com/reference/8df89ef1ffa672b94c860d2b6b77ee16.md): Delete a task by the ID provided.
- [Update a task](https://developers.nutshell.com/reference/fab5f8833c76cb64c8e82ec09416f467.md): Update a task by id. <br><br> op is the operation to be performed, and path specifies what resource to patch. <br><br> Use the path tasks/0/links/assignee to update the assigned user, using their ID.
- [Get a list of tasks](https://developers.nutshell.com/reference/2fe0bcdbe5941e2cfdc54a7c09b54200.md)
- [Create a new task](https://developers.nutshell.com/reference/6558005d25c656d862228999ac70bcc2.md)
- [Get a list of territories](https://developers.nutshell.com/reference/cf95ba52f86fef3511b456449ca9f9a9.md)
- [Get a list of users](https://developers.nutshell.com/reference/d3997a48c80629bf9a63637c4fde9aab.md)
- [Get a user](https://developers.nutshell.com/reference/69176b892afb5ae1c99520250d4bd331.md)