InTouch Hub · Blue Isle Software

Nutshell

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

nutshellcrmleadssales

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

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:

API key setup

The Nutshell REST API authenticates with HTTP Basic auth:

To get an API key:

  1. Sign in to Nutshell.
  2. Go to Setup > API keys.
  3. 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"
}

Notes