Property Reserves

Retrieve A List Of Property Reserves

get/v1/property-reserves

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/property-reserves
  • Auth: API key in header X-Imobzi-Secret

Query parameters

deal_idstring nullable
string
OR
integer
string
OR
integer
contact_typeunknown

Response

Successful Response

startstring nullable

Reservation start date (required if create)

endstring nullable

Reservation end date (required if create)

user_namestring nullable

Name of the user who created the reservation

user_image_urlstring nullable

URL of the user's profile image

descriptionstring nullable

Additional description or notes about the reservation

deal_idstring nullable

ID of the associated deal, if applicable

deal_titlestring nullable

Title of the associated deal, if applicable

contact_typestring nullable

Type of the contact (e.g., person, company)

contact_namestring nullable

Name of the contact

contact_image_urlstring nullable

URL of the contact's profile image

proposalboolean nullable

Indicates whether this reservation is linked to a proposal

finalitystring nullable

Purpose or finality of the reservation

colorstring nullable

Color code associated with the reservation (e.g., for calendar display)

codestring nullable

Custom code or identifier for the reservation

statusstring nullable

Current status of the reservation

titlestring nullable

Title of the reservation

Example response

[
  {
    "property": {
      "field_values": [
        {
          "field_id": "guarantor",
          "type": "boolean",
          "value": "True"
        },
        {
          "field_id": "bail",
          "type": "boolean",
          "value": "False"
        },
        {
          "field_id": "surety_bond",
          "type": "boolean",
          "value": "False"
        },
        {
          "field_id": "bond_application",
          "type": "boolean",
          "value": "True"
        },
        {
          "field_id": "credpago_guarantee",
          "type": "boolean",
          "value": "True"
        },
        {
          "field_id": "iptu",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "condominium",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "water",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "gas",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "light",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "cleaning_fee",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "value_to_fire_insurance",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "approx_fire_insurance_value",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "high_standard",
          "type": "boolean",
          "value": "True"
        },
        {
          "field_id": "with_plaque",
          "type": "boolean",
          "value": "True"
        },
        {
          "field_id": "exclusivity",
          "type": "boolean",
          "value": "False"
        },
        {
          "field_id": "private",
          "type": "boolean",
          "value": "False"
        }
      ]
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.