Get the renewal settings
curl --request GET \
--url https://api.statisfy.com/v1/settings/renewals \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.statisfy.com/v1/settings/renewals"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.statisfy.com/v1/settings/renewals', 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://api.statisfy.com/v1/settings/renewals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.statisfy.com/v1/settings/renewals"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.statisfy.com/v1/settings/renewals")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/settings/renewals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"amount_field": "renewal_arr",
"forecast": {
"enabled": true,
"hold_days": 30,
"instructions": "Treat multi-year deals as one.",
"window_days": 90
},
"risks": [
{
"built_in": true,
"definition": "the main internal advocate has left or changed role",
"name": "Champion left"
},
{
"built_in": false,
"definition": "the customer announced a spending freeze",
"name": "Budget freeze"
}
],
"segment": {
"and": [
{
"field": "type",
"object": "opportunity",
"op": "eq",
"value": "Renewal"
}
]
}
}settings
Get the renewal settings
Which opportunities are renewals, the field that holds their amount, how the renewal forecast runs and the risks it looks for. Forecast settings and risks exist once renewal forecasting is first switched on. Read only: change them in the app.
GET
/
v1
/
settings
/
renewals
Get the renewal settings
curl --request GET \
--url https://api.statisfy.com/v1/settings/renewals \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.statisfy.com/v1/settings/renewals"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.statisfy.com/v1/settings/renewals', 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://api.statisfy.com/v1/settings/renewals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.statisfy.com/v1/settings/renewals"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.statisfy.com/v1/settings/renewals")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/settings/renewals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"amount_field": "renewal_arr",
"forecast": {
"enabled": true,
"hold_days": 30,
"instructions": "Treat multi-year deals as one.",
"window_days": 90
},
"risks": [
{
"built_in": true,
"definition": "the main internal advocate has left or changed role",
"name": "Champion left"
},
{
"built_in": false,
"definition": "the customer announced a spending freeze",
"name": "Budget freeze"
}
],
"segment": {
"and": [
{
"field": "type",
"object": "opportunity",
"op": "eq",
"value": "Renewal"
}
]
}
}Authorizations
An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.
Response
200 - application/json
Successful Response
Was this page helpful?