Get a deal
curl --request GET \
--url https://api.heffl.com/api/v1/deals/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.heffl.com/api/v1/deals/{id}"
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://api.heffl.com/api/v1/deals/{id}', 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.heffl.com/api/v1/deals/{id}",
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://api.heffl.com/api/v1/deals/{id}"
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://api.heffl.com/api/v1/deals/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v1/deals/{id}")
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{
"id": "<string>",
"title": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"number": "<string>",
"price": 123,
"status": "<string>",
"priority": "<string>",
"expectedCloseDate": "2023-11-07T05:31:56Z",
"clientId": "<string>",
"pipelineId": "<string>",
"stageId": "<string>",
"sourceId": "<string>",
"leadId": "<string>",
"customFields": {}
}Deals
Get a deal
Returns a single deal by its public ID.
GET
/
deals
/
{id}
Get a deal
curl --request GET \
--url https://api.heffl.com/api/v1/deals/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.heffl.com/api/v1/deals/{id}"
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://api.heffl.com/api/v1/deals/{id}', 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.heffl.com/api/v1/deals/{id}",
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://api.heffl.com/api/v1/deals/{id}"
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://api.heffl.com/api/v1/deals/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v1/deals/{id}")
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{
"id": "<string>",
"title": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"number": "<string>",
"price": 123,
"status": "<string>",
"priority": "<string>",
"expectedCloseDate": "2023-11-07T05:31:56Z",
"clientId": "<string>",
"pipelineId": "<string>",
"stageId": "<string>",
"sourceId": "<string>",
"leadId": "<string>",
"customFields": {}
}Authorizations
API key for authentication. Get yours at app.heffl.com/settings/developers
Path Parameters
Deal public ID
Response
200 - application/json
OK
Deal public ID
Deal title
When the deal was created
Auto-generated deal number
Deal price/value
Deal status
Deal priority
Expected close date
Client public ID
Pipeline public ID
Pipeline stage public ID
Deal source public ID
Lead public ID
Custom field values
Show child attributes
Show child attributes