E-State

index

Developing

GET

http://estate.test/api/v1{{url}}/system/units

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'http://estate.test/api/v1/system/units?search=uni&projects_ids[]=1&building_ids[]=1&unit_ids[]=3,4&status=booked&project_status=under_sale&sale_type=for_rent&emptying_status=in_emptying&orbon_status=with_orbon&client_id=1&contract_file_upload_date=2025-04-08&tax_free_status=free&purchase_method=cash&completed_at=2025-04-10&created_at=2025-04-06&reason_for_pay_id=1&receiving_status=not_receiving&garage=out&board_type=majlis_attached_to_the_hall&ac_type=hidden_split&interface=front_side&view=garden_view&floor=2' \
--header 'x-api-key: f482480c-11fe-4426-9f6e-e7d26c8c3eed' \
--header 'x-secret-key: FkSF0PDbMOgLmLlJeMDSDzBFIl5dloAC'

Response Example

{
    "status": "success",
    "message": "Operation completed successfully",
    "response": {
        "data": [
            {
                "id": 7,
                "building_id": 4,
                "project_id": 9,
                "is_for_rent": true,
                "name": "Laura Rodriguez",
                "status": "nisi irure",
                "url_360": "https://pleased-plumber.net/",
                "floor": "laborum eiusmod do id eu",
                "room_count": 7,
                "doc_unit_number": 3,
                "doc_number": 7,
                "area": "labore officia eiusmod laborum ea",
                "bathroom_count": 2,
                "is_furnished": true,
                "garage": "eiusmod sit in aliquip sunt",
                "tax_rate": 0,
                "price_before_tax": 0,
                "website_price": 976,
                "air_conditioner_count": 5,
                "electricity_number_out": 3,
                "electricity_number_in": 0,
                "emptying_deed_number": 8,
                "deed_number": 3,
                "water_meter_number": 5,
                "view": "voluptate deserunt quis",
                "interface": "ea incididunt Excepteur tempor",
                "ac_type": "laboris",
                "board_type": "dolor",
                "tax_value": 2,
                "price_after_tax": 9,
                "name_full": "Bobby Gulgowski-Conroy",
                "project": {
                    "id": 5,
                    "name": "Unbranded Metal Soap",
                    "code": "H",
                    "status": "vis",
                    "type": "caecus",
                    "image": "https://aching-loyalty.us",
                    "start_work_date": "2024-05-31T18:28:16.439Z",
                    "end_work_date": "2024-09-04T13:00:59.020Z"
                },
                "building": {
                    "id": 4,
                    "name": "Brendan Kuphal",
                    "project_id": 0,
                    "type": "k",
                    "land_area": "ancilla",
                    "tax_value": 5,
                    "price_after_tax": 75
                },
                "sale": {
                    "id": 0,
                    "reason_for_pay_id": 8,
                    "project_id": 2,
                    "building_id": 3,
                    "unit_id": 3,
                    "tax_reference_number": 3,
                    "sale_type": "officia nulla",
                    "target_type": "fugiat do velit voluptate aliquip",
                    "status": "dolor sit in"
                },
                "activeBooking": {
                    "id": 8,
                    "unit_id": 4,
                    "building_id": 2,
                    "client_id": 8,
                    "booking_open_at": "2025-05-13T08:00:47.771Z",
                    "booking_expired_at": "2026-04-07T04:43:39.814Z",
                    "booking_open_at_text": "laborum consequat velit",
                    "booking_expired_at_text": "2025-04-23T18:17:38.729Z"
                },
                "nextBooking": {
                    "id": 1,
                    "unit_id": 0,
                    "building_id": 0,
                    "client_id": 2,
                    "booking_open_at": "2024-12-04T13:51:10.154Z",
                    "booking_expired_at": "2025-09-24T11:00:31.093Z",
                    "booking_open_at_text": "ea fugiat",
                    "booking_expired_at_text": "2025-04-23T11:02:33.202Z"
                },
                "client": {
                    "id": 0,
                    "name": "Johnnie Hansen",
                    "phone": "1-965-630-4445 x07339",
                    "email": "Hester11@hotmail.com"
                },
                "bookings_count": 0,
                "comments_count": 7,
                "sale_clients_count": 5,
                "clients_count": 0
            },
            {
                "id": 5,
                "building_id": 0,
                "project_id": 4,
                "is_for_rent": true,
                "name": "Luis Orn Sr.",
                "status": "ex enim non",
                "url_360": "https://meaty-thigh.us/",
                "floor": "culpa reprehenderit sit",
                "room_count": 0,
                "doc_unit_number": 9,
                "doc_number": 5,
                "area": "ex irure nulla laborum",
                "bathroom_count": 2,
                "is_furnished": true,
                "garage": "aliquip in",
                "tax_rate": 9,
                "price_before_tax": 9,
                "website_price": 491.85,
                "air_conditioner_count": 7,
                "electricity_number_out": 6,
                "electricity_number_in": 1,
                "emptying_deed_number": 0,
                "deed_number": 5,
                "water_meter_number": 6,
                "view": "ea commodo voluptate aute",
                "interface": "non",
                "ac_type": "sint consectetur",
                "board_type": "commodo tempor",
                "tax_value": 9,
                "price_after_tax": 7,
                "name_full": "Henrietta Trantow",
                "project": {
                    "id": 3,
                    "name": "Modern Soft Bacon",
                    "code": "9",
                    "status": "appello",
                    "type": "vitiosus",
                    "image": "https://gullible-slime.net",
                    "start_work_date": "2026-03-25T10:59:37.474Z",
                    "end_work_date": "2026-03-04T15:24:23.734Z"
                },
                "building": {
                    "id": 6,
                    "name": "Luther Gutkowski III",
                    "project_id": 3,
                    "type": "N",
                    "land_area": "pectus",
                    "tax_value": 0,
                    "price_after_tax": 906
                },
                "sale": {
                    "id": 7,
                    "reason_for_pay_id": 8,
                    "project_id": 8,
                    "building_id": 0,
                    "unit_id": 1,
                    "tax_reference_number": 7,
                    "sale_type": "eiusmod cupidatat sint dolor",
                    "target_type": "elit sit",
                    "status": "Ut quis adipisicing in consectetur"
                },
                "activeBooking": {
                    "id": 8,
                    "unit_id": 7,
                    "building_id": 5,
                    "client_id": 3,
                    "booking_open_at": "2024-11-24T12:49:13.830Z",
                    "booking_expired_at": "2024-10-13T18:30:37.655Z",
                    "booking_open_at_text": "irure",
                    "booking_expired_at_text": "2025-04-23T19:24:09.316Z"
                },
                "nextBooking": {
                    "id": 1,
                    "unit_id": 4,
                    "building_id": 6,
                    "client_id": 7,
                    "booking_open_at": "2025-05-14T09:30:21.861Z",
                    "booking_expired_at": "2024-12-14T06:39:19.286Z",
                    "booking_open_at_text": "exercitation",
                    "booking_expired_at_text": "2025-04-23T22:25:22.755Z"
                },
                "client": {
                    "id": 6,
                    "name": "Virginia Maggio",
                    "phone": "421-596-4383 x810",
                    "email": "Ellsworth62@gmail.com"
                },
                "bookings_count": 7,
                "comments_count": 8,
                "sale_clients_count": 5,
                "clients_count": 1
            }
        ],
        "links": {
            "first": "http://estate.test/api/v1/system/units?page=1",
            "last": "http://estate.test/api/v1/system/units?page=1",
            "prev": null,
            "next": null
        },
        "meta": {
            "current_page": 1,
            "from": null,
            "last_page": 1,
            "links": [
                {
                    "url": null,
                    "label": "pagination.previous",
                    "active": false
                },
                {
                    "url": "http://estate.test/api/v1/system/units?page=1",
                    "label": "1",
                    "active": true
                },
                {
                    "url": null,
                    "label": "pagination.next",
                    "active": false
                }
            ],
            "path": "http://estate.test/api/v1/system/units",
            "per_page": 10,
            "to": null,
            "total": 0
        }
    }
}

Request

Query Params

string

optional

Example:

uni

projects_ids[]

string

optional

Example:

building_ids[]

string

optional

Example:

unit_ids[]

string

optional

Example:

3,4

status

string

optional

Example:

booked

project_status

string

optional

Example:

under_sale

sale_type

string

optional

Example:

for_rent

emptying_status

string

optional

Example:

in_emptying

orbon_status

string

optional

Example:

with_orbon

client_id

string

optional

Example:

contract_file_upload_date

string

optional

Example:

2025-04-08

tax_free_status

string

optional

Example:

free

purchase_method

string

optional

Example:

cash

completed_at

string

optional

Example:

2025-04-10

created_at

string

optional

Example:

2025-04-06

reason_for_pay_id

string

optional

Example:

receiving_status

string

optional

Example:

not_receiving

garage

string

optional

Example:

out

board_type

string

optional

Example:

majlis_attached_to_the_hall

ac_type

string

optional

Example:

hidden_split

interface

string

optional

Example:

front_side

view

string

optional

Example:

garden_view

floor

string

optional

Example:

Header Params

x-api-key

string

optional

Example:

x-secret-key

string

optional

Example:

Responses

🟢200Success

application/json

Body

status

string

required

message

string

required

response

object

required

data

array [object {41}]

required

Modified at 2025-04-15 23:04:31

show

show units by project