curl --request GET \
--url https://api.journeybee.io/v1/partner/{partnershipId}/leads/{leadId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.journeybee.io/v1/partner/{partnershipId}/leads/{leadId}"
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}/leads/{leadId}', 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}/leads/{leadId}",
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}/leads/{leadId}"
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}/leads/{leadId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/partner/{partnershipId}/leads/{leadId}")
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>",
"source": "<string>",
"status": "new",
"company_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"direction": "sent",
"rejected_reason": "<string>",
"accepted_reason": "<string>",
"partnership_id": "<string>",
"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>"
}
],
"lead_deals": [
{
"id": "<string>",
"uuid": "<string>",
"label": "<string>",
"deal_value": 123,
"stage_id": "<string>",
"stage_label": "<string>",
"stage_series": 123,
"stage_phase": "new",
"currency_code": "<string>",
"created_at": "<string>",
"total_commission_value": 123,
"lead_deal_payments": [
{
"payment_completed": true,
"payment_value": 123
}
]
}
],
"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,
"status_form_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>"
}
],
"id": "<string>",
"lock_lead_status": true
}Get a partnership lead
curl --request GET \
--url https://api.journeybee.io/v1/partner/{partnershipId}/leads/{leadId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.journeybee.io/v1/partner/{partnershipId}/leads/{leadId}"
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}/leads/{leadId}', 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}/leads/{leadId}",
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}/leads/{leadId}"
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}/leads/{leadId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/partner/{partnershipId}/leads/{leadId}")
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>",
"source": "<string>",
"status": "new",
"company_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"direction": "sent",
"rejected_reason": "<string>",
"accepted_reason": "<string>",
"partnership_id": "<string>",
"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>"
}
],
"lead_deals": [
{
"id": "<string>",
"uuid": "<string>",
"label": "<string>",
"deal_value": 123,
"stage_id": "<string>",
"stage_label": "<string>",
"stage_series": 123,
"stage_phase": "new",
"currency_code": "<string>",
"created_at": "<string>",
"total_commission_value": 123,
"lead_deal_payments": [
{
"payment_completed": true,
"payment_value": 123
}
]
}
],
"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,
"status_form_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>"
}
],
"id": "<string>",
"lock_lead_status": true
}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
new, converted, rejected sent, received The Rejected form's reason: set only while the lead is rejected and the company shows it to partners, else null.
The Accepted form's reason: set only while the lead is converted (Accepted) and the company shows it to partners, else null.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Answers to the shared fields of the current status's form: lead_acceptance while converted (Accepted), lead_rejection while rejected, empty otherwise.
Show child attributes
Show child attributes
True when the calling partnership may not change this lead's status, rejected_reason or accepted_reason; updatePartnerLead returns 403 for such a change.