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 Contacts (People) API

The Contacts (People) API from Nutshell — 8 operation(s) for contacts (people).

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

Tagged areas include Contacts (People). 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.

This API exposes 11 operations across 8 paths, and defines 20 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.

11 operations 8 paths 20 schemas 1 DELETE6 GET1 PATCH3 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
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 11

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

Contacts (People) 11
GET
/contacts/{id}
Get a contact
8a291bf9a1a7e4a7fd1ca0cabfdaa8a7 1 param → 200
DELETE
/contacts/{id}
Delete a contact
2b3d155b2889d34aa67235e67aa91d3f 1 param → 204
PATCH
/contacts/{id}
Update a contact
cb995ae09d7e0e99e91b122bcc9358ed 1 param body → 204
GET
/contacts/{id}/customfields
Get contact custom fields
66abde512928a58ff9e3d7fac51a236e 1 param → 200
GET
/contacts/customfields/attributes
Get applicable custom fields
6f66fdf709475681e4e16528980ec105 → 200
POST
/contacts/customfield
Create a custom field
e156619e0c6caae9203e0c505a33bcad body → 200
GET
/contacts
Get a list of contacts
cde301caba6b033521a71e6bed772a58 6 params → 200
POST
/contacts
Create a contact
376a09558c05d3d4d273459f15a57326 body → 200
POST
/contacts/{id}/undelete
Undelete a contact
c56447f926210f833c484e8ba7486e8c 1 param → 200
GET
/contacts/list
Get list items for all contacts
7416ffd79a200377cb6276e02b1f5ddb 3 params → 200
GET
/contacts/list/fields
Get the fields for a contact
a2e78cb11ef577ef33e5c162da51ab51 → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Peep (9 properties), CustomFieldCreateInput (6 properties), meta (2 properties), HtmlLinkable (2 properties). Each schema is shown below with its type and property counts.

contactPostInput
object
The fields to be updated
1 property
FieldsResponse
object
Response object for entity fields endpoint
1 property
Peep
object
9 properties
phones
array
urls
array
addresses
array
All addresses associated with an entity.
CustomFieldInput
string
The key-value pair for the custom field.
1 property
emails
array
All email addresses associated with an entity.
FilterInput
string
The key-value pair for the filter, ex. filter[tags]=1-tags
ListItem
object
Avatarable
object
2 properties
CustomFieldCreateInput
object
6 properties
FullContact
An individual contact with all fields.
meta
object
Information about the Nutshell instance making the request
2 properties
CustomField
object
1 property
Contact
object
patchInput
array
ContactResponse
object
A full response object for a contact-related endpoint.
2 properties
HtmlLinkable
object
Adds an htmlUrl string attribute that represents a URL of an HTML representation of the response model.
2 properties
ListItemContact
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nutshell-contacts-people-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 Competitors API
Nutshell Editions API
Nutshell Emails API
Nutshell Forms API
Nutshell Industries API
Nutshell Invoices API
Nutshell Leads API
Nutshell Markets API
Where this information came from

This is an independent, third-party profile of Nutshell Contacts (People) 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.