Ir al contenido

Get Lead

Ver como Markdown
GET
/public/v1/leads/{lead_id}
curl --request GET \
--url https://api.nuntius.chat/public/v1/leads/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'X-API-Key: <X-API-Key>'

Return a single lead owned by the tenant.

A foreign-tenant/unknown id is an indistinguishable 404 (aislamiento multi-tenant, CLAUDE.md raiz).


Permiso necesario: tenant:leads.read

lead_id
required
Lead Id
string format: uuid

Successful Response

Media typeapplication/json
PublicLeadOut

Lead shape returned by the public list/get/create/update endpoints.

Curated subset of the internal LeadOut (schemas/leads.py): drops originChannelId/originChannelName (MCH-7 internal attribution, meaningless to a third- party integration) and the legacy stage string mirror (stageId is the single canonical field on this NEW contract – no legacy bridge to preserve here, unlike the internal shape which still serves pre-KAN consumers).

object
id
required
Id
string
customerId
Any of:
string
conversationId
Any of:
string
customerName
required
Customername
string
customerEmail
Any of:
string
customerPhone
Any of:
string
intent
required
Intent
string
quality
required
Quality
string
stageId
required
Stageid
string
budget
Any of:
PublicLeadBudgetOut

Budget range in EUR.

Either bound may be null.

object
min
Any of:
integer
max
Any of:
integer
zones
required
Zones
Array<string>
rooms
Any of:
integer
assignedOperatorId
Any of:
string
source
required
Source
string
notes
Any of:
string
createdAt
required
Createdat
string
updatedAt
required
Updatedat
string

Examplegenerated

{
"id": "example",
"customerId": "example",
"conversationId": "example",
"customerName": "example",
"customerEmail": "example",
"customerPhone": "example",
"intent": "example",
"quality": "example",
"stageId": "example",
"budget": {
"min": 1,
"max": 1
},
"zones": [
"example"
],
"rooms": 1,
"assignedOperatorId": "example",
"source": "example",
"notes": "example",
"createdAt": "example",
"updatedAt": "example"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Examplegenerated

{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}