Consultar corretores - Homfy Public API

Lista os corretores da imobiliária do token, paginada — page começa em 0, o teto é 50 por página, e a ordem é do cadastro mais recente para o mais antigo, não configurável.

É daqui que sai o realstate_agent_id de POST /partner/v1/lead/assign-agent. O uso mais direto: você recebeu uma página de clientes, juntou os realstate_agent_id que vieram nela e resolve todos os nomes numa chamada só, com filters.realstate_agent_id.

Somente leitura. Quem entra e sai da equipe é decisão da imobiliária, tomada no painel — não há rota de cadastro, alteração ou remoção. Nenhuma permissão de usuário é devolvida.

Corretor desativado continua aparecendo, com is_active: false: ele tem histórico e pode ser o responsável por clientes antigos. O que ele não pode é receber cliente novo.

Id que não volta. filters.realstate_agent_id com 50 ids pode devolver menos de 50 itens, sem erro: o id pode ser de outra imobiliária, de alguém que saiu da equipe, ou não existir. Os casos são indistinguíveis — trate id ausente como "não resolvível", nunca como falha.

O que esta rota não tem: filtro por e-mail, por CRECI ou por data. Ao contrário de imóvel, cliente e proprietário, aqui não existe updated_since, e é decisão: o que muda num corretor é o nome e a situação do usuário dele, que vive noutro registro, e um filtro pela data do cadastro deixaria essas mudanças de fora em silêncio. A lista da equipe cabe em uma ou duas páginas — releia inteira.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "rows": 50,
    "page": 0,
    "filters": {
        "realstate_agent_id": [
            42,
            43
        ],
        "name": "ana",
        "is_active": true
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Página de corretores, com total.

Bodyapplication/json

Example

{
    "total": 526,
    "items": [
        {
            "realstate_agent_id": 42,
            "name": "Ana Corretora",
            "email": "ana@imobiliaria.com.br",
            "creci": "CRECI-12345",
            "is_active": true
        }
    ]
}

🟠400

🟠401

🟠403

🟠429

🔴500