Mobile API
The Real Estate plugin includes a REST API under /api/v1, so you can build a mobile app (or any other client) on the same properties, projects and agents as the website. Resido does not ship a mobile app: the API is the part you build on.
Go to Admin -> Settings -> API to see the API settings.
What the API offers
| Group | Examples |
|---|---|
| Public data | GET /api/v1/home, /properties, /properties/search, /projects, /agents, /categories, /features, /facilities, /cities, /currencies, /languages |
| Authentication | POST /api/v1/auth/register, /auth/login, /auth/logout, /auth/forgot-password, /auth/reset-password, and social login with Google, Facebook and X |
| Account (needs a token) | /api/v1/account/profile, /account/properties, /account/dashboard, /account/packages, /account/invoices, /account/transactions |
| Forms | POST /api/v1/consults (the consult form), POST /api/v1/contacts (the contact form), property reviews |
Requests that need a signed-in user send the token returned by the login call in the Authorization: Bearer <token> header (Laravel Sanctum).
The routes are defined in platform/plugins/real-estate/routes/api.php; run php artisan route:list --path=api/v1 to list all of them.