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

Nutshell Competitors API

Competitor records and the lead-to-competitor relationships (competitor maps) attached to a lead. 6 operation(s) across 4 path(s).

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

Tagged areas include Competitors and Sales. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 6 operations across 4 paths, and defines 10 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.

6 operations 4 paths 10 schemas 1 DELETE4 GET1 PATCH

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
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 4 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Competitors 6
GET
/competitors/{id}
Get a competitor
c7625772e8320ae9d155b40b1974291b 1 param → 200
GET
/competitors
Get a list of competitors
3013cdcf2331b70ff8d2cebc7a4c3c81 1 param → 200
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

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are LeadCompetitorMap (5 properties), CompetitorResponse (4 properties), LeadCompetitorMapResponse (3 properties), createdTime (3 properties). Each schema is shown below with its type and property counts.

CompetitorResponse
object
A competitor response object
4 properties
createdTime
object
When the lead was created.
3 properties
LeadCompetitorMapResponse
object
3 properties
Avatarable
object
2 properties
Lead
object
Competitor
object
1 property
patchInput
array
HtmlLinkable
object
Adds an htmlUrl string attribute that represents a URL of an HTML representation of the response model.
2 properties
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nutshell-competitors-api-openapi.yml Raw ↑

Other APIs Nutshell publishes across the network.

Nutshell Legacy JSON-RPC API
Nutshell GraphQL API
Nutshell Activities API
Nutshell Audiences API
Nutshell Editions API
Nutshell Emails API
Nutshell Forms API
Nutshell Industries API
Nutshell Invoices API
Nutshell Leads API
Nutshell Markets API
Nutshell Notes API
Where this information came from

This is an independent, third-party profile of Nutshell Competitors 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.