GET
/
leads
/
{leadId}

Authorizations

x-api-key
string
headerrequired

Path Parameters

leadId
string
required

The ID of the lead to fetch

Response

200 - application/json
firstName
string

The first name of the lead.

lastName
string

The last name of the lead.

phone
string

The phone number of the lead. This will be in the format +15555555555.

customerProfile
string

The name of the customer profile to which this lead belongs.

createdAt
string

The date and time when the lead was created.

additionalInfo
object

An optional key-value object containing additional information stored with the lead. This includes any context from when the lead was created, along with any variables that Apten has stored for the lead.

hasReplied
boolean

Indicates whether the lead has replied to any messages from Apten.

isHot
boolean

Indicates whether the lead is considered "hot" by Apten.

isQualified
boolean

Indicates whether the lead is considered "qualified" by Apten.

isUnsubscribed
boolean

Indicates whether the lead has unsubscribed from Apten.

isAiOn
boolean

Indicates whether Apten is turned on for the lead.

tags
object[]

An array of tags associated with the lead.

summary
string

A summary of the conversation with the lead.