ReferênciaAgenda
Listar visitas
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
25assignee_user_id?string
mine?boolean
Só as visitas do próprio usuário (exige um token pessoal)
status?string
Value in
- "agendada"
- "realizada"
- "cancelada"
- "nao_compareceu"
party_id?string
lead_id?string
deal_id?string
property_id?string
from?string
Agendadas a partir de (RFC 3339)
Format
date-timeto?string
Agendadas antes de (RFC 3339)
Format
date-timeResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/visits"{ "items": [ { "id": "vst_abc123", "party_id": "string", "lead_id": "string", "deal_id": "string", "property_id": "string", "listing_id": "string", "scheduled_at": "2019-08-24T14:15:22Z", "duration_minutes": 0, "ends_at": "2019-08-24T14:15:22Z", "reminder_minutes": 0, "assignee_user_id": "string", "status": "agendada", "notes": "string", "feedback": "string", "concluded_at": "2019-08-24T14:15:22Z", "contact_name": "string", "assignee_user_name": "string", "property_label": "string", "tenant_id": "string", "organization_id": "string", "created_by": "string", "created_by_type": "string", "updated_by": "string", "created_at": "2019-08-24T14:15:22Z", "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"}