List opportunity types

Use this to discover a valid type_uuid before creating an opportunity. Each item’s pinning_config declares whether a person/company association is required for that type. To get the matching stage_uuid, call GET /v1/opportunity-types//stages.

GET /v1/opportunity-types

List the opportunity types defined in the caller's tenant.

cURL

curl --request GET \
  --url https://production-api.joinrings.com/v1/opportunity-types \
  --header 'x-api-key: <api-key>'

import requests

url = "https://production-api.joinrings.com/v1/opportunity-types"

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', 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",
  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"

	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")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production-api.joinrings.com/v1/opportunity-types")

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

200

{
  "items": [
    {
      "uuid": "<string>",
      "description": "<string>",
      "is_hidden": true,
      "label": "<string>",
      "label_plural": "<string>",
      "pinning_config": {},
      "sub_label": "<string>",
      "sub_label_plural": "<string>",
      "subopportunities_enabled": true
    }
  ],
  "total": 123
}

Authorizations

x-api-key · string · header · required

Query Parameters

show_hidden · boolean · default: false

Include types hidden from the UI. Defaults to false so only user-selectable types are returned.

Response

200 - application/json

List of opportunity types in the caller's tenant.

items · OpportunityTypeListItem · object[] · required

Show child attributes

total · integer · required