curl --request GET \
--url https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}', 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.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}",
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.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}"
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.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}")
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{
"uuid": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"label": "<string>",
"deal_value": 123,
"total_commission_value": 123,
"total_commission_occurrences": 123,
"lead_id": "<string>",
"created_by_user_id": "<string>",
"stage_id": "<string>",
"expiration_date": "<string>",
"expired_at": "<string>",
"currency_code": "<string>",
"stage": {
"id": "<string>",
"label": "<string>",
"series": 123,
"phase": "new"
},
"created_by_user_first_name": "<string>",
"created_by_user_last_name": "<string>",
"created_by_user_email": "<string>",
"created_by_user_profile_image_id": 123,
"created_by_user_profile_image_uuid": "<string>",
"lead_company_name": "<string>",
"lead_first_name": "<string>",
"lead_last_name": "<string>",
"lead_email": "<string>",
"lead_phone_number": "<string>",
"lead_direction": "sent",
"lead_status": "new",
"lead_campaign_id": "<string>",
"campaign_title": "<string>",
"partnership": {
"id": "<string>",
"uuid": "<string>",
"name": "<string>",
"partner_type": "referral",
"logo_square_id": 123,
"logo_square_uuid": "<string>",
"partnership_distributors_id": "<string>",
"distributor_name": "<string>",
"distributor_logo_square_id": 123,
"distributor_logo_square_uuid": "<string>"
},
"tags": [
{
"id": "<string>",
"label": "<string>",
"background_color": "<string>",
"text_color": "<string>"
}
],
"assigned_users": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"profile_image_id": 123,
"profile_image_uuid": "<string>"
}
],
"assigned_contacts": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"profile_image_id": 123,
"profile_image_uuid": "<string>"
}
],
"custom_fields": [
{
"id": "<string>",
"label": "<string>",
"type": "text",
"value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"options": [
{
"id": 123,
"label": "<string>"
}
],
"custom_field_value_id": "<string>"
}
],
"has_quote": true,
"has_products": true,
"has_live_calculators": true,
"partners": [
{
"uuid": "<string>",
"name": "<string>",
"partner_type": "referral",
"role": {
"uuid": "<string>",
"label": "<string>"
},
"is_primary": true
}
],
"id": "<string>",
"entry_commission_values": [
{
"stage_label": "<string>",
"commission_value": 0
}
],
"spiff_entry_commission_values": [
{
"stage_label": "<string>",
"commission_value": 0,
"recipient_type": "partnership",
"recipient_user_id": "<string>",
"recipient_contact_id": "<string>",
"recipient_name": "<string>"
}
],
"total_spiff_value": 0,
"commission_overrides": [
{
"stage_label": "<string>",
"amount": 4503599627370495,
"currency_code": "<string>",
"note": "<string>",
"document": {
"uuid": "<string>",
"file_url": "<string>",
"file_name": "<string>",
"mime_type": "<string>"
}
}
]
}Get a partnership deal
partners lists every partner on the deal: the primary partner first, then each supporting (co-sell) partner with its role. When the calling partnership is a supporting partner, every money field comes back null or empty (commission values, spiffs, overrides; has_quote is false), the lead is not reachable, and the primary partnership’s deal-stage lock binds it too (listPartnerDeals reports it as lock_deal_stage; updatePartnerDeal enforces it).
curl --request GET \
--url https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}', 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.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}",
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.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}"
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.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/partner/{partnershipId}/deals/{dealId}")
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{
"uuid": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"label": "<string>",
"deal_value": 123,
"total_commission_value": 123,
"total_commission_occurrences": 123,
"lead_id": "<string>",
"created_by_user_id": "<string>",
"stage_id": "<string>",
"expiration_date": "<string>",
"expired_at": "<string>",
"currency_code": "<string>",
"stage": {
"id": "<string>",
"label": "<string>",
"series": 123,
"phase": "new"
},
"created_by_user_first_name": "<string>",
"created_by_user_last_name": "<string>",
"created_by_user_email": "<string>",
"created_by_user_profile_image_id": 123,
"created_by_user_profile_image_uuid": "<string>",
"lead_company_name": "<string>",
"lead_first_name": "<string>",
"lead_last_name": "<string>",
"lead_email": "<string>",
"lead_phone_number": "<string>",
"lead_direction": "sent",
"lead_status": "new",
"lead_campaign_id": "<string>",
"campaign_title": "<string>",
"partnership": {
"id": "<string>",
"uuid": "<string>",
"name": "<string>",
"partner_type": "referral",
"logo_square_id": 123,
"logo_square_uuid": "<string>",
"partnership_distributors_id": "<string>",
"distributor_name": "<string>",
"distributor_logo_square_id": 123,
"distributor_logo_square_uuid": "<string>"
},
"tags": [
{
"id": "<string>",
"label": "<string>",
"background_color": "<string>",
"text_color": "<string>"
}
],
"assigned_users": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"profile_image_id": 123,
"profile_image_uuid": "<string>"
}
],
"assigned_contacts": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"profile_image_id": 123,
"profile_image_uuid": "<string>"
}
],
"custom_fields": [
{
"id": "<string>",
"label": "<string>",
"type": "text",
"value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"options": [
{
"id": 123,
"label": "<string>"
}
],
"custom_field_value_id": "<string>"
}
],
"has_quote": true,
"has_products": true,
"has_live_calculators": true,
"partners": [
{
"uuid": "<string>",
"name": "<string>",
"partner_type": "referral",
"role": {
"uuid": "<string>",
"label": "<string>"
},
"is_primary": true
}
],
"id": "<string>",
"entry_commission_values": [
{
"stage_label": "<string>",
"commission_value": 0
}
],
"spiff_entry_commission_values": [
{
"stage_label": "<string>",
"commission_value": 0,
"recipient_type": "partnership",
"recipient_user_id": "<string>",
"recipient_contact_id": "<string>",
"recipient_name": "<string>"
}
],
"total_spiff_value": 0,
"commission_overrides": [
{
"stage_label": "<string>",
"amount": 4503599627370495,
"currency_code": "<string>",
"note": "<string>",
"document": {
"uuid": "<string>",
"file_url": "<string>",
"file_name": "<string>",
"mime_type": "<string>"
}
}
]
}Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Path Parameters
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Response
Default Response
Show child attributes
Show child attributes
sent, received new, converted, rejected Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Partner contacts assigned to this deal. On a co-sell deal this includes the contacts of every partner on the deal, not only the calling partnership's.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Every partner on the deal. The primary partner (is_primary: true, the same partner as the deal's partner) comes first, then each supporting (co-sell) partner, oldest first, with its role. Supporting partners appear only while the Co-selling module is enabled, and only while they are active partners of the deal's partner type.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes