Ir al contenido principal

Listar Propiedades

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada una de las propiedades registradas en la inmobiliaria.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/properties

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type pplication/json
Bearer token Token obtenido al consumir el servicio Login

Representa

lafechadefindelrangodefechasenelqueuninmueblehasidocaptado/consignadoparasuventa
Parámetros
Parámetro Tipo Obligatorio

Valor por defecto

Descripción

page
integerNo1Especifica la página de resultados que se desea recuperar al realizar la solicitud.
limitintegerNo10Especifica el número máximo de elementos que se deben devolver en la solicitud, el límite máximo es de 50.
listing_start_datestringNo

Representa la fecha de inicio del rango de fechas en el que un inmueble ha sido captado/consignado para su venta o alquiler.


Formato: YYYY/mm/dd
listing_start_datestringNo
















o alquiler.

Formato: YYYY/mm/dd


Nota:
 Para los parámetros de tipo fecha que se compongan de un rango, como listing_start_date y listing_end_date, se debe tener en cuenta que si se envía solo el start_date, se retornarán registros donde la condición es “>=”. Si solo se envía el end_date, se retornarán registros donde la condición es “<=”, y si se envían ambas, entonces se retornarán registros dentro de ese rango de fechas.

Ejemplos de peticiones

https://{{instancia}}.arrendasoft.co/service/v2/public/properties
https://{{instancia}}.arrendasoft.co/service/v2/public/properties/
https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10
https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10&listing_start_date=2024-03-26
https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10&listing_start_date=2024-03-26&listing_end_date=2024-03-26

 

Respuesta