ImobyFlowParcerias Imobiliárias
Browse the documentation
Português

Changelog and versions

The current version is v1 (contract 1.0.0). Changes are announced here before they apply.

Versioning policy

  • Adding does not break: new fields, events, routes and values can arrive at any time. Your system must tolerate fields it does not know.
  • Anything that breaks an existing integration ships in a new version (/v2). The previous version keeps working for at least 12 months after the notice, published here and e-mailed to the account owner.
  • Code values (VENDA, ACTIVE, the subtypes) are the same as the platform's, with no translation layer.

What changed

    • Official SDKs in TypeScript, Python and PHP, generated from this contract: one method per route, pages walked for you, retries that never duplicate a write, and webhook signature verification.
    • Response examples (success and errors) in the Postman collection and in the OpenAPI. The public Postman collection follows every release.
    • POST /v1/feed/sync: your system says the portfolio changed and ImobyFlow fetches the feed link right away, without waiting 6 hours; GET /v1/feed shows the result.
    • MCP server at https://api.imobyflow.com.br/mcp: AI agents read and update the account with the same key. Every write runs as a dry run and is only saved after confirmation.

  2. 1.0.0

    • Developer portal in Portuguese and English, generated from the OpenAPI 3.1 contract.
    • One page per error code — the URL in each error's type.
    • Postman collection, OpenAPI in JSON and YAML, and llms.txt for AI assistants.
    • A "Try it" button on every route: calls the API from the browser with your key (real reads, writes always as a dry run) and explains every field of the response — annotated JSON.

    • Signed webhooks (Standard Webhooks), with retries for about 21 hours, automatic disabling, redelivery and a test event.
    • Events (GET /v1/events): what changed in the account, in order, with 30 days of history.
    • E-mail notices: key expiring, monthly quota at 80% and 100%, webhook endpoint disabled.
    • Batches of up to 500 properties or clients.
    • Captação: the desk, accepted owners and acceptance, with its own permission and term.
    • Actions: dismiss and restore opportunities, move partnerships and the trash with the shrink guard.
    • Client writes (your system's code, linking by contact, consent) and property writes (photos by URL, dry run, Idempotency-Key).
    • Reads: properties, clients, opportunities, partnerships, team and new developments.

    • The foundation: per-account keys, account-by-account access, GET /v1/me, reference lists and the city and neighborhood catalog.