# Nutshell REST API

**Canonical:** https://apis.io/apis/nutshell/rest-api/  
**Provider:** Nutshell — https://apis.io/providers/nutshell/  
**Base URL:** https://app.nutshell.com/rest  
**Documentation:** https://developers.nutshell.com/reference

Nutshell REST API is one of 27 APIs that [Nutshell](https://apis.io/providers/nutshell/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include CRM, Contacts, Leads, Account, and Pipelines. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a quickstart, and authentication docs.

Nutshell's primary REST API — 87 paths and 112 operations across 24 resource families (accounts, contacts, leads, activities, notes, tasks, products, quotes, invoices, pipelines, tags, users and more). Reads use conventional GET list/detail endpoints with a rich filter[] query grammar; writes to core entities use RFC 6902 JSON Patch (application/json-patch+json). Authentication is HTTP Basic with a Nutshell user email as the username and an account API key as the password.

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/nutshell/refs/heads/main/openapi/_original/nutshell-api.json
- **Documentation** — https://developers.nutshell.com/docs
- **APIReference** — https://developers.nutshell.com/reference
- **DeveloperPortal** — https://developers.nutshell.com
- **GettingStarted** — https://developers.nutshell.com/docs/getting-started
- **Quickstart** — https://developers.nutshell.com/docs/quickstart
- **Authentication** — https://developers.nutshell.com/docs/api-authentication
- **API Keys** — https://support.nutshell.com/en/articles/8429060-api-keys-create-api-keys-for-3rd-party-apps
- **Filters** — https://developers.nutshell.com/docs/filters
- **LLMsTxt** — https://raw.githubusercontent.com/api-evangelist/nutshell/refs/heads/main/llms/nutshell-llms.txt
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/nutshell/refs/heads/main/apis.yml

## Other Nutshell APIs (12)

- [Nutshell Legacy JSON-RPC API](https://apis.io/apis/nutshell/json-rpc/)
- [Nutshell GraphQL API](https://apis.io/apis/nutshell/graphql/)
- [Nutshell Accounts (Companies) API](https://apis.io/apis/nutshell/nutshell-accounts-api/)
- [Nutshell Activities API](https://apis.io/apis/nutshell/nutshell-activities-api/)
- [Nutshell Audiences API](https://apis.io/apis/nutshell/nutshell-audiences-api/)
- [Nutshell Competitors API](https://apis.io/apis/nutshell/nutshell-competitors-api/)
- [Nutshell Contacts (People) API](https://apis.io/apis/nutshell/nutshell-contacts-api/)
- [Nutshell Editions API](https://apis.io/apis/nutshell/nutshell-editions-api/)
- [Nutshell Emails API](https://apis.io/apis/nutshell/nutshell-emails-api/)
- [Nutshell Events (Timeline) API](https://apis.io/apis/nutshell/nutshell-events-api/)
- [Nutshell Filters API](https://apis.io/apis/nutshell/nutshell-filters-api/)
- [Nutshell Forms API](https://apis.io/apis/nutshell/nutshell-forms-api/)

## Tags

CRM, Contacts, Leads, Account, Pipelines, Sales

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/nutshell/rest-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/nutshell/.