BizKitHub
DocsAPI ReferenceLead/bff/lead/detail
getLeadAdmin BFF

/bff/lead/detail

Returns full lead detail including customer, assignee, linked order/issue, and geo info.

LeadgetBffLeadDetail

Parameters

1 query

Query parameters

· 1
leadIdstringRequired

Lead ID.

Exampleexample_leadId

Response schema

1 status code documented

200Success
idnumberRequired
status"new" | "contacted" | "qualified" | "proposal" | "negotiation" | "won" | "lost"Required

Lead pipeline status.

source"web_form" | "phone" | "email" | "referral" | "other"Required

How the lead was acquired.

subjectstringRequired
descriptionstringRequired
internalNotestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
estimatedValuenumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
followUpDateDate | string | string | number | nullRequired
One 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 | nullRequired
One 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 | nullRequired
One of 2:
Variant 1
string
Variant 2
null
insertedDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
updatedDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
customerobject | nullRequired
One of 2:
Variant 1
externalIdstringRequired
emailstring | nullRequired
One of 2:
Variant 1
string

Customer e-mail. null for phone-only customers and anonymised contacts.

Variant 2
null
namestringRequired
phonestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
companyNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
Variant 2
null
assignedMemberobject | nullRequired
One of 2:
Variant 1
idnumberRequired
namestringRequired
Variant 2
null
orderobject | nullRequired
One of 2:
Variant 1
idnumberRequired
orderNumberstringRequired
Variant 2
null
issueobject | nullRequired
One of 2:
Variant 1
idnumberRequired
issueKeystringRequired
Variant 2
null
geoobject | nullRequired
One of 2:
Variant 1
ipstringRequired

Accepted formats:

  • IPv4 dot-decimal, e.g. 1.1.1.1 (4 octets, 0–255, no leading zeros).
  • IPv6 as defined by RFC 4291 — full 2001:0db8:0000:0000:0000:0000:0000:0001, zero-compressed 2001:db8::1, IPv4-mapped ::ffff:1.2.3.4, or scoped literals. Both upper- and lower-case hex are accepted.

Server-side canonicalization (ipNormalize in core/src/lib/network/ipNormalize.ts):

  • Valid IPv4 is passed through verbatim.
  • Valid IPv6 is lowercased (RFC 5952 §4.3).
  • IPv4-mapped IPv6 ::ffff:X.X.X.X is unwrapped to plain IPv4 (RFC 4291 §2.5.5.2) so 1.2.3.4 and ::ffff:1.2.3.4 share one brj__geo_ip row.
  • Loopback aliases (::1, 0.0.0.0, localhost, empty string) collapse to 127.0.0.1.
  • Junk values that fail both IPv4 and IPv6 validation are silently rejected and replaced with 127.0.0.1 (loopback).

On the wire: every response returns the canonicalized form — clients can safely rely on lowercase IPv6 and the plain-IPv4 unwrap when de-duping or joining. Server-originated writers (activity log, session log, ban list) resolve the visitor IP via resolveClientIp / resolveClientIpOrNull — always native IPv6 on Vercel Edge (there is no auto-mapping to ::ffff:X.X.X.X).

Enrichment: the system resolves reverse DNS, geolocation, ASN, mobile/proxy/hosting/Tor flags via our VikiTron GEO/IP resolver for both address families. Learn more

Examples1.1.1.12001:4860:4860::8888
citystring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
countrystring | nullRequired
One 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

get
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.

Get API Key