Skip to main content
GET
/
leads
/
{id}
Get lead
curl --request GET \
  --url https://api.goyappr.com/leads/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone_number": "+972501234567",
  "name": "<string>",
  "email": "jsmith@example.com",
  "source": "api",
  "tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "color": "<string>",
      "sort_order": 123,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "long_term_context": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.goyappr.com/llms.txt

Use this file to discover all available pages before exploring further.

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>