Documentação

ReferênciaAgenda

Histórico de um contato, lead ou negócio

GET
/timeline
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.

Range1 <= value <= 100
Default25
party_id?string
lead_id?string
deal_id?string
types?string

Tipos de entrada a manter, separados por vírgula

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/timeline?types=note.created%2Ctask.created"
{  "items": [    {      "id": "string",      "type": "lead.created",      "occurred_at": "2019-08-24T14:15:22Z",      "actor_id": "string",      "actor_type": "string",      "refs": {        "party_id": "string",        "lead_id": "string",        "deal_id": "string",        "task_id": "string",        "visit_id": "string",        "note_id": "string",        "conversation_id": "string",        "intake_source_id": "string",        "proposal_id": "string",        "property_id": "string",        "assignment_id": "string",        "user_id": "string"      },      "data": {},      "held": true    }  ],  "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": "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"}