Skip to main content
GET
Get a lead

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cid
string<uuid>
required
Example:

"a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60"

leadId
string<uuid>
required
Example:

"c9e5b1a3-7f24-4d80-a6b9-2e4f8c0d1a37"

Response

id
string<uuid>
required
Example:

"c9e5b1a3-7f24-4d80-a6b9-2e4f8c0d1a37"

email
string
required
tags
string[]
required
Example:
customFields
object
required
Example:
status
enum<string>
required
Available options:
not_contacted,
scheduled,
email_sent,
failed,
skipped,
lead_replied_interested,
lead_replied_meeting_request,
lead_replied_out_of_office,
lead_replied_bounce,
lead_replied_wrong_person,
lead_replied_not_interested,
lead_replied_unsubscribed,
lead_replied_uncategorized,
lead_converted,
lead_lost,
blacklisted
Example:

"not_contacted"

verification
object
required
metrics
object
required
createdAt
string<date-time>
required
firstName
string | null
Example:

"Jane"

lastName
string | null
Example:

"Doe"

companyName
string | null
Example:

"Acme Inc"

jobTitle
string | null
Example:

"VP Sales"

website
string | null
Example:

"https://acme.com"

linkedinProfile
string | null
Example:

"https://www.linkedin.com/in/janedoe"

location
string | null
Example:

"New York, US"

provider
string | null
Example:

"google"

sequenceProgress
object

Live sequence progress - included on the single-lead detail view.

lastContactedAt
string<date-time> | null
lastRepliedAt
string<date-time> | null