developers API Documentation

We're working on updates to our API documentation. Check it out! It's currently in beta, you can switch back at any point.

October 31, 2018

An activity object now returns attributes of an associated model. For details check activities documentation.

September 21, 2018

We've added a is_sent_message flag to an activity response object.

May 9, 2018

Update Web-to-leads documentation to more accurately describe the usage of assign_to_id attribute.

March 6, 2018

From now on you can set company's image via API. See the documentation for companies and the image_thumb_url attribute.

February 23, 2018

Together with the new visibility model that was recently introduced, we are providing a new endpoint to manage your teams.

November 6, 2017

You can now control your revenue types through the new endpoint. For more details see the documentation.

October 17, 2017

The response object for deal will include a new currency attribute.

September 1, 2017

We've added a notification_ignore option to skip selected fields when sending notifications about created leads from a Web-to-leads form.

October 12, 2016

A new endpoint has been added for file (document) tags. Take a look here.

August 19, 2016

You can now create your leads with the LinkedIn URL from the Web-to-leads forms.

June 22, 2016

Documenting a time_zone attribute on a User object.

June 15, 2016

A whole new section about Automations and API calls was created.. Find more details here.

May 24, 2016

We've added three more custom field group endpoints for deals, people and companies.

February 24, 2016

The response object for each user returned from the /users endpoint will include the w2lid attributes. For details, see documentation.

February 23, 2016

You can now control whether an assignment email should be sent out when updating the owner_id of a company, via a deliver_reassignment_email flag.

September 17, 2015

A new endpoint has been added for Account Notifications

February 27, 2015

A new endpoint has been added for Todo Templates

February 24, 2015

Can now use the search_id parameter to retrieve results of saved searches for Notes.

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 files 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


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


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


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


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

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

Feb 3, 2012

People Tags

People tags are now available through the api.

Feb 1, 2012

Updating deals

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

Jan 31, 2012

Calendar Entries Destroy

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

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