Skip to main content
GET
Get a lead

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Path Parameters

id
string
required

Lead public ID

Response

200 - application/json

OK

id
string
required

Lead public ID

number
string
required

Auto-generated lead number

name
string
required

Full name

archived
boolean
required

Whether the lead is archived

createdAt
string<date-time>
required

When the lead was created

title
string | null

Job title

email
string | null

Email address

mobile
string | null

Mobile phone number

secondaryMobile
string | null

Secondary mobile

website
string | null

Website URL

value
number | null

Expected value

sourceId
string | null

Lead source public ID

stageId
string | null

Lead stage public ID

customFields
object | null

Custom field values