Buscar proprietários

POST

/partner/v1/property-owner/search

Busca paginada entre os proprietários da imobiliária, inclusive os que não vieram da sua integração. page começa em 0 e o teto é 50 por página; itere até receber items vazio.

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

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "rows": 50,
    "page": 0,
    "multiSort": [
        {
            "field": "name",
            "order": 1
        }
    ],
    "filters": {
        "updated_since": "2026-08-19T20:33:39.719Z",
        "name": "silva",
        "whatsapp": "(48) 99999-1234",
        "email": "joao@exemplo.com",
        "document": "123.456.789-00",
        "partner_code": "PROP-4471",
        "is_active": true,
        "search_text": "joão"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/partner/v1/property-owner/search' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rows": 50,
    "page": 0,
    "multiSort": [
        {
            "field": "name",
            "order": 1
        }
    ],
    "filters": {
        "updated_since": "2026-08-19T20:33:39.719Z",
        "name": "silva",
        "whatsapp": "(48) 99999-1234",
        "email": "joao@exemplo.com",
        "document": "123.456.789-00",
        "partner_code": "PROP-4471",
        "is_active": true,
        "search_text": "joão"
    }
}'

Responses

🟢200

application/json

Página de proprietários, com total.

Bodyapplication/json

Example

{
    "total": 526,
    "items": [
        {
            "partner_code": "AP-1024",
            "property_owner_id": "66c1f3a2e4b0a1d2c3e4f5a6",
            "name": "Ana Corretora",
            "whatsapp": "48999998888",
            "email": "ana@imobiliaria.com.br",
            "created_at": "2026-08-19T20:33:39.719Z",
            "updated_at": "2026-08-19T20:33:39.719Z",
            "document": "string",
            "document_type": "string",
            "is_active": true
        }
    ]
}

🟠400

🟠401

🟠403

🟠429

🔴500

Modified at 2026-08-20 16:06:11

Consultar detalhes do proprietário

Vincular proprietário a imóvel