Realto API Playground & Documentation

POST /api/auth/login

Authenticates administrator and issues a session JSON Web Token (JWT).

Request Payload Spec

Send a JSON object containing credentials. Content-Type must be application/json.

Response Structure

A successful response returns user properties and a session token.

Interactive Playground

Response Console

Response payload will be displayed here...

Category Management

Admin Bearer Token (Auto-populated after Login)

GET /api/categories

Retrieves a list of categories. Supports searching by name and filtering by status.

Query Parameters (Optional)

You can append optional query parameters to search and filter categories.

"search": "filters by category name (partial match)",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

POST /api/categories

Creates a new category. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

PUT /api/categories/:id

Updates an existing category. Only updates fields provided. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

DELETE /api/categories/:id

Deletes a category from the system. Required: Admin authentication token.

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

GET /api/categories/export

Retrieves a CSV file containing categories matching the filter criteria. Requires Admin authorization token.

Query Parameters (Optional)

You can search and filter the categories exported to the CSV file.

"search": "filters by category name",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Returns a CSV file as an attachment download.

ID,Name,Description,Image,Status,Created At,Updated At
1,Electronics,Gadgets and devices,/uploads/xxxx.png,active,2026-07-14 06:59:01,2026-07-14 06:59:01

Interactive Playground

Response Console

Response download status will be displayed here...

Language Management

GET /api/languages

Retrieves a list of languages. Supports searching by country/language and filtering by status.

Query Parameters (Optional)

You can append optional query parameters to search and filter languages.

"search": "filters by country name or language name (partial match)",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

POST /api/languages

Creates a new language. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

PUT /api/languages/:id

Updates an existing language. Only updates fields provided. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

DELETE /api/languages/:id

Deletes a language from the system. Required: Admin authentication token.

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

GET /api/languages/export

Retrieves a CSV file containing languages matching the filter criteria. Requires Admin authorization token.

Query Parameters (Optional)

You can search and filter the languages exported to the CSV file.

"search": "filters by country name or language name",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Returns a CSV file as an attachment download.

ID,Country Name,Language Name,Image,Status,Created At,Updated At
1,France,French,/uploads/xxxx.png,active,2026-07-15 10:46:00,2026-07-15 10:46:00

Interactive Playground

Response Console

Response download status will be displayed here...

Real Estate Agents Management

GET /api/agents

Retrieves a list of real estate agents. Supports searching by agent name and filtering by status.

Query Parameters (Optional)

You can append optional query parameters to search and filter agents.

"search": "filters by agent name (partial match)",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

POST /api/agents

Creates a new agent. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

PUT /api/agents/:id

Updates an existing agent. Only updates fields provided. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

DELETE /api/agents/:id

Deletes an agent from the system. Required: Admin authentication token.

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

GET /api/agents/export

Retrieves a CSV file containing agents matching the filter criteria. Requires Admin authorization token.

Query Parameters (Optional)

You can search and filter the agents exported to the CSV file.

"search": "filters by agent name",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Returns a CSV file as an attachment download.

ID,Name,Image,Status,Created At,Updated At
1,John Doe,http://localhost:3005/uploads/xxxx.png,active,2026-07-15 15:56:00,2026-07-15 15:56:00

Interactive Playground

Response Console

Response download status will be displayed here...

Brokers and Brokerage Management

GET /api/brokerages

Retrieves a list of brokerages. Supports searching by name/description and filtering by status.

Query Parameters (Optional)

You can append optional query parameters to search and filter brokerages.

"search": "filters by brokerage name or description (partial match)",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

POST /api/brokerages

Creates a new brokerage. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

PUT /api/brokerages/:id

Updates an existing brokerage. Only updates fields provided. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

DELETE /api/brokerages/:id

Deletes a brokerage from the system. Required: Admin authentication token.

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

GET /api/brokerages/export

Retrieves a CSV file containing brokerages matching the filter criteria. Requires Admin authorization token.

Query Parameters (Optional)

You can search and filter the brokerages exported to the CSV file.

"search": "filters by brokerage name or description",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Returns a CSV file as an attachment download.

ID,Name,Description,Percentage,Image,Status,Created At,Updated At
1,Apex Brokers,Top brokerage in region,5.50,http://localhost:3005/uploads/xxxx.png,active,2026-07-16 12:24:00,2026-07-16 12:24:00

Interactive Playground

Response Console

Response download status will be displayed here...

Hotel Logos Management

GET /api/hotels

Retrieves a list of hotels. Supports searching by hotel name/description and filtering by status.

Query Parameters (Optional)

You can append optional query parameters to search and filter hotels.

"search": "filters by hotel name or description (partial match)",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

POST /api/hotels

Creates a new hotel record. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

PUT /api/hotels/:id

Updates an existing hotel record. Only updates fields provided. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

DELETE /api/hotels/:id

Deletes a hotel record from the system. Required: Admin authentication token.

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

GET /api/hotels/export

Retrieves a CSV file containing hotels matching the filter criteria. Requires Admin authorization token.

Query Parameters (Optional)

You can search and filter the hotels exported to the CSV file.

"search": "filters by hotel name or description",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Returns a CSV file as an attachment download.

ID,Name,Description,Image,Status,Created At,Updated At
1,Grand Palace Hotel,Luxury 5-star hotel in city center,http://localhost:3005/uploads/xxxx.png,active,2026-07-16 12:40:00,2026-07-16 12:40:00

Interactive Playground

Response Console

Response download status will be displayed here...

Commercial Realestate Agencies Management

GET /api/commercial-agencies

Retrieves a list of commercial agencies. Supports searching by agency name/description and filtering by status.

Query Parameters (Optional)

You can append optional query parameters to search and filter agencies.

"search": "filters by commercial agency name or description (partial match)",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

POST /api/commercial-agencies

Creates a new commercial agency record. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

PUT /api/commercial-agencies/:id

Updates an existing commercial agency record. Only updates fields provided. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

DELETE /api/commercial-agencies/:id

Deletes a commercial agency record from the system. Required: Admin authentication token.

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

GET /api/commercial-agencies/export

Retrieves a CSV file containing commercial agencies matching the filter criteria. Requires Admin authorization token.

Query Parameters (Optional)

You can search and filter the agencies exported to the CSV file.

"search": "filters by commercial agency name or description",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Returns a CSV file as an attachment download.

ID,Name,Description,Image,Status,Created At,Updated At
1,CBRE Commercial,Top global commercial real estate agency,http://localhost:3005/uploads/xxxx.png,active,2026-07-16 13:29:00,2026-07-16 13:29:00

Interactive Playground

Response Console

Response download status will be displayed here...

Student Residency Partners Management

GET /api/student-partners

Retrieves a list of student residency partners. Supports searching by partner name/description and filtering by status.

Query Parameters (Optional)

You can append optional query parameters to search and filter partners.

"search": "filters by partner name or description (partial match)",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

POST /api/student-partners

Creates a new student partner record. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

PUT /api/student-partners/:id

Updates an existing partner record. Only updates fields provided. Required: Admin authentication token.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

DELETE /api/student-partners/:id

Deletes a partner record from the system. Required: Admin authentication token.

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

GET /api/student-partners/export

Retrieves a CSV file containing student partners matching the filter criteria. Requires Admin authorization token.

Query Parameters (Optional)

You can search and filter the partners exported to the CSV file.

"search": "filters by partner name or description",
"status": "filters by status ('active' or 'inactive')"

Response Spec

Returns a CSV file as an attachment download.

ID,Name,Description,Image,Status,Created At,Updated At
1,Unilodge Housing,Student accommodation partner,http://localhost:3005/uploads/xxxx.png,active,2026-07-16 13:47:00,2026-07-16 13:47:00

Interactive Playground

Response Console

Response download status will be displayed here...

Get in touch Contact Management

POST /api/contacts

Submits a new contact message (Public). Saves request data in database and triggers SendGrid email notification to admin.

Request Payload Spec

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

GET /api/contacts

Retrieves contact submissions list. Supports keyword search query parameter. Required: Admin authentication token.

Query Parameters (Optional)

You can search contact submissions by name, email, phone, or message contents.

"search": "filters by sender name, phone, email, or message (partial match)"

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

DELETE /api/contacts/:id

Deletes a contact submission record from database. Required: Admin authentication token.

Response Spec

Interactive Playground

Response Console

Response payload will be displayed here...

GET /api/contacts/export

Retrieves a CSV file containing contact submissions matching the keyword filters. Requires Admin authorization token.

Query Parameters (Optional)

You can search and filter the exported contact rows.

"search": "filters by sender name, phone, email, or message contents"

Response Spec

Returns a CSV file as an attachment download.

ID,Full Name,Phone Number,Email Address,Message,Created At
1,John Doe,+61 411 222 333,john.doe@example.com,Hello I want to rent a commercial space.,2026-07-16 14:38:00

Interactive Playground

Response Console

Response download status will be displayed here...