Buscar agenciamentos - Homfy Public API

Busca paginada entre os agenciamentos da imobiliária — TODOS eles, inclusive os que nasceram no painel (esses voltam sem partner_code, e as demais rotas só sabem falar por partner_code: use a busca para reconciliar a sua base).

page começa em 0 e o teto é 50 por página; itere até receber items vazio. Filtros por proprietário (owner_partner_code ou owner_id, não os dois), imóvel (property_partner_code ou property_id, não os dois), corretor, situação e etapa. Código de proprietário ou de imóvel que não existe devolve lista vazia.

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. Mover o agenciamento de etapa no painel também o faz reaparecer na janela.

Agenciamento excluído não aparece.

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",
        "partner_code": "AGE-3310",
        "owner_partner_code": "PRO-1020",
        "owner_id": "507f1f77bcf86cd799439011",
        "property_partner_code": "IMO-5521",
        "status": "solicitado",
        "property_id": 1234,
        "realstate_agent_id": 42,
        "property_agency_workflow_step_id": "step_1722600000000_ab12cd34e"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Página de agenciamentos, com total.

Bodyapplication/json

Example

{
    "total": 140,
    "items": [
        {
            "partner_code": "AGE-3310",
            "id": 55,
            "status": "solicitado",
            "property_agency_workflow_step": {
                "id": "step_1722600000000_ab12cd34e",
                "name": "Solicitado"
            },
            "realstate_agent": {
                "id": 42,
                "name": "Bruno Souza"
            },
            "owner": {
                "id": "507f1f77bcf86cd799439011",
                "partner_code": "PRO-1020"
            },
            "property": {
                "id": 1234,
                "partner_code": "IMO-5521"
            },
            "property_type": "Apartamento",
            "property_contract": "Venda",
            "total_area": 120.5,
            "expected_value": 650000,
            "visit_availability": "Seg a sex, das 9h às 17h",
            "property_description": "Apartamento de 3 quartos.",
            "owner_observations": "Prefere contato à tarde.",
            "address": {
                "zipcode": "88010-000",
                "street": "das Flores",
                "street_type": "Rua",
                "number": "100",
                "neighborhood": "Centro",
                "city": "Florianópolis",
                "state": "SC",
                "complement": "Apto 12"
            },
            "created_at": "2026-10-08T14:03:11.000Z",
            "updated_at": "2026-10-08T14:03:11.000Z"
        }
    ]
}

🟠400

🟠401

🟠403

🟠429

🔴500