Skip to main content
GET
Get lead

Authorizations

x-api-key
string
header
default:bd_live_your_key_here
required

Path Parameters

id
string
required

Response

id
string
required

The unique identifier of the lead

name
string
required

The name of the lead

Example:

"Jane Doe"

linkedinProfile
string
required

The LinkedIn profile URL of the lead

Example:

"https://www.linkedin.com/in/jane-doe"

hasReplied
boolean
required

Whether the lead has replied

hasUnreadReply
boolean
required

Whether the lead has an unread reply

isSkipped
boolean
required

Whether the lead was skipped

createdAt
string<date-time>
required

When the lead was created

updatedAt
string<date-time>
required

When the lead was last updated

events
object[]
required

Chronological event history for the lead

company
string | null

The lead's company

job
string | null

The lead's job title

campaignId
string | null

The campaign this lead belongs to, if any

listId
string | null

The list this lead belongs to, if any

campaignStatus
string | null

The lead's status within its campaign

skippedReason
string | null

Why the lead was skipped, if applicable

location
string | null

The lead's location

lastMessage
string | null

The most recent message in the conversation

statusNote
string | null

A free-text status note

customField1
string | null
customField2
string | null
customField3
string | null
customAttributes
object | null

Custom key-value attributes supplied when the lead was added

invitedAt
string<date-time> | null

When the invite was sent

connectedAt
string<date-time> | null

When the lead connected

repliedAt
string<date-time> | null

When the lead replied

withdrawnAt
string<date-time> | null

When the invitation was withdrawn