ImobyFlowParcerias Imobiliárias
Browse the documentation
Português

Reference lists

The accepted values for each code field: property types, purposes, statuses, stages, permissions and events. They are the SAME values stored by the platform — there is no translation layer.

The values

The codes accepted today. Each one's label, in the request language, comes from the routes below. New values can arrive: your system must tolerate unknown ones.

Property type (type)
APARTAMENTOCASA_RUACASA_CONDOMINIOCASA_VILASTUDIOFLATCOBERTURASALA_COMERCIALLOJA_PONTOGALPAOPREDIOTERRENO_RUATERRENO_CONDOMINIOCHACARA_SITIOFAZENDA
Category
RESIDENCIALCOMERCIALTERRENORURAL
Purpose (purposes)
VENDALOCACAO
Property status
ACTIVEINACTIVESOLDRENTED
Client stage
NEWATTENDINGPROPOSALWONLOST
Partnership stage
PENDINGACCEPTEDDECLINEDCANCELLEDLEAD_REGISTEREDCONTACTEDNEGOTIATINGPROPOSALWONLOST
Construction stage
LAUNCHOFF_PLANNEWREADY
Key permissions
properties:readproperties:writeleads:readleads:writeradar:readradar:writepartnerships:readpartnerships:writeteam:readlaunches:readlaunches:writecaptacao:readcaptacao:acceptevents:readwebhooks:manage
What a property lacks to enter recommendations
CITY_MISSINGCITY_NOT_IN_CATALOGNEIGHBORHOOD_MISSINGNEIGHBORHOOD_NOT_IN_CATALOGTYPE_MISSINGPURPOSE_MISSINGSALE_PRICE_MISSINGRENT_PRICE_MISSINGCOVER_PHOTO_MISSINGOTHER
What a client lacks to get recommendations
PURPOSE_MISSINGPROPERTY_TYPES_MISSINGCITY_MISSINGCITY_NOT_IN_CATALOGBUDGET_MISSINGSALE_BUDGET_MISSINGRENT_BUDGET_MISSINGOTHER
Review refusal reason
LANCAMENTOSEM_VALORQUALIDADE_BAIXANAO_ANGARIACAOMARCA_DAGUAFOTOS_INSUFICIENTESDADOS_INCOERENTESOUTRO

Routes

GET/v1/reference/property-types

Property types

Categories and subtypes. The subtype is what goes in the type field.

Permission: any valid key

Response200OK

datalist of PropertyTypeGrouprequired
The list.

Example

curl -X GET 'https://api.imobyflow.com.br/v1/reference/property-types' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

Errors for this route

    And the errors common to every route

    GET/v1/reference/purposes

    Purposes

    Sale and rent.

    Permission: any valid key

    Response200OK

    datalist of ValueLabelrequired
    The list.

    Example

    curl -X GET 'https://api.imobyflow.com.br/v1/reference/purposes' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

    Errors for this route

      And the errors common to every route

      GET/v1/reference/property-statuses

      Property statuses

      The statuses a property can have.

      Permission: any valid key

      Response200OK

      datalist of ValueLabelrequired
      The list.

      Example

      curl -X GET 'https://api.imobyflow.com.br/v1/reference/property-statuses' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

      Errors for this route

        And the errors common to every route

        GET/v1/reference/lead-statuses

        Client stages

        The funnel stages.

        Permission: any valid key

        Response200OK

        datalist of ValueLabelrequired
        The list.

        Example

        curl -X GET 'https://api.imobyflow.com.br/v1/reference/lead-statuses' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

        Errors for this route

          And the errors common to every route

          GET/v1/reference/partnership-statuses

          Partnership stages

          The partnership stages.

          Permission: any valid key

          Response200OK

          datalist of ValueLabelrequired
          The list.

          Example

          curl -X GET 'https://api.imobyflow.com.br/v1/reference/partnership-statuses' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

          Errors for this route

            And the errors common to every route

            GET/v1/reference/construction-stages

            Construction stages

            The stages of a new development.

            Permission: any valid key

            Response200OK

            datalist of ValueLabelrequired
            The list.

            Example

            curl -X GET 'https://api.imobyflow.com.br/v1/reference/construction-stages' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

            Errors for this route

              And the errors common to every route

              GET/v1/reference/scopes

              Permissions

              The permissions a key can have.

              Permission: any valid key

              Response200OK

              datalist of ScopeInforequired
              The list.

              Example

              curl -X GET 'https://api.imobyflow.com.br/v1/reference/scopes' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

              Errors for this route

                And the errors common to every route

                GET/v1/reference/event-types

                Event types

                The events, with the read permission that grants access to each.

                Permission: any valid key

                Response200OK

                datalist of EventTypeInforequired
                The list.

                Example

                curl -X GET 'https://api.imobyflow.com.br/v1/reference/event-types' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

                Errors for this route

                  And the errors common to every route

                  Objects

                  ValueLabel

                  An accepted value and its label.

                  valuestringrequired
                  The value to send in the field.
                  labelstringrequired
                  The label, in the Accept-Language language.

                  PropertyTypeGroup

                  A property category and its subtypes.

                  categorystringrequired
                  The category.one of RESIDENCIAL COMERCIAL TERRENO RURAL
                  labelstringrequired
                  Category label.
                  typeslist of ValueLabelrequired
                  The subtypes in the category — the subtype is what goes in type.

                  ScopeInfo

                  A permission a key can have.

                  idstringrequired
                  The permission.one of properties:read properties:write leads:read leads:write radar:read radar:write partnerships:read partnerships:write team:read launches:read launches:write captacao:read captacao:accept events:read webhooks:manage
                  groupstringrequired
                  The group, for display.
                  labelstringrequired
                  The name, for display.
                  descriptionstringrequired
                  What it allows.

                  EventTypeInfo

                  An event type.

                  typestringrequired
                  The event type.one of property.created property.updated property.deleted property.restored property.purged lead.created lead.updated lead.deleted lead.restored lead.purged radar.client_summary partnership.created partnership.updated captacao.offer_received captacao.offer_accepted captacao.offer_withdrawn
                  scopestringrequired
                  The read permission that grants access to it.one of properties:read properties:write leads:read leads:write radar:read radar:write partnerships:read partnerships:write team:read launches:read launches:write captacao:read captacao:accept events:read webhooks:manage
                  descriptionstringrequired
                  What it signals.