# List 'Apartment' Endpoint: GET /objects/spaces/spaces/apartment/list/ Version: 2.0.0 Security: customer_id, application_id, service_id, service_version_id, client_ct, client_object_id, client_secret ## Query parameters: - `_jsonl` (boolean) - `_order_by` (array) - `_page` (integer) - `_page_size` (integer) - `_search` (string) - `_slim` (boolean) - `_statistics` (boolean) - `customer_columns` (array) - `global_realestates` (array) - `global_segments` (array) - `has_active_listing` (any) - `landlords` (array) - `tags` (array) - `tags!` (array) - `tenants` (array) - `address` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` - `apartment_id` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `contains`, Supports negation (via `!`): `True` Operator: `endswith`, Supports negation (via `!`): `True` Operator: `icontains`, Supports negation (via `!`): `True` Operator: `iendswith`, Supports negation (via `!`): `True` Operator: `iexact`, Supports negation (via `!`): `True` Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` Operator: `istartswith`, Supports negation (via `!`): `True` Operator: `startswith`, Supports negation (via `!`): `True` - `archived` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` - `bi_area` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `gt`, Supports negation (via `!`): `True` Operator: `gte`, Supports negation (via `!`): `True` Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` Operator: `lt`, Supports negation (via `!`): `True` Operator: `lte`, Supports negation (via `!`): `True` - `bi_tenants` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` - `building` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` - `category` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `contains`, Supports negation (via `!`): `True` Operator: `endswith`, Supports negation (via `!`): `True` Operator: `icontains`, Supports negation (via `!`): `True` Operator: `iendswith`, Supports negation (via `!`): `True` Operator: `iexact`, Supports negation (via `!`): `True` Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` Operator: `istartswith`, Supports negation (via `!`): `True` Operator: `startswith`, Supports negation (via `!`): `True` - `created_at` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `gt`, Supports negation (via `!`): `True` Operator: `gte`, Supports negation (via `!`): `True` Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` Operator: `lt`, Supports negation (via `!`): `True` Operator: `lte`, Supports negation (via `!`): `True` - `custom_dimension_value` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `contains`, Supports negation (via `!`): `True` Operator: `endswith`, Supports negation (via `!`): `True` Operator: `icontains`, Supports negation (via `!`): `True` Operator: `iendswith`, Supports negation (via `!`): `True` Operator: `iexact`, Supports negation (via `!`): `True` Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` Operator: `istartswith`, Supports negation (via `!`): `True` Operator: `startswith`, Supports negation (via `!`): `True` - `custom_id` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `contains`, Supports negation (via `!`): `True` Operator: `endswith`, Supports negation (via `!`): `True` Operator: `icontains`, Supports negation (via `!`): `True` Operator: `iendswith`, Supports negation (via `!`): `True` Operator: `iexact`, Supports negation (via `!`): `True` Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` Operator: `istartswith`, Supports negation (via `!`): `True` Operator: `startswith`, Supports negation (via `!`): `True` - `financial_handler` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` - `floors` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `contains`, Supports negation (via `!`): `True` Operator: `empty`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` - `future_contracting` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `gt`, Supports negation (via `!`): `True` Operator: `gte`, Supports negation (via `!`): `True` Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` Operator: `lt`, Supports negation (via `!`): `True` Operator: `lte`, Supports negation (via `!`): `True` - `has_base_rent_vat` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` - `id` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` - `landlord_custom_id` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `contains`, Supports negation (via `!`): `True` Operator: `endswith`, Supports negation (via `!`): `True` Operator: `icontains`, Supports negation (via `!`): `True` Operator: `iendswith`, Supports negation (via `!`): `True` Operator: `iexact`, Supports negation (via `!`): `True` Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` Operator: `istartswith`, Supports negation (via `!`): `True` Operator: `startswith`, Supports negation (via `!`): `True` - `market_apartment__balcony` (any) - `market_apartment__balcony_orientation` (any) - `market_apartment__bathtub_status` (any) - `market_apartment__created_at` (any) - `market_apartment__custom_id` (any) - `market_apartment__default_requirement_profile` (any) - `market_apartment__dishwasher_status` (any) - `market_apartment__garage` (any) - `market_apartment__handicap_adapted` (any) - `market_apartment__has_bike_room` (any) - `market_apartment__has_common_room` (any) - `market_apartment__has_elevator` (any) - `market_apartment__has_gym` (any) - `market_apartment__has_private_patio` (any) - `market_apartment__has_security_door` (any) - `market_apartment__has_shared_laundry_room` (any) - `market_apartment__has_shared_patio` (any) - `market_apartment__has_shared_sauna` (any) - `market_apartment__has_shared_toilet` (any) - `market_apartment__has_waste_disposal_room` (any) - `market_apartment__is_investment_support_apartment` (any) - `market_apartment__isnull` (any) - `market_apartment__kitchen_fan_status` (any) - `market_apartment__kitchen_type` (any) - `market_apartment__listing_description` (any) - `market_apartment__organization` (any) - `market_apartment__parking_spot` (any) - `market_apartment__patio_orientation` (any) - `market_apartment__shower_type` (any) - `market_apartment__terms` (any) - `market_apartment__tumbler_status` (any) - `market_apartment__washing_machine_status` (any) - `organization` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` - `popular_name` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `contains`, Supports negation (via `!`): `True` Operator: `endswith`, Supports negation (via `!`): `True` Operator: `icontains`, Supports negation (via `!`): `True` Operator: `iendswith`, Supports negation (via `!`): `True` Operator: `iexact`, Supports negation (via `!`): `True` Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` Operator: `istartswith`, Supports negation (via `!`): `True` Operator: `startswith`, Supports negation (via `!`): `True` - `revenue_increase_created_at__lte` (any) - `revenue_increase_not_created__gte` (any) - `status` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `gt`, Supports negation (via `!`): `True` Operator: `gte`, Supports negation (via `!`): `True` Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` Operator: `lt`, Supports negation (via `!`): `True` Operator: `lte`, Supports negation (via `!`): `True` - `subtenant_connection_stakeholder_type__in` (array) - `subtenant_connection_status__in` (array) - `tempered_area` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `gt`, Supports negation (via `!`): `True` Operator: `gte`, Supports negation (via `!`): `True` Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` Operator: `lt`, Supports negation (via `!`): `True` Operator: `lte`, Supports negation (via `!`): `True` - `tenant` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` - `terms` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` - `usable_area` (any) Filter can be negated by adding a `!` to the end of the parameter name. **Additional operators:** Operator: `gt`, Supports negation (via `!`): `True` Operator: `gte`, Supports negation (via `!`): `True` Operator: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` Operator: `lt`, Supports negation (via `!`): `True` Operator: `lte`, Supports negation (via `!`): `True` ## Response 200 fields (application/json): - `tenant` (object) - `tenant.id` (string) - `bi_area` (number) - `category` (string) **Additional Validation Information:** Enum Descriptions: * `PX_1_ROK` - Px 1 Rok * `PX_1_5_ROK` - Px 1 5 Rok * `PX_2_ROK` - Px 2 Rok * `PX_2_5_ROK` - Px 2 5 Rok * `PX_3_ROK` - Px 3 Rok * `PX_3_5_ROK` - Px 3 5 Rok * `PX_4_ROK` - Px 4 Rok * `PX_4_5_ROK` - Px 4 5 Rok * `PX_5_ROK` - Px 5 Rok * `PX_5_5_ROK` - Px 5 5 Rok * `PX_6_ROK` - Px 6 Rok * `PX_6_5_ROK` - Px 6 5 Rok * `PX_7_ROK` - Px 7 Rok * `PX_7_5_ROK` - Px 7 5 Rok * `PX_8_ROK` - Px 8 Rok * `PX_8_5_ROK` - Px 8 5 Rok * `PX_9_ROK` - Px 9 Rok * `PX_9_5_ROK` - Px 9 5 Rok * `PX_10_ROK` - Px 10 Rok * `PX_10_5_ROK` - Px 10 5 Rok * `PX_11_ROK` - Px 11 Rok * `PX_11_5_ROK` - Px 11 5 Rok * `PX_12_ROK` - Px 12 Rok * `PX_12_5_ROK` - Px 12 5 Rok * `PX_13_ROK` - Px 13 Rok * `PX_13_5_ROK` - Px 13 5 Rok * `PX_14_ROK` - Px 14 Rok * `PX_14_5_ROK` - Px 14 5 Rok * `PX_15_ROK` - Px 15 Rok * `PX_15_5_ROK` - Px 15 5 Rok * `PX_16_ROK` - Px 16 Rok * `PX_16_5_ROK` - Px 16 5 Rok * `PX_1_ROKV` - Px 1 Rokv * `PX_1_5_ROKV` - Px 1 5 Rokv * `PX_2_ROKV` - Px 2 Rokv * `PX_2_5_ROKV` - Px 2 5 Rokv * `PX_3_ROKV` - Px 3 Rokv * `PX_3_5_ROKV` - Px 3 5 Rokv * `PX_4_ROKV` - Px 4 Rokv * `PX_4_5_ROKV` - Px 4 5 Rokv * `PX_5_ROKV` - Px 5 Rokv * `PX_1_PENTRY` - Px 1 Pentry * `PX_1_5_PENTRY` - Px 1 5 Pentry * `PX_2_PENTRY` - Px 2 Pentry * `PX_2_5_PENTRY` - Px 2 5 Pentry * `PX_3_PENTRY` - Px 3 Pentry * `PX_1_RO` - Px 1 Ro * `PX_1_5_RO` - Px 1 5 Ro * `PX_2_RO` - Px 2 Ro * `PX_2_5_RO` - Px 2 5 Ro * `PX_3_RO` - Px 3 Ro * `PX_1_ROS` - Px 1 Ros * `PX_1_5_ROS` - Px 1 5 Ros * `PX_2_ROS` - Px 2 Ros * `PX_2_5_ROS` - Px 2 5 Ros * `PX_3_ROS` - Px 3 Ros Enum: "PX_1_ROK", "PX_1_5_ROK", "PX_2_ROK", "PX_2_5_ROK", "PX_3_ROK", "PX_3_5_ROK", "PX_4_ROK", "PX_4_5_ROK", "PX_5_ROK", "PX_5_5_ROK", "PX_6_ROK", "PX_6_5_ROK", "PX_7_ROK", "PX_7_5_ROK", "PX_8_ROK", "PX_8_5_ROK", "PX_9_ROK", "PX_9_5_ROK", "PX_10_ROK", "PX_10_5_ROK", "PX_11_ROK", "PX_11_5_ROK", "PX_12_ROK", "PX_12_5_ROK", "PX_13_ROK", "PX_13_5_ROK", "PX_14_ROK", "PX_14_5_ROK", "PX_15_ROK", "PX_15_5_ROK", "PX_16_ROK", "PX_16_5_ROK", "PX_1_ROKV", "PX_1_5_ROKV", "PX_2_ROKV", "PX_2_5_ROKV", "PX_3_ROKV", "PX_3_5_ROKV", "PX_4_ROKV", "PX_4_5_ROKV", "PX_5_ROKV", "PX_1_PENTRY", "PX_1_5_PENTRY", "PX_2_PENTRY", "PX_2_5_PENTRY", "PX_3_PENTRY", "PX_1_RO", "PX_1_5_RO", "PX_2_RO", "PX_2_5_RO", "PX_3_RO", "PX_1_ROS", "PX_1_5_ROS", "PX_2_ROS", "PX_2_5_ROS", "PX_3_ROS" - `tempered_area` (number) - `has_base_rent_vat` (boolean) - `customer_columns` (any) - `pending_monitor_approval_amount` (any) - `address` (object) - `address.id` (string) - `custom_id` (string) - `usable_area` (number) - `landlord_custom_id` (string) - `financial_handler` (object) - `financial_handler.id` (string) - `archived` (boolean) - `bi_tenants` (array) - `bi_tenants.id` (string) - `tags` (any) - `custom_dimension_value` (string) - `created_at` (string) - `market_apartment` (any) - `future_contracting` (integer, required) **Additional Validation Information:** Enum Descriptions: * `0` - Uncontracted * `1` - Drafted * `2` - Unsigned * `3` - Signed Enum: 0, 1, 2, 3 - `status` (integer, required) **Additional Validation Information:** Enum Descriptions: * `0` - Active * `1` - Active Further * `2` - Active Definite End * `3` - Cancelled Pending Negotiation * `4` - Cancelled Pending * `5` - Cancelled Negotiation * `6` - Cancelled * `7` - Owner Warning * `8` - Counterpart Warning * `9` - Upcoming * `10` - Not Signed * `11` - Inactive Cancellation Not Signed * `12` - Inactive Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 - `organization` (object) - `organization.id` (string) - `id` (string, required) **Additional Validation Information:** Must be unique - `floors` (array) - `popular_name` (string) - `apartment_id` (string) - `building` (object, required) - `building.id` (string)