Skip to main content
GET
Get lead

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Path Parameters

id
string<uuid>
required

Response

Lead

id
string<uuid>
phone_number
string
Example:

"+972501234567"

name
string | null
email
string<email> | null
source
string

How the lead was created: 'api', 'manual', or 'auto' (from inbound call).

Example:

"api"

tags
object[]
long_term_context
string | null

AI memory for this lead. Injected into the agent's system prompt at call time when lead_memory_enabled is true on the agent.

metadata
object
created_at
string<date-time>
updated_at
string<date-time>