developers API Documentation

Example

Here's an example of creating a note in http request format:

curl -v -X POST \
  -H "Accept: application/json" \
  -d "note[content]=note all the things&note[deal_id]=237" \
  "https://api.pipelinedeals.com/api/v3/notes.json?api_key=abc1234"
      

And here's the same request being made in JSON format:

curl -v -X POST \
  -H "Accept: application/json"
  -H "Content-type: application/json" \
  -d '"note": { "content": "note all the things", "deal_id": 237 }' \
  "https://api.pipelinedeals.com/api/v3/notes.json?api_key=abc1234"
      

For both requests, the response comes back as:

{
  "created_by_user_id": 1,
  "company_id": 5,
  "title": null,
  "updated_at": "2012/05/25 11:36:37 -0400",
  "note_category": {
    "name": "Phone Call",
    "id": 1
  },
  "created_at": "2012/02/14 18:49:00 -0500",
  "deal_id": 2,
  "note_category_id": 1,
  "created_by_user": {
    "full_name": "admin nick",
    "id": 1
  },
  "person_id": 4,
  "id": 2,
  "content": "note test22"
}

    

Sample GET request

Here is an example of getting the contents of a deal.

GET /api/v3/deals/1234.json?api_key=abc1234

A breakdown of the request:

• The first parameter is the object we are interested in, always in plural form.
• Since we are simply GETting the deal details, we can just pass the deal ID.
• All requests must include the api_key of the user in the account who is making the request.