Skip to main content
GET
/
leads
/
{id}
Get a lead
curl --request GET \
  --url https://api.heffl.com/api/v1/leads/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "number": "<string>",
  "name": "<string>",
  "archived": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "email": "[email protected]",
  "mobile": "<string>",
  "secondaryMobile": "<string>",
  "website": "<string>",
  "value": 123,
  "source": "<string>",
  "stage": "<string>",
  "customFields": "<unknown>"
}

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 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<email> | null

Email address

mobile
string | null

Mobile phone number

secondaryMobile
string | null

Secondary mobile

website
string | null

Website URL

value
number | null

Expected value

source
string | null

Lead source name

stage
string | null

Current stage label

customFields
any | null

Custom field values