Manage leads, contacts, and sales activity in Nutshell CRM via its REST API — list and create leads, contacts, and activities.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

Nutshell

Manage leads, contacts, and sales activity in Nutshell CRM directly from InTouch via the Nutshell REST API.

This tool reads and creates the core Nutshell sales objects: leads, contacts, and activities. It uses only the Python standard library (no third-party packages) and returns the raw Nutshell payload as a JSON string so downstream job steps can parse it.

What it does

Search and list leads, contacts, and activities (paged, sortable, free-text search).
Create a new lead, contact, or sales activity.

The Nutshell payload is returned in result (a JSON string) and the HTTP status in status.

Operations

operation	API call	Key inputs
`list_leads`	`GET /rest/leads`	`q`, `sort`, `limit`, `page`
`create_lead`	`POST /rest/leads`	`description` (required — sets lead name)
`list_contacts`	`GET /rest/contacts`	`q`, `sort`, `limit`, `page`
`create_contact`	`POST /rest/contacts`	`name` (required), `emailValue`, `phone`
`list_activities`	`GET /rest/activities`	`q`, `sort`, `limit`, `page`
`create_activity`	`POST /rest/activities`	`description` (required), `logNote`, `activityType`

List operations accept:

q — free-text search across the entity's related info.
sort — sort field; prefix with - for descending (e.g. -createdTime).
limit — page size, 1–100 (default 10).
page — zero-based page number (default 0).

API key setup

The Nutshell REST API authenticates with HTTP Basic auth:

Username = a Nutshell user's email address (email input).
Password = an API key (apiKey input).

To get an API key:

Sign in to Nutshell.
Go to Setup > API keys.
Create a key and copy it.

Provide both email (the user the key belongs to) and apiKey on every call. All requests go over HTTPS to https://app.nutshell.com/rest.

Examples

List the 5 most recently created leads:

{
  "apiKey": "your-nutshell-api-key",
  "email": "[email protected]",
  "operation": "list_leads",
  "sort": "-createdTime",
  "limit": "5"
}

Search contacts for "acme":

{
  "apiKey": "your-nutshell-api-key",
  "email": "[email protected]",
  "operation": "list_contacts",
  "q": "acme"
}

Create a contact with a primary email and phone:

{
  "apiKey": "your-nutshell-api-key",
  "email": "[email protected]",
  "operation": "create_contact",
  "name": "Jane Doe",
  "emailValue": "[email protected]",
  "phone": "+1-555-0100"
}

Create a lead:

{
  "apiKey": "your-nutshell-api-key",
  "email": "[email protected]",
  "operation": "create_lead",
  "description": "Acme Q3 expansion"
}

Output

{
  "result": "{\"leads\":[ ... ]}",
  "status": "200",
  "operation": "list_leads"
}

result — the Nutshell JSON response, as a string.
status — HTTP status code. 4xx/5xx responses are returned with their error body intact (the tool does not fail the step on an API error); only transport-level failures produce an error and fail the step.
truncated — present and "true" if the response body exceeded the 5 MB cap.

Notes

Grounded in the official Nutshell developer docs: https://developers.nutshell.com/
Standard library only (urllib, json, base64).
License: MIT.

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
operation
result
status
truncated

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: list_leads, create_lead, list_contacts, create_contact, list_activities, create_activity
`email`	string	no	—	Nutshell user email address (used as the HTTP Basic auth username). Required for every operation.
`q`	string	no	—	Free-text search query for list operations (searches related info on the entity).
`sort`	string	no	—	Sort field for list operations; prefix with '-' for descending (e.g. -createdTime).
`limit`	string	no	`10`	Page size for list operations (1-100).
`page`	string	no	`0`	Zero-based page number for list operations.
`description`	string	no	—	Lead description / name — used by create_lead. Activity description — used by create_activity.
`name`	string	no	—	Contact full name — used by create_contact.
`emailValue`	string	no	—	Contact email address — used by create_contact (added as a primary email).
`phone`	string	no	—	Contact phone number — used by create_contact (added as a primary phone).
`activityType`	string	no	—	Activity type id (links.activityType) — used by create_activity.
`logNote`	string	no	—	Activity log note text — used by create_activity.