Retrieve a pipeline

GET  https://:account.api-us1.com/api/3/pipelines/id

• cURL

curl --request GET \
  --url https:///:account.api-us1.com/api/3/pipelines/id

• Node

var request = require("request");

var options = { method: 'GET',
  url: 'https:///:account.api-us1.com/api/3/pipelines/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

• Ruby

require 'uri'
require 'net/http'

url = URI("https:///:account.api-us1.com/api/3/pipelines/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

• JavaScript

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https:///:account.api-us1.com/api/3/pipelines/id");

xhr.send(data);

• Python

import requests

url = "https:///:account.api-us1.com/api/3/pipelines/id"

response = requests.request("GET", url)

print(response.text)

 

200 OK

{
  "dealGroup": {
    "allgroups": "1",
    "allusers": "0",
    "autoassign": "1",
    "cdate": "2017-03-30T12:11:30-05:00",
    "currency": "eur",
    "id": "4",
    "links": {
      "dealGroupGroups": "/api/3/dealGroups/4/dealGroupGroups",
      "dealGroupUsers": "/api/3/dealGroups/4/dealGroupUsers",
      "stages": "/api/3/dealGroups/4/stages"
    },
    "stages": [
      "9",
      "10",
      "11"
    ],
    "title": "Qualifications",
    "udate": "2017-03-30T13:44:32-05:00"
  },
  "dealStages": [
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "18D499",
      "dealOrder": "next-action DESC",
      "group": "4",
      "id": "9",
      "links": {
        "group": "/api/3/dealStages/9/group"
      },
      "order": "1",
      "title": "To Contact",
      "udate": null,
      "width": "280"
    },
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "32B0FC",
      "dealOrder": "next-action DESC",
      "group": "4",
      "id": "10",
      "links": {
        "group": "/api/3/dealStages/10/group"
      },
      "order": "2",
      "title": "In Contact",
      "udate": null,
      "width": "280"
    },
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "E6CE4B",
      "dealOrder": "next-action DESC",
      "group": "4",
      "id": "11",
      "links": {
        "group": "/api/3/dealStages/11/group"
      },
      "order": "3",
      "title": "Follow Up",
      "udate": null,
      "width": "280"
    }
  ]
}

PATH PARAMS

id                                     REQUIRED

string                               Pipeline's id

 

By default, deal stages for the pipeline are also returned in the response.