Parameters
1 query
Query parameters
· 1leadIdstringRequiredLead ID.
Example
example_leadId/bff/lead/detail
Returns full lead detail including customer, assignee, linked order/issue, and geo info.
LeadgetBffLeadDetail
Response schema
1 status code documented
200Success
idnumberRequiredstatus"new" | "contacted" | "qualified" | "proposal" | "negotiation" | "won" | "lost"RequiredLead pipeline status.
source"web_form" | "phone" | "email" | "referral" | "other"RequiredHow the lead was acquired.
subjectstringRequireddescriptionstringRequiredinternalNotestring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
estimatedValuenumber | nullRequiredOne of 2:
Variant 1
number
Variant 2
null
followUpDateDate | string | string | number | nullRequiredOne of 2:
Variant 1
Date | string | string | number
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
Variant 2
null
closedDateDate | string | string | number | nullRequiredOne of 2:
Variant 1
Date | string | string | number
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
Variant 2
null
lostReasonstring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
insertedDateDate | string | string | numberRequiredOne of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
updatedDateDate | string | string | numberRequiredOne of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
customerobject | nullRequiredOne of 2:
Variant 1
externalIdstringRequiredemailstring | nullRequiredOne of 2:
Variant 1
string
Customer e-mail. null for phone-only customers and anonymised contacts.
Variant 2
null
namestringRequiredphonestring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
companyNamestring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
Variant 2
null
assignedMemberobject | nullRequiredOne of 2:
Variant 1
idnumberRequirednamestringRequiredVariant 2
null
orderobject | nullRequiredOne of 2:
Variant 1
idnumberRequiredorderNumberstringRequiredVariant 2
null
issueobject | nullRequiredOne of 2:
Variant 1
idnumberRequiredissueKeystringRequiredVariant 2
null
geoobject | nullRequiredOne of 2:
Variant 1
ipstringRequiredcitystring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
countrystring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
Variant 2
null
Response example
application/json{
"id": 0,
"subject": "example_subject",
"description": "example_description"
}Request example
GET /bff/lead/detail
curl -X GET "https://api.bizkithub.com/bff/lead/detail?leadId=example_leadId" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY"Need an API key?
All BizKitHub public API endpoints require authentication via API key.