Fields Property

Retrieve A List Of Property Fields

get/v1/property-fields

Request

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

Query parameters

with_inactivesboolean nullable

Response

Successful Response

field_idstring

Required 'custom_' in id for create field

activeboolean nullable
group_namestring nullable

Name of the group. It should be defined based on the field type — for example, use 'group_contact' for contact fields, 'group_lead' for lead fields, and so on.

group_positioninteger nullable

Position of the group. Required for create a new field

namestring nullable
requiredboolean nullable
show_only_on_editboolean nullable
request_digital_real_estateboolean nullable
request_typestring[]

List of request types for the field

contract_typesstring[]

List of contract types for the field

lease_typesstring[]

List of lease types for the field

show_real_timeboolean nullable
url_linkstring nullable
url_headerstring nullable
defaultboolean nullable

Indicates whether this field is the default field.

subgroup_namestring nullable

Name of the subgroup this field belongs to.

subgroup_positioninteger nullable

Position of the field within the subgroup.

show_on_websiteboolean nullable

Indicates whether this field should be shown on the website.

Changes

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