Get a deal
curl --request GET \
--url https://api.heffl.com/api/v2/deals/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.heffl.com/api/v2/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/v2/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/v2/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/v2/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/v2/deals/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v2/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>",
"number": "<string>",
"title": "<string>",
"contactEmails": [
"<string>"
],
"clientId": "<string>",
"client": {},
"price": 123,
"expectedCloseDate": "2023-11-07T05:31:56Z",
"status": "ACTIVE",
"priority": "LOW",
"pipelineId": "<string>",
"stageId": "<string>",
"stage": "<string>",
"leadId": "<string>",
"leadName": "<string>",
"crmSourceId": "<string>",
"source": "<string>",
"ownerUserId": "<string>",
"ownerId": "<string>",
"ownerName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Deals
Get a deal
Retrieves a single deal by its ID.
GET
/
deals
/
{id}
Get a deal
curl --request GET \
--url https://api.heffl.com/api/v2/deals/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.heffl.com/api/v2/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/v2/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/v2/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/v2/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/v2/deals/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v2/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>",
"number": "<string>",
"title": "<string>",
"contactEmails": [
"<string>"
],
"clientId": "<string>",
"client": {},
"price": 123,
"expectedCloseDate": "2023-11-07T05:31:56Z",
"status": "ACTIVE",
"priority": "LOW",
"pipelineId": "<string>",
"stageId": "<string>",
"stage": "<string>",
"leadId": "<string>",
"leadName": "<string>",
"crmSourceId": "<string>",
"source": "<string>",
"ownerUserId": "<string>",
"ownerId": "<string>",
"ownerName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
API key for authentication. Get yours at app.heffl.com/settings/developers
Path Parameters
Deal ID
Response
OK
Deal ID
Auto-generated deal number
Deal title
Emails of linked contacts
Contact or company ID (clt_ prefix)
Linked client record
Deal value
Expected close date
Deal status
Available options:
ACTIVE, WON, LOST Deal priority
Available options:
LOW, MEDIUM, HIGH Pipeline ID (dpl_ prefix)
Pipeline stage ID (dps_ prefix)
Pipeline stage name
Lead ID
Lead name
CRM source ID (src_ prefix)
CRM source name
Owner user ID (usr_ prefix)
Owner user ID (usr_ prefix)
Owner name
When the deal was created
When the deal was last updated
Custom field values as top-level cf_* keys (for example cf_priority). There is no customFields wrapper.