E-State

units client

Developing

GET

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'http://estate.test/api/v1/client/units/client?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": "true",
    "message": "Operation completed successfully",
    "data": [
        {
            "id": 2,
            "building_id": 3,
            "project_id": 9,
            "is_for_rent": false,
            "name": "Christy Greenfelder",
            "status": "elit do tempor",
            "url_360": "https://far-thigh.name/",
            "floor": "mollit ex exercitation",
            "room_count": 4,
            "doc_unit_number": 4,
            "doc_number": 2,
            "area": "ea",
            "bathroom_count": 0,
            "is_furnished": false,
            "garage": "quis",
            "tax_rate": 2,
            "price_before_tax": 6,
            "website_price": 646.29,
            "air_conditioner_count": 8,
            "electricity_number_out": 1,
            "electricity_number_in": 4,
            "emptying_deed_number": 6,
            "deed_number": 1,
            "water_meter_number": 2,
            "view": "in nostrud amet dolor irure",
            "interface": "nulla",
            "ac_type": "tempor",
            "board_type": "occaecat Lorem cupidatat id velit",
            "tax_value": 0,
            "price_after_tax": 6,
            "name_full": "Jana Runolfsdottir",
            "project": {
                "id": 9,
                "name": "Handmade Rubber Ball",
                "code": "z",
                "status": "traho",
                "type": "custodia",
                "image": "https://profuse-cope.name",
                "start_work_date": "2025-03-20T14:53:37.414Z",
                "end_work_date": "2024-05-12T00:49:19.224Z"
            },
            "building": {
                "id": 2,
                "name": "Patrick Strosin",
                "project_id": 8,
                "type": "T",
                "land_area": "canonicus",
                "tax_value": 0,
                "price_after_tax": 370
            },
            "sale": {
                "id": 2,
                "reason_for_pay_id": 0,
                "project_id": 6,
                "building_id": 7,
                "unit_id": 6,
                "tax_reference_number": 2,
                "sale_type": "qui laborum pariatur aliquip",
                "target_type": "qui culpa consectetur anim",
                "status": "nostrud aliquip"
            },
            "activeBooking": {
                "id": 5,
                "unit_id": 3,
                "building_id": 3,
                "client_id": 9,
                "booking_open_at": "2025-12-06T06:21:33.611Z",
                "booking_expired_at": "2024-05-17T21:15:50.375Z",
                "booking_open_at_text": "sunt incididunt nulla",
                "booking_expired_at_text": "2025-04-18T10:30:20.993Z"
            },
            "nextBooking": {
                "id": 6,
                "unit_id": 6,
                "building_id": 3,
                "client_id": 4,
                "booking_open_at": "2025-09-19T20:52:40.479Z",
                "booking_expired_at": "2025-02-06T11:25:36.172Z",
                "booking_open_at_text": "et veniam consequat do amet",
                "booking_expired_at_text": "2025-04-18T10:21:19.563Z"
            },
            "client": {
                "id": 5,
                "name": "Dr. Juan Medhurst",
                "phone": "1-300-703-7337 x5721",
                "email": "Tillman75@gmail.com"
            },
            "bookings_count": 0,
            "comments_count": 5,
            "sale_clients_count": 4,
            "clients_count": 0,
            "bookings": [
                {
                    "id": 3,
                    "unit_id": 7,
                    "building_id": 8,
                    "client_id": 2,
                    "booking_open_at": "2026-03-01T07:15:47.849Z",
                    "booking_expired_at": "2025-02-01T09:05:48.496Z",
                    "booking_open_at_text": "dolor eu",
                    "booking_expired_at_text": "2025-04-18T03:09:29.407Z"
                }
            ],
            "comments": [
                {
                    "id": 0,
                    "model_id": 2,
                    "model_type": "A4",
                    "comment": "Vaco bene sustineo contabesco bene arbustum deputo sono theologus defungo."
                }
            ],
            "saleClients": [
                {
                    "id": 5,
                    "sale_id": 1,
                    "client_id": 9,
                    "unit_id": 7
                }
            ],
            "clients": [
                {
                    "id": 2,
                    "name": "Christy Beer Jr.",
                    "phone": "(785) 514-9016 x5955",
                    "email": "Javon_Jast58@gmail.com"
                }
            ]
        }
    ]
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

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

data

array[object (Unit) {45}]

required

number

required

building_id

number

required

project_id

number

required

is_for_rent

boolean

optional

name

string

required

status

string

required

url_360

string

optional

floor

string

optional

room_count

number

required

doc_unit_number

number

optional

doc_number

number

optional

area

string

required

bathroom_count

number

optional

is_furnished

boolean

optional

garage

string

optional

tax_rate

number

optional

price_before_tax

number

optional

website_price

number

optional

air_conditioner_count

number

optional

electricity_number_out

number

optional

electricity_number_in

number

optional

emptying_deed_number

number

optional

deed_number

number

optional

water_meter_number

number

optional

view

string

optional

interface

string

optional

ac_type

string

optional

board_type

string

optional

tax_value

number

optional

price_after_tax

number

optional

name_full

string

required

project

object (Project Simple)

required

building

object (Building Simple)

required

sale

object (Sale Simple)

required

activeBooking

object (Booking Simple)

required

nextBooking

object (Booking Simple)

required

client

object (Client Simple)

required

bookings_count

number

required

comments_count

number

required

sale_clients_count

number

required

clients_count

number

required

bookings

array[object (Booking Simple) {8}]

required

comments

array[object (Comment) {4}]

required

saleClients

array[object (SaleClient) {4}]

required

clients

array[object (Client Simple) {4}]

required

Modified at 2025-04-16 00:07:55

show

index