Leads

Get a lead

GET

/api/v1/leads/{leadId}

Path parameters

leadId

required

string · uuid

Lead id

Response

200Lead, identities, and enrollments.

lead

object

id

string · uuid

firstName

string | null

lastName

string | null

companyName

string | null

companyDomain

string | null

jobTitle

string | null

email

string | null

imageUrl

string | null

timezone

string

identities

object[]

liveEnrollment

object | null

campaignId

string · uuid

campaignName

string

status

"active" | "waiting" | "completed" | "stopped" | "failed"

createdAt

string · date-time

updatedAt

string · date-time

properties

object

enrollments

object[]

Errors

  • 400: Bad request
  • 401: Unauthorized: missing or invalid API key
  • 403: Forbidden
  • 404: Not found
  • 422: Invalid request payload

Search docs

Search documentation, API reference, and MCP tools

We use cookies to enhance your experience on Needle and keep your data secure. Privacy Policy