# List 'Room' Endpoint: GET /objects/rooms/room/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) - `tags` (array) - `tags!` (array) - `apartment` (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` - `brf_apartment` (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: `in`, Supports negation (via `!`): `True` Operator: `isnull`, Supports negation (via `!`): `True` - `common_area` (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` - `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_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` - `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` - `industrial_premises` (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` - `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` - `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` - `outdoor_section` (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` - `room_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` - `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): - `apartment` (object) **Additional Validation Information:** This value can't bet set, when any of the following fields are set: `industrial_premises`, `common_area`, `brf_apartment`, `outdoor_section` This field, or at least one of the following fields must be set: `industrial_premises`, `common_area`, `brf_apartment`, `outdoor_section` - `apartment.id` (string) - `created_at` (string) - `organization` (object) - `organization.id` (string) - `custom_id` (string) - `tags` (any) - `room_id` (string, required) - `category` (object) - `category.id` (string) - `common_area` (object) **Additional Validation Information:** This value can't bet set, when any of the following fields are set: `apartment`, `industrial_premises`, `brf_apartment`, `outdoor_section` This field, or at least one of the following fields must be set: `apartment`, `industrial_premises`, `brf_apartment`, `outdoor_section` - `common_area.id` (string) - `industrial_premises` (object) **Additional Validation Information:** This value can't bet set, when any of the following fields are set: `apartment`, `common_area`, `brf_apartment`, `outdoor_section` This field, or at least one of the following fields must be set: `apartment`, `common_area`, `brf_apartment`, `outdoor_section` - `industrial_premises.id` (string) - `bi_area` (number) - `id` (string, required) **Additional Validation Information:** Must be unique - `outdoor_section` (object) **Additional Validation Information:** This value can't bet set, when any of the following fields are set: `apartment`, `industrial_premises`, `common_area`, `brf_apartment` This field, or at least one of the following fields must be set: `apartment`, `industrial_premises`, `common_area`, `brf_apartment` - `outdoor_section.id` (string) - `brf_apartment` (object) **Additional Validation Information:** This value can't bet set, when any of the following fields are set: `apartment`, `industrial_premises`, `common_area`, `outdoor_section` This field, or at least one of the following fields must be set: `apartment`, `industrial_premises`, `common_area`, `outdoor_section` - `brf_apartment.id` (string) - `customer_columns` (any) - `usable_area` (number) - `name` (string)