developers API Documentation

October 16, 2014

The source object is now returned for deals. The object includes the ID and name of the source.

January 24, 2014

We're pleased to announce we have full documents support via our api. See the full documentation for our documents api.

November 7, 2013

Profile Added

A new endpoint has been added for Profile.

GET /api/v3/profile.json

October 10, 2013

Users Added

A new endpoint has been added for Users.

GET /api/v3/users.json

June 3, 2013

Searches Added

A new endpoint has been added for Searches.

GET /api/v3/searches.json

May 30, 2013

Users Endpoint Added

A new endpoint has been added for Users.

GET /api/v3/users/1234.json

See the documentation for response details.

May 24, 2013

Comments Added

A new endpoint has been added for Comments.

GET /api/v3/notes/1234/comments.json

Collaborators Added

The list of collaborators is now returned for deals. These include users shared on the deal.

Notifications Added

Added 'possible_notify_user_ids' to companies, deals, and people. This lists the user_ids that can be listed as 'notify_user_ids' when creating or updating notes.

Reading a note will also return 'possible_notify_user_ids' in case you want to change notifications before adding a comment.

See the documentation for all details.

February 14, 2013

API Rate Limit Revised

Previously, you could make 1 API call in 1 second, and then you had to "sleep" before another one. Now, you can make up to 10 calls back-to-back (with no "sleep") within a 5 second period.

August 7, 2012

Api Updates

Sub-collections are now accessible via /collection/id/subcollections.json

Deals

Get notes associated to a deal: GET /api/v3/deals/1234/notes.json

Get people associated to a deal: GET /api/v3/deals/1234/people.json

People

Get deals associated to a person: GET /api/v3/people/1234/deals.json

Get notes associated to a person: GET /api/v3/people/1234/notes.json

Companies

Get deals associated to a company: GET /api/v3/companies/1234/deals.json

Get people associated to a company: GET /api/v3/companies/1234/people.json

Get notes associated to a company: GET /api/v3/companies/1234/notes.json

June 12, 2012

API V3

PipelineDeals is excited to announce V3 of our API, which comes with a host of new changes.

  1. New interfaces for all the major objects, Deals, Companies, People
  2. New admin interface to get JSON for all admin related objects, (users, lead sources, statuses, note categories, etc)
  3. Enhanced interface for custom fields, and the ability to edit custom fields on all entities that support custom fields.

Feb 7, 2012

Add associate deals and people

enhancement
Added documentation about associating people to deals.
addition
Added examples section and an example of associating people to deals.

Feb 3, 2012

People Tags

enhancement
People tags are now available through the api.

Feb 1, 2012

Updating deals

clarification
The documentation around updating deal's custom values has be clarified.

Jan 31, 2012

Calendar Entries Destroy

enhancement
Destroying a calendar entry will now return an array of calender entry ids. These ids are the recurring events that were destroyed and the base entry.

Jan 30, 2012

Deal custom fields

bug fix
deal custom fields will be returned by default for listing and showing actions.

Jan 26, 2012

Deal show

bug fix
deals show action should return the correct json described in the documents now

Jan 25, 2012

Deal attributes

company
A company object is now returned by default.
deal_stage_id
The deal's deal_stage_id is now returned by default.
deal_value
The deal's value in terms of account currency
next_entry
The deals next calendar entry is now returned by default

Built by sales people, for sales people.

Try PipelineDeals FREE for 14 days

No credit card required.

By clicking you agree to our terms & conditions and privacy policy.