Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Ruby wrapper for Nutshell CRM's API

branch: master
README.md

Nutshell CRM Build Status

Author: mshafrir@gmail.com

Description

Nutshell Crm is a Ruby wrapper for the Nutshell Crm API.

Nutshell API Reference

Reference

  • {NutshellCrm::Client}

Example Usage

require "nutshell-crm"

# Instantiate the Nutshell client.
nutshell = NutshellCrm::Client.new "user@example.com", "MY_API_KEY"

# Get the first open lead with stub data (default).
nutshell.find_leads({status: 0}).first
#=> {"stub"=>true, "id"=>1001, "entityType"=>"Leads", "name"=>"Lead\u20131001", "status"=>0, "primaryAccountName"=>nil}

# Enable non-stub responses.
nutshell.stub_responses = false

# Get the first open lead with full data.
nutshell.find_leads({status: 0}).first
#=> {"id"=>1001, "entityType"=>"Leads", "name"=>"Lead\u20131001", "status"=>0, "primaryAccountName"=>nil, "creator"=>{}}

Install

gem install nutshell-crm
Something went wrong with that request. Please try again.