Properties API

v1.0 • REST • JSON

Full CRUD management for property accounts. Create, retrieve, update, and delete property records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints
Base URL https://bogusapi.com/api/properties

Quick Reference

GET
/api/properties List all properties (paginated)
200 GET
/api/properties/{id} Get one property by ID
200 POST
/api/properties Create a new property
201 PUT
/api/properties/{id} Replace property data
204 DEL
/api/properties/{id} Remove a property
204 GET
/api/properties/{id} Property not found example
404
GET /api/properties 200 OK

Get All Properties

Retrieves a paginated list of all properties in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/properties/{id} 200 OK

Get Single Property

Fetch the full profile for a specific property using their numeric ID. Returns all property fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique property identifier
Response: 200 OK
GET /api/properties/{id} 404 Not Found

Property Not Found

Returned when the requested property ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing property resources.

Response: 404 Not Found
POST /api/properties 201 Created

Create Property

Registers a new property with the provided details. On success, returns the newly created property object including the auto-generated ID, timestamp, and resolved role names.

Request Body
Field Type Required Description
name string Required Name
description string Optional Description
propertyType string Required Property type
address string Required Address
city string Required City
price decimal Required Price
bedrooms integer Required Bedrooms
bathrooms integer Required Bathrooms
areaSqFt integer Required Area sq ft
listingStatus string Required Listing status
agentName string Required Agent name
Body
Response: 201 Created
PUT /api/properties/{id} 200 OK

Update Property

Fully replaces an existing property's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
Field Type Required Description
name string Required Name
description string Optional Description
propertyType string Required Property type
address string Required Address
city string Required City
price decimal Required Price
bedrooms integer Required Bedrooms
bathrooms integer Required Bathrooms
areaSqFt integer Required Area sq ft
listingStatus string Required Listing status
agentName string Required Agent name
Body
Response: 200 OK
DELETE /api/properties/{id} 204 No Content

Delete Property

Permanently removes a property from the system by their ID. This action is irreversible once deleted, the property record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the property to delete
Response: 204 No Content