How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
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).

Documentation Provider Profile APIs.io OpenAPI GitHub

Nutshell Leads API is one of 26 APIs that Nutshell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Leads, Opportunities, and Pipeline Management. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 25 operations across 19 paths, and defines 30 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://app.nutshell.com/rest.

25 operations 19 paths 30 schemas 2 DELETE13 GET2 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://app.nutshell.com/rest
Authentication
HTTP Basic
Contact
Nutshell Developers
Resource Areas
1

Authentication & Security 1

Nutshell Leads API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth).

Paths & Operations 25

Across 19 paths, the API surfaces 25 operations — 2 DELETE, 13 GET, 2 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Leads 25
GET
/competitormaps/{id}
Get a lead-competitor relationship
b1d85dde464bf9f894809bdafc72560e 1 param → 200
DELETE
/competitormaps/{id}
Delete a lead-competitor relationship
851afdd2aef2a992349827409b2e6771 1 param → 204
PATCH
/competitormaps/{id}
Update a lead-competitor relationship
ba720a5972ac5167437e05f71e3592d0 1 param body → 204
GET
/competitormaps
Get a list of lead-competitor relationships
e1accd46a9067a71fe5617536bda2103 → 200
GET
/leads/{id}/customfields
Get a lead's custom fields
83433994d9721607dea58b99daf963ee 1 param → 200
GET
/leads/customfields/attributes
Get applicable custom fields for leads
653f973376f3b7ecfdf95585605ddc40 → 200
POST
/leads/customfield
Create a custom field
91e474dc9fbb7fc3414b76130994d575 body → 200
GET
/leads/{id}
Get a lead
8e55836889bb7d432d5fe3d9bfe608b7 1 param → 200
DELETE
/leads/{id}
Delete a lead.
2ac175944b197a9c18dd9f6e9a53cb88 1 param → 200
PATCH
/leads/{id}
Update a lead
5a47a634e21ffbad6a5c268af67a63ae 1 param body → 204400
GET
/leads/list
Get list items for all leads
3b3fb3c15cb2f6f9bd67ecae3cb0baa9 3 params → 200
GET
/leads
Get a list of leads
132e65861bebcb3781c3d37e66aff309 5 params → 200
POST
/leads
Create a lead
7d9961f8fbd457ba5670721926517135 body → 201
GET
/leads/report
Get reports for a lead
c7d33a5a9825ea23ef5a75587cc4a9bd 10 params → 200400
GET
/leads/{id}/installments
Get installments for a lead
7c4277bf7ac3a1e50fb98c713565bc36 1 param → 200
POST
/leads/{id}/installments
Update installments for a lead
32aed6101ab1c412a24275e076aaba1f 1 param body → 200
GET
/leads/{id}/stages
Get all stages associated with lead
3cc07d39be52c9a287e147e138f88446 1 param → 200
POST
/leads/{id}/reopen
Reopen a lead
104d97bbcf04ea8a2ac72428fbdaa10b 1 param → 200
POST
/leads/{id}/status
Update the status of a lead.
74bb9b0e446b6a0a9913e5b8f8bca628 1 param body → 200
POST
/leads/{id}/stageset
Set the pipeline for a lead
ac69339d38f3809791db2340e47bff9b 1 param body → 200
POST
/leads/{id}/watch
Watch a lead
cb65d8c1aa9bba020e669ab84d846887 1 param → 200
POST
/leads/{id}/undelete
Undelete a lead
3e509411f0439f11ffa52e726354b3b9 1 param → 200
GET
/leads/list/fields
Get the fields for a lead
1ef7499bb48d0b6d9aedccfeb6053b95 → 200
GET
/outcomes/{id}
Get a lead outcome by ID
a02ff2477ba693ce337ed58c2f7cb2d4 1 param → 200
GET
/outcomes
Get a list of lead outcomes
023ebfb59f2c7fe37eb81dc618d24af0 → 200

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Stage (11 properties), LeadProductMap (8 properties), ReportBucket (7 properties), LeadInstallment (6 properties). Each schema is shown below with its type and property counts.

createdTime
object
When the lead was created.
3 properties
Stage
object
11 properties
FieldsResponse
object
Response object for entity fields endpoint
1 property
LeadOutcome
object
4 properties
dueTime
object
When the lead is due.
3 properties
Stageset
object
5 properties
LeadInstallmentValue
object
2 properties
CustomFieldInput
string
The key-value pair for the custom field.
1 property
LeadInstallment
object
6 properties
FilterInput
string
The key-value pair for the filter, ex. filter[tags]=1-tags
Avatarable
object
2 properties
ListItem
object
Competitor
object
1 property
Lead
object
LeadCompetitorMap
object
A competitor relationship on a lead represents an entity that you may be competing with for this lead
5 properties
value
object
3 properties
CustomFieldCreateInput
object
6 properties
LeadProductMap
object
8 properties
meta
object
Information about the Nutshell instance making the request
2 properties
FullLead
A fully-fleshed lead.
ReportCount
object
Count of the report
4 properties
LeadResponse
object
A full response object for a lead-related endpoint.
3 properties
NutReportOnDemandReport
object
6 properties
ListItemLead
Class ListItemLead
CustomField
object
1 property
LeadCompetitorMapResponse
object
3 properties
patchInput
array
FullCustomField
object
HtmlLinkable
object
Adds an htmlUrl string attribute that represents a URL of an HTML representation of the response model.
2 properties
ReportBucket
object
Bucket of the report
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nutshell-leads-api-openapi.yml Raw ↑

Other APIs Nutshell publishes across the network.

Nutshell Legacy JSON-RPC API
AE Profile APIs.io
Nutshell GraphQL API
AE Profile APIs.io
Nutshell Activities API
AE Profile APIs.io
Nutshell Audiences API
AE Profile APIs.io
Nutshell Competitors API
AE Profile APIs.io
Nutshell Editions API
AE Profile APIs.io
Nutshell Emails API
AE Profile APIs.io
Nutshell Forms API
AE Profile APIs.io
Nutshell Industries API
AE Profile APIs.io
Nutshell Invoices API
AE Profile APIs.io
Nutshell Markets API
AE Profile APIs.io
Nutshell Notes API
AE Profile APIs.io
#Leads#Opportunities#Pipeline Management
← Back to N APIs
API Details
ID
nutshell:nutshell-leads-api
Base URL
https://app.nutshell.com/rest
Docs
https://developers.nutshell.com/reference
Provider
Nutshell
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=nutshell-leads-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/nutshell-leads-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Nutshell Leads API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.