Buscar clientes - Homfy Public API

Busca paginada entre os clientes da imobiliária — TODOS eles, inclusive os que não vieram da sua integração (cadastro no painel, campanha, importação). Esses itens voltam sem partner_code, e as demais rotas só sabem falar por partner_code: consultar, atualizar ou atribuir corretor a eles pela API não é possível. Use a busca para reconciliar a sua base, não como índice de tudo o que dá para operar.

page começa em 0 e o teto é 50 por página; itere até receber items vazio.

Dá para listar a carteira de um corretor (filters.realstate_agent_id), só quem ainda não tem responsável (filters.has_assigned_agent: false) ou só quem já tem (true). Para sincronização incremental use filters.updated_since (data ISO 8601, borda inclusiva) com multiSort: [{ "field": "updated_at", "order": 1 }], paginando até items vir vazio, e guarde o maior updated_at recebido para a próxima execução. Não há filtro por e-mail nem por documento.

Os itens vêm em forma de resumo. Para a qualificação completa, use POST /partner/v1/lead/find.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "rows": 50,
    "page": 0,
    "multiSort": [
        {
            "field": "id",
            "order": 1
        }
    ],
    "filters": {
        "updated_since": "2026-08-19T20:33:39.719Z",
        "status": 1,
        "segment": "Investidor",
        "realstate_agent_id": 42,
        "name": "ana",
        "whatsapp": "(48) 99999-1234",
        "partner_code": "CLI-8842",
        "address_state": "SC",
        "address_city": "Florianópolis",
        "has_assigned_agent": false,
        "search_text": "ana"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Página de clientes, com total.

Bodyapplication/json

Example

{
    "total": 526,
    "items": [
        {
            "partner_code": "AP-1024",
            "lead_id": 900,
            "name": "Ana Corretora",
            "whatsapp": "48999998888",
            "email": "ana@imobiliaria.com.br",
            "segment": "Investidor",
            "status": 1,
            "realstate_agent_id": 42,
            "created_at": "2026-08-19T20:33:39.719Z",
            "updated_at": "2026-08-19T20:33:39.719Z"
        }
    ]
}

🟠400

🟠401

🟠403

🟠429

🔴500