ReferênciaLeads
Listar leads
Authorization
apiKey X-API-Key<token>
Chave de API (prefixo nbr_) ou Token de Acesso Pessoal (prefixo pat_)
In: header
Query Parameters
cursor?string
Token opaco de cursor para paginação. Obtido via page_info.end_cursor da resposta anterior.
limit?integer
Número de itens por página.
Range
1 <= value <= 100Default
25stage?string
Value in
- "novo"
- "em_contato"
- "qualificado"
- "descartado"
source?string
Canal por onde o interesse chegou. Leads registrados pela API pública são sempre api. grupozap reúne os leads do ZAP Imóveis e do VivaReal; zap e vivareal aparecem só em leads anteriores à integração única do Grupo ZAP.
Value in
- "olx"
- "grupozap"
- "zap"
- "vivareal"
- "site_form"
- "whatsapp"
- "indicacao"
- "manual"
- "api"
- "assistant"
purpose?string
Value in
- "compra"
- "locacao"
assigned_user_id?string
unassigned?boolean
Só os leads sem responsável
held?boolean
Filtra pelos leads guardados acima do limite do plano
party_id?string
deal_id?string
created_after?string
Format
date-timecreated_before?string
Format
date-timeResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/leads"{ "items": [ { "id": "led_abc123", "party_id": "string", "source": "olx", "purpose": "compra", "source_reference": "string", "raw_payload": {}, "property_id": "string", "message": "string", "stage": "novo", "discard_reason": "string", "qualified_at": "2019-08-24T14:15:22Z", "discarded_at": "2019-08-24T14:15:22Z", "deal_id": "string", "assigned_user_id": "string", "assigned_at": "2019-08-24T14:15:22Z", "first_response_at": "2019-08-24T14:15:22Z", "sla_due_at": "2019-08-24T14:15:22Z", "held": true, "custom_fields": {}, "search_profile": { "property_types": [ "apartment" ], "cities": [ "string" ], "districts": [ "string" ], "price_min": 0, "price_max": 0, "bedrooms_min": 0, "area_min": 1, "notes": "string" }, "contact_name": "string", "contact_phone": "string", "assigned_user_name": "string", "tenant_id": "string", "organization_id": "string", "visibility": "restricted", "created_by": "string", "created_at": "2019-08-24T14:15:22Z", "updated_by": "string", "updated_at": "2019-08-24T14:15:22Z" } ], "page_info": { "end_cursor": "string", "start_cursor": "string", "has_next_page": true, "has_previous_page": true }}{ "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": "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"}