developers API Documentation

Thank you for your interest in the PipelineDeals API. The API was designed to cover the basic aspects of PipelineDeals objects and allow you to get started writing custom applications quickly.

The following example requires a PipelineDeals API key. If you already have an account and are an admin then go to the admin/api section of PipelineDeals.


Obligatory Hello World Example

# hello.rb
require 'json'
require 'rest_client'

KEY = "YOUR PIPELINE DEALS API KEY"

RestClient.get "https://api.pipelinedeals.com/api/v3/deals.json?api_key=#{KEY}" do |response|
  json = JSON.parse(response)
  deal = json['deals'].first
  puts "Hello '#{deal['name']}'"
end

Output

$ ruby hello.rb
Hello 'Kinda a big deal'

Required Ruby Gems