HomeEscape API

Service

Name	Get Properties
Description	Get the list of properties of a owner
Method	GET
URL	/properties[?page={page}]
Example	/api/properties?page=1
Access	OWNER, MANAGER

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
page	number	no	It can be used to paginate the result. By default 0 returns all.
per_page	number	no	It can be used to limit the result. By default 20 items per page.

Response

            
                [
                    {
                     "id": "11111111",
                     "tagline": "The Best Home In Miami Beach Since 1959.",
                     "description": "Good apto localized in  Ocean Dr, front to most popular beach at Florida state...",
                     "luxury": false,
                     "size": "1000",
                     "size_unit": 0,
                     "property_type": "Apartment",
                     "location_types": [
                        "Near The Ocean",
                        "Waterfront",
                        "Golf"
                     ],
                     "bedrooms": 1,
                     "bathrooms": 1,
                     "half_bath": 0,
                     "sleeps": 4,
                     "currency": "USD",
                     "bedding": "2 bunk bed",
                     "views": 7,
                     "min_price": 67,
                     "favourite": 0,
                     "reviews_av": 5,
                     "reviews_total": 0,
                     "featured": true,
                     "subscribed": false,
                     "purchased": "null",
                     "why_this": "null",
                     "benefits": "null",
                    },
                    ...
                ]

Response Codes

Code	Message	Cause	Possible Frontend Message [Behavior]
`EC000`	`Internal error in API`	Internal error connecting the database	"Oops! Looks like we hit a snag. Try closing the app and reopening it."
`EC001`	`User not found`	Token user id doesn't match our records	"Sorry, We couldn't find your information!"
`EC004`	`Not found result`	There are problems finding the data in our database	"No Record Found"
`SC006`	`User no authorization`	The token role is not valid for using the API services	"You have been logged out." - [Take the user to the login screen]
`SC014`	`Expired token`	The token has expired	"You have been logged out." - [Take the user to the login screen]
`VID110`	`Invalid input for page`	Page is not a number	[Call the API again using a valid value for page]
`VID111`	`Invalid input for per_page`	Per_page is not a number	[Call the API again using a valid value for per_page]