PaginatedResponse[Union[ListForRentProduct, ListForSalesProduct]]

countCount (integer)

Default value: 0

next object

anyOf

MOD1

string

Possible values: non-empty and <= 2083 characters

MOD2

string

MOD3

previous object

anyOf

MOD1

string

Possible values: non-empty and <= 2083 characters

MOD2

string

MOD3

results object[]

Array [

anyOf

ListForRentProduct

achived_at object

anyOf

MOD1

string

MOD2

category object

The type of the property (e.g., house, apartment).

anyOf

ProductType

string

Possible values: [house, apartment, land, commercial, other, prestige]

MOD2

title object

The title or headline for the property listing.

anyOf

MOD1

string

MOD2

description object

A detailed description of the property.

anyOf

MOD1

string

MOD2

reference object

A reference number or code for the property.

anyOf

MOD1

string

MOD2

availableAvailable (boolean)

Indicates whether the property is currently available.

Default value: true

availability object

The date from which the property will be available.

anyOf

MOD1

string

MOD2

exclusivity object

Indicates whether the property is listed exclusively.

anyOf

MOD1

boolean

MOD2

disable_spontaneous_applications object

If disabled, the public link to send an application will stop accepting applications.

anyOf

MOD1

boolean

MOD2

managersstring[]

Default value: []

metaMeta

Additional metadata about the property.

Default value: {}

iduuidrequired

tenantTenant (string)required

created_atdate-timerequired

updated_atdate-timerequired

mandate_typeMandate Type (string)

The type of mandate for the property.

Default value: management

rent_amount object

The monthly rent amount.

anyOf

MOD1

number

MOD2

monthly_charges object

The monthly charges in addition to rent.

anyOf

MOD1

number

MOD2

furnishedFurnished (boolean)

Indicates whether the property is furnished.

Default value: false

warranty_amount object

The total deposit for warranty.

anyOf

MOD1

number

MOD2

agency_fees object

The amount of fees applyied by the agency for this product.

anyOf

MOD1

number

MOD2

unpaid_rent_insurance object

Whether or not this product is insured against unpaid rent.

anyOf

MOD1

boolean

MOD2

photo object

anyOf

ProductPhoto

_idId (string)

Example: 5eb7cf5a86d9755df3a6c593

sizeSize (integer)required

path object

anyOf

MOD1

string

MOD2

filenameFilename (string)required

content_typeContent Type (string)required

favoriteFavorite (boolean)

Default value: false

MOD2

incoming_requestsIncoming Requests (integer)

Default value: 0

ListForSalesProduct

achived_at object

anyOf

MOD1

string

MOD2

category object

The type of the property (e.g., house, apartment).

anyOf

ProductType

string

Possible values: [house, apartment, land, commercial, other, prestige]

MOD2

title object

The title or headline for the property listing.

anyOf

MOD1

string

MOD2

description object

A detailed description of the property.

anyOf

MOD1

string

MOD2

reference object

A reference number or code for the property.

anyOf

MOD1

string

MOD2

availableAvailable (boolean)

Indicates whether the property is currently available.

Default value: true

availability object

The date from which the property will be available.

anyOf

MOD1

string

MOD2

exclusivity object

Indicates whether the property is listed exclusively.

anyOf

MOD1

boolean

MOD2

disable_spontaneous_applications object

If disabled, the public link to send an application will stop accepting applications.

anyOf

MOD1

boolean

MOD2

managersstring[]

Default value: []

metaMeta

Additional metadata about the property.

Default value: {}

iduuidrequired

tenantTenant (string)required

created_atdate-timerequired

updated_atdate-timerequired

mandate_typeMandate Type (string)

The type of mandate for the property.

Default value: sales

price object

The price of the property. Must be greater than 0.

anyOf

MOD1

number

MOD2

fee object

Fee associated with the property.

anyOf

MOD1

number

MOD2

fee_typeFee Type (string)

The type of fee arrangement (e.g., direct or reverse).

Possible values: [direct, reverse]

Default value: direct

photo object

anyOf

ProductPhoto

_idId (string)

Example: 5eb7cf5a86d9755df3a6c593

sizeSize (integer)required

path object

anyOf

MOD1

string

MOD2

filenameFilename (string)required

content_typeContent Type (string)required

favoriteFavorite (boolean)

Default value: false

MOD2

incoming_requestsIncoming Requests (integer)

Default value: 0

]

PaginatedResponse[Union[ListForRentProduct, ListForSalesProduct]]

{
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
    {
      "achived_at": "2024-07-29T15:51:28.071Z",
      "category": "house",
      "title": "string",
      "description": "string",
      "reference": "string",
      "available": true,
      "availability": "2024-07-29",
      "exclusivity": true,
      "disable_spontaneous_applications": true,
      "managers": [
        "string"
      ],
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenant": "string",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "mandate_type": "management",
      "rent_amount": 0,
      "monthly_charges": 0,
      "furnished": false,
      "warranty_amount": 0,
      "agency_fees": 0,
      "unpaid_rent_insurance": true,
      "photo": {
        "_id": "5eb7cf5a86d9755df3a6c593",
        "size": 0,
        "path": "string",
        "filename": "string",
        "content_type": "string",
        "favorite": false
      },
      "incoming_requests": 0
    },
    {
      "achived_at": "2024-07-29T15:51:28.071Z",
      "category": "house",
      "title": "string",
      "description": "string",
      "reference": "string",
      "available": true,
      "availability": "2024-07-29",
      "exclusivity": true,
      "disable_spontaneous_applications": true,
      "managers": [
        "string"
      ],
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenant": "string",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "mandate_type": "sales",
      "price": 0,
      "fee": 0,
      "fee_type": "direct",
      "photo": {
        "_id": "5eb7cf5a86d9755df3a6c593",
        "size": 0,
        "path": "string",
        "filename": "string",
        "content_type": "string",
        "favorite": false
      },
      "incoming_requests": 0
    }
  ]
}