Nutshell

Nutshell Leads API

Sales opportunities: create, read, update, close, reopen, watch, stage and stageset assignment, installments, reports and lead custom fields. 25 operation(s) across 19 path(s).

GitHub OpenAPI
Business capability
Opportunity & Pipeline Management BC-410.30

Operations 25

GET /competitormaps/{id} Get a lead-competitor relationship #
DELETE /competitormaps/{id} Delete a lead-competitor relationship #
PATCH /competitormaps/{id} Update a lead-competitor relationship #
GET /competitormaps Get a list of lead-competitor relationships #
GET /leads/{id}/customfields Get a lead's custom fields #
GET /leads/customfields/attributes Get applicable custom fields for leads #
POST /leads/customfield Create a custom field #
GET /leads/{id} Get a lead #
DELETE /leads/{id} Delete a lead #
PATCH /leads/{id} Update a lead #
GET /leads/list Get list items for all leads #
GET /leads Get a list of leads #
POST /leads Create a lead #
GET /leads/report Get reports for a lead #
GET /leads/{id}/installments Get installments for a lead #
POST /leads/{id}/installments Update installments for a lead #
GET /leads/{id}/stages Get all stages associated with lead #
POST /leads/{id}/reopen Reopen a lead #
POST /leads/{id}/status Update the status of a lead #
POST /leads/{id}/stageset Set the pipeline for a lead #
POST /leads/{id}/watch Watch a lead #
POST /leads/{id}/undelete Undelete a lead #
GET /leads/list/fields Get the fields for a lead #
GET /outcomes/{id} Get a lead outcome by ID #
GET /outcomes Get a list of lead outcomes #

Documentation

📖
APIReference
https://developers.nutshell.com/reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nutshell/refs/heads/main/openapi/nutshell-leads-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/nutshell/refs/heads/main/overlays/nutshell-leads-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/nutshell-leads-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nutshell-leads-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Nutshell Leads API
  description: The most powerful API in the world
  version: 2.0.0
servers:
- url: app.nutshell.com/rest
tags:


# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nutshell/refs/heads/main/openapi/nutshell-leads-api-openapi.yml