List the stages of an opportunity type in the caller's tenant.
curl --request GET \
--url https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages \
--header 'x-api-key: <api-key>'import requests
url = "https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"uuid": "<string>",
"color": "<string>",
"is_hidden": true,
"name": "<string>",
"percentage": 123,
"stage_type": "<string>",
"type_uuid": "<string>"
}
],
"total": 123
}Opportunity
List opportunity stages
Use this to discover a valid stage_uuid before creating an opportunity.
Pass stage_type=PARENT (default) for top-level opportunities or
stage_type=CHILD for sub-opportunities. A stage is only valid when paired
with the type_uuid it belongs to.
GET
/
v1
/
opportunity-types
/
{type_uuid}
/
stages
List the stages of an opportunity type in the caller's tenant.
curl --request GET \
--url https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages \
--header 'x-api-key: <api-key>'import requests
url = "https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/opportunity-types/{type_uuid}/stages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"uuid": "<string>",
"color": "<string>",
"is_hidden": true,
"name": "<string>",
"percentage": 123,
"stage_type": "<string>",
"type_uuid": "<string>"
}
],
"total": 123
}Authorizations
Path Parameters
Query Parameters
Which stage set to return: 'PARENT' for top-level opportunity stages, 'CHILD' for sub-opportunity stages. Defaults to 'PARENT'.
Available options:
PARENT, CHILD Include stages hidden from the UI. Defaults to false so only user-selectable stages are returned.