Documentação

ReferênciaImóveis

Leads e negócios interessados no imóvel

GET
/properties/{id}/interested
X-API-Key<token>

Chave de API (prefixo nbr_) ou Token de Acesso Pessoal (prefixo pat_)

In: header

Path Parameters

id*string

Identificador único do imóvel

Query Parameters

limit?integer

Quantos resultados devolver, dos mais compatíveis.

Range1 <= value <= 50
Default20

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/properties/prp_abc123/interested"
{  "property": {    "property_id": "string",    "listing_id": "string",    "reference_code": "string",    "property_type": "apartment",    "development_name": "string",    "city": "string",    "district": "string",    "price": 0,    "bedrooms": 0,    "area": 0  },  "matches": [    {      "kind": "lead",      "lead_id": "string",      "deal_id": "string",      "party_id": "string",      "contact_name": "string",      "stage": "string",      "holder_user_id": "string",      "holder_user_name": "string",      "search_profile": {        "property_types": [          "apartment"        ],        "cities": [          "string"        ],        "districts": [          "string"        ],        "price_min": 0,        "price_max": 0,        "bedrooms_min": 0,        "area_min": 1,        "notes": "string"      },      "score": 0,      "reasons": [        {          "code": "district",          "label": "mesmo bairro (Batel)"        }      ],      "linked": true    }  ],  "note": "string"}
{  "type": "validation",  "title": "Validation Failed",  "status": 400,  "detail": "name is required",  "code": "validation.required",  "instance": "/public/v1/brokers",  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/validation",  "errors": [    {      "field": "name",      "message": "name is required",      "code": "validation.broker.name_required"    }  ]}
{  "type": "unauthorized",  "title": "Authentication Required",  "status": 401,  "detail": "authentication required",  "code": "unauthorized.auth_required",  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/unauthorized"}
{  "type": "forbidden",  "title": "Access Denied",  "status": 403,  "detail": "insufficient permissions",  "code": "forbidden.insufficient_permissions",  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/forbidden"}
{  "type": "not_found",  "title": "Resource Not Found",  "status": 404,  "detail": "broker not found",  "code": "not_found.broker",  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/not-found"}
{  "type": "rate_limit",  "title": "Rate Limit Exceeded",  "status": 429,  "detail": "rate limit exceeded",  "code": "rate_limit.exceeded",  "retry_after": 60,  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/rate-limit"}
{  "type": "internal",  "title": "Internal Server Error",  "status": 500,  "detail": "an unexpected error occurred",  "code": "internal.unexpected",  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/internal"}