1. Leads
Veploy API
  • Visão geral
  • Autenticação
  • Limites de requisição
  • Imóveis
    • Listar imóveis
    • Consultar imóvel
    • Cadastrar imóvel
    • Alterar imóvel
    • Excluir imóvel
    • Restaurar imóvel
    • Enviar foto do imóvel (Beta)
    • Remover foto do imóvel (Beta)
    • Listar tipos de imóvel
  • Proprietários
    • Listar proprietários
    • Consultar proprietário
    • Cadastrar proprietário
    • Alterar proprietário
    • Excluir proprietário
  • Leads
    • Listar leads
      GET
    • Consultar lead
      GET
    • Criar lead
      POST
    • Alterar responsável
      POST
    • Atualizar lead
      PATCH
    • Consultar linha do tempo do lead
      GET
  • Visitas
    • Listar visitas
    • Consultar visita
    • Agendar visita
    • Alterar visita
  • Propostas
    • Listar propostas
    • Consultar proposta
    • Registrar proposta
    • Alterar proposta
  • Portais
    • Listar portais
    • Consultar portal
    • Listar imóveis do XML
  • Usuários
    • Listar usuários
    • Consultar usuário
    • Consultar permissões do usuário
    • Convidar usuário
    • Alterar ficha do usuário
    • Desativar usuário
    • Reativar usuário
    • Remover usuário
  • Perfis de acesso
    • Listar perfis de acesso
  • Artigos
    • Listar artigos
    • Criar artigo
    • Consultar artigo
    • Alterar artigo
    • Enviar capa do artigo (Beta)
  • Temas
    • Tema do site
  1. Leads

Consultar linha do tempo do lead

GET
/v1/leads/{id}/timeline
Acontecimentos e comentários do lead, em ordem cronológica. Aceita o id ou o number do lead. Cada acontecimento traz action, trigger (quem ou o que o causou), os detalhes estruturados em data, o valor anterior em old nas transições e um texto para exibição em label. Filtre por type, action, actor_id, created_after e created_before. Para sincronizar de forma incremental, use created_after com order=asc.

Requisição

Authorization
Bearer Token
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
or
Parâmetros de Caminho

Parâmetros de Consulta

Respostas

🟢200
application/json
Default Response
Bodyapplication/json

🟠400
🟠401
🟠403
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.veploy.com/v1/leads//timeline?page=undefined&per_page=undefined&order=undefined&type=event&action=stage_changed&actor_id=undefined&created_after=undefined&created_before=undefined' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Exemplo 1
{
    "data": [
        {
            "id": "e-5a1c2d3e-0000-4000-8000-000000000001",
            "type": "event",
            "created_at": "2026-09-01T12:00:00.000Z",
            "actor": null,
            "action": "lead_created",
            "data": {
                "origin": "Site",
                "form_name": "Contato",
                "previous_attendances": [],
                "previous_contact": {
                    "exists": false,
                    "lead_id": null
                }
            },
            "label": "Lead criado! (Origem: Site)"
        },
        {
            "id": "e-5a1c2d3e-0000-4000-8000-000000000002",
            "type": "event",
            "created_at": "2026-09-01T12:00:01.000Z",
            "actor": null,
            "action": "responsible_assigned",
            "data": {
                "responsible": {
                    "id": "22222222-2222-4222-8222-222222222222",
                    "name": "Ana"
                },
                "distribution_group": {
                    "id": "33333333-3333-4333-8333-333333333333",
                    "name": "Zona Sul"
                }
            },
            "label": "Atribuído a Ana via grupo: Zona Sul"
        },
        {
            "id": "e-5a1c2d3e-0000-4000-8000-000000000003",
            "type": "event",
            "created_at": "2026-09-01T12:05:00.000Z",
            "actor": {
                "id": "22222222-2222-4222-8222-222222222222",
                "name": "Ana"
            },
            "action": "contact_initiated",
            "data": {
                "channel": "whatsapp",
                "note": "Olá, Maria! Podemos agendar uma visita?"
            },
            "label": "Ana iniciou contato por WhatsApp"
        },
        {
            "id": "e-5a1c2d3e-0000-4000-8000-000000000004",
            "type": "event",
            "created_at": "2026-09-01T12:06:00.000Z",
            "actor": {
                "id": "22222222-2222-4222-8222-222222222222",
                "name": "Ana"
            },
            "action": "property_linked",
            "data": {
                "property": {
                    "ref": "AP100"
                }
            },
            "label": "Ana adicionou o imóvel AP100 à negociação"
        },
        {
            "id": "e-5a1c2d3e-0000-4000-8000-000000000005",
            "type": "event",
            "created_at": "2026-09-02T09:00:00.000Z",
            "actor": {
                "id": "22222222-2222-4222-8222-222222222222",
                "name": "Ana"
            },
            "action": "stage_changed",
            "data": {
                "stage": {
                    "id": null,
                    "name": "Em atendimento",
                    "label": "Em atendimento"
                },
                "lost_reason": null
            },
            "old": {
                "stage": {
                    "id": null,
                    "name": "Novo",
                    "label": "Prospecção"
                }
            },
            "label": "Ana alterou o status para Em atendimento"
        },
        {
            "id": "e-5a1c2d3e-0000-4000-8000-000000000006",
            "type": "event",
            "created_at": "2026-09-02T09:10:00.000Z",
            "actor": {
                "id": "22222222-2222-4222-8222-222222222222",
                "name": "Ana"
            },
            "action": "visit_created",
            "data": {
                "visit": {
                    "id": "44444444-4444-4444-8444-444444444444",
                    "status": "scheduled",
                    "scheduled_at": "2026-09-03T14:00:00.000Z",
                    "properties": [
                        {
                            "ref": "AP100"
                        }
                    ]
                }
            },
            "label": "Ana agendou uma visita para 03/09/2026 às 11:00"
        },
        {
            "id": "c-55555555-5555-4555-8555-555555555555",
            "type": "comment",
            "created_at": "2026-09-02T09:12:00.000Z",
            "actor": {
                "id": "22222222-2222-4222-8222-222222222222",
                "name": "Ana"
            },
            "text": "Maria prefere visitar pela manhã.",
            "edited_at": null,
            "mentions": []
        }
    ],
    "meta": {
        "pagination": {
            "page": 1,
            "per_page": 50,
            "count": 7,
            "total": 7,
            "total_pages": 1,
            "has_next": false,
            "has_previous": false
        }
    },
    "links": {
        "self": "/v1/leads/aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa/timeline",
        "first": "/v1/leads/aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa/timeline?page=1",
        "previous": null,
        "next": null,
        "last": "/v1/leads/aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa/timeline?page=1"
    }
}
Modificado em 2026-11-12 20:12:41
Página anterior
Atualizar lead
Próxima página
Listar visitas
Built with