List all stages

GET  https://:account.api-us1.com/api/3/dealStages

• cURL

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

• Node

var request = require("request");

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

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/dealStages")

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/dealStages");

xhr.send(data);

• Python

import requests

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

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

print(response.text)

 

200 OK

{
  "dealStages": [
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": "2017-03-01T15:52:42-06:00",
      "color": "32B0FC",
      "dealOrder": "next-action DESC",
      "group": "4",
      "id": "15",
      "links": {
        "group": "/api/3/dealStages/15/group"
      },
      "order": "1",
      "title": "Initial Contact",
      "udate": "2017-03-01T15:52:42-06:00",
      "width": "280"
    },
    {
      "cardRegion1": "contact-orgname",
      "cardRegion2": "next-action",
      "cardRegion3": "hide-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": "2017-03-01T15:55:58-06:00",
      "color": "696969",
      "dealOrder": "title ASC",
      "group": "4",
      "id": "16",
      "links": {
        "group": "/api/3/dealStages/16/group"
      },
      "order": "1",
      "title": "Qualifications - Low",
      "udate": "2017-03-01T16:03:57-06:00",
      "width": "270"
    }
  ],
  "meta": {
    "total": "2"
  }
}

QUERY PARAMS

filters[title]

string                                          Filter by deal stages' titles. Any stages whose titles partial-match the filter value are returned

 

filters[d_groupid]

string                                          Filter by pipeline's id

 

orders[title]

string                                          Order by deal stage's title

 

To list all deal stages, the following permissions are required.

• Deal permission: the user should have permission to manage deals.
• Pipeline-specific permission: the user should have permission to manage the pipelines that the stages belong to. Stages that belong to pipelines that the user doesn't have permission to manage will not be returned in the response.