canonical: https://jentic.com/apis/nutshell.com/nutshell # Nutshell CRM API The Nutshell CRM API is a REST surface covering the core sales-CRM resources: accounts, leads, contacts, activities, notes, tasks, and tags. It supports full lifecycle operations on each - list, retrieve, create, patch, delete, and undelete - plus reference lookups for account types, industries, and territories. The 48-endpoint surface fits cleanly with workflows that capture inbound interest, advance deals through pipeline stages, and log outreach activity for sales reps. ## For AI agents Manage accounts, leads, contacts, activities, notes, tasks, and tags in Nutshell CRM with standard REST operations and basic auth. ## Scope Does not handle marketing email sends, billing, or e-commerce orders - use for sales CRM record management only. ## Capabilities - Create, update, and undelete accounts with industry and account-type classifications - Track leads through pipeline stages and patch their assigned owner or status - Log activities such as calls, meetings, and emails against contacts and accounts - Attach notes to leads or accounts to capture follow-up context - Create and complete tasks tied to a contact, lead, or account - Tag records to drive segmentation, reporting, and downstream automation ## Use cases ### Inbound Lead Capture Wire a website or chatbot form into Nutshell so every qualified inbound becomes a lead with the right contact, account, and tag attached. The API lets you create the contact, link or create the parent account, and post the lead in a single sequence - and patch the assigned rep based on territory rules. Setup is typically half a day with basic-auth credentials and the lead, contact, and account endpoints. Example prompt: Call POST /contacts to create the contact, POST /accounts if the company is new, then POST /leads linking both, with a tag of 'website-inbound'. ### Sales Activity Logging Keep CRM data clean by logging every call, meeting, and email automatically from a calendar, dialer, or inbox. The /activities endpoints accept structured records keyed to contacts, leads, or accounts, so a sales-ops automation can post activity without rep effort. This drives accurate forecast hygiene and unlocks coaching reports. Example prompt: Post a new activity of type 'call' to /activities, linking it to a contact id and including a 12-minute duration and a summary note. ### Pipeline Hygiene and Reporting Keep the deal pipeline tidy by patching stale leads, retiring duplicates, and tagging high-value accounts for executive review. The combination of list endpoints, patch operations, and tag management lets a nightly job re-stage and segment the pipeline without manual sales-ops effort. Undelete coverage means accidental removals can be reversed quickly. Example prompt: List leads with no activity in the last 30 days, patch their stage to 'on hold', and tag the parent account 'needs-revisit'. ### Agent-Driven CRM Updates Let an AI agent handle natural-language CRM updates such as 'add Acme Inc as a new account, owned by Priya, tagged enterprise' by chaining the account, contact, and tag endpoints behind a single intent. Through Jentic, the agent searches by intent and gets only the operations it needs, with credentials handled by the platform. Example prompt: Search Jentic for 'create a Nutshell lead', load the operation, and create a lead for Acme Inc with the tag 'enterprise'. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/accounts` | List all accounts | | POST | `/accounts` | Create an account | | PATCH | `/accounts/{id}` | Update an account | | POST | `/accounts/{id}/undelete` | Restore a deleted account | | GET | `/accounts/industries` | Get industry classifications | ## Key resources - **Accounts** — Companies - list, create, retrieve, update, delete, undelete; plus types and industries lookups. - **Leads** — Sales opportunities tracked through pipeline stages, with full CRUD and undelete. - **Contacts** — People associated with accounts and leads. - **Activities** — Calls, meetings, and other touches logged against records. - **Notes and Tasks** — Free-text notes and assignable tasks tied to records. - **Tags** — Labels applied to records for segmentation and reporting. ## Why Jentic - **Setup:** Wiring Nutshell CRM by hand means setting up HTTP basic auth with your email and API key against api.nutshell.com and handling the request plumbing yourself. Through Jentic you install once, import Nutshell from the API Directory, store the credentials once, and your agent calls it. - **Permission scoping:** Nutshell puts the record id in the URL path (`/accounts/{id}`), so a rule can pin your agent to the operations it needs on those accounts: it can read and create accounts while a destructive operation like patch or undelete is not included unless you add it. You choose the operations it may call. - **Credential handling:** Your Nutshell basic-auth credentials, the email plus API key, are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create a Nutshell lead' or 'update a Nutshell account', and Jentic returns the matching Nutshell operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Pipedrive API** — Pipeline-first sales CRM with broader integration ecosystem and equivalent deal-stage operations. - **Close CRM API** — Sales CRM aimed at high-velocity inside sales with built-in calling and email - competitor for sales-led teams. - **HubSpot CRM Contacts API** — Larger CRM platform with marketing, service, and CMS modules around the contact record. - **Mailchimp Marketing API** — Sync Nutshell contacts into Mailchimp audiences for nurture campaigns. ## FAQ ### What authentication does the Nutshell CRM API use? The API uses HTTP basic authentication: send your Nutshell login email and an API key as the username and password in the Authorization header. Through Jentic, the credentials live in the encrypted vault and are injected at execution time so the agent never sees them. ### Can I undelete records I removed by mistake? Yes - accounts, leads, contacts, activities, notes, and tasks each expose a POST /{resource}/{id}/undelete endpoint that restores the deleted record. This makes nightly cleanup automations safe to run. ### What are the rate limits for the Nutshell CRM API? The OpenAPI spec does not encode explicit limits. Nutshell's published policy throttles per-account; spread bursts of writes and back off on HTTP 429. ### How do I create a new lead in Nutshell through Jentic? Run pip install jentic, then search for 'create a Nutshell lead'. Jentic returns POST /leads with its input schema; supply the contact, account, and stage fields and execute. Run it through Jentic One, the self-hosted execution layer, to get an agent API key. ### Does the API expose deal stages and pipelines? Yes - leads carry a stage field that is patchable via PATCH `/leads/{id}`, and reference lookups for account types and industries are available at `/accounts/types` and `/accounts/industries.` ### Can I limit what my agent is allowed to do with the Nutshell CRM API? Yes. Because you run Jentic One yourself, your own rules decide exactly which Nutshell operations the agent may call and which stored credentials it may use. Since Nutshell keys records by id in the URL path, such as `/accounts/{id}`, you can let the agent read and create accounts, leads, and contacts while withholding destructive calls like PATCH `/accounts/{id}` or POST `/accounts/{id}/undelete` unless you explicitly add them. The agent only ever sees the operations you have scoped to it.