> ## Documentation Index > Fetch the complete documentation index at: https://www.bloxs.io/llms.txt > Use this file to discover all available pages before exploring further. # Get units filtered and paged > Get a paged list of existing units, optionally filtered to the given parameters. A param-based alternative to the '/filter' POST endpoint. ## OpenAPI ````json GET /api/v1/realestateobjects/units/filter { "openapi": "3.0.4", "info": { "title": "RealEstateObjects V1", "description": "Welcome to BETA version of the new RealEstateObjects API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.", "version": "v1" }, "security": [ {} ], "tags": [ { "name": "Admin" }, { "name": "Buildings" }, { "name": "Complexes" }, { "name": "Generic" }, { "name": "Metadata" }, { "name": "PublishObjects" }, { "name": "ScoringPointTotals" }, { "name": "Sections" }, { "name": "Units" } ], "paths": { "/api/v1/realestateobjects/units/filter": { "get": { "tags": [ "Units" ], "summary": "Get units filtered and paged", "description": "Get a paged list of existing units, optionally filtered to the given parameters. A param-based alternative to the '/filter' POST endpoint.", "operationId": "GetUnitsFilteredPaged_Alt", "parameters": [ { "name": "pageSize", "in": "query", "description": "The requested page size. Defaults to 100 when not given.", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The requested page number. Defaults to 1 when not given.", "schema": { "maximum": 9999, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "Optional filter on the name of the unit.", "schema": { "type": "string" } }, { "name": "reference", "in": "query", "description": "Optional filter on the reference of the unit.", "schema": { "type": "string" } }, { "name": "externalIdentifier", "in": "query", "description": "Optional filter on the external API identifier of the unit.", "schema": { "type": "string" } }, { "name": "complexReference", "in": "query", "description": "Optional filter on the reference of the complex the unit belongs to.", "schema": { "type": "string" } }, { "name": "sectionReference", "in": "query", "description": "Optional filter on the reference of the section the unit belongs to.", "schema": { "type": "string" } }, { "name": "ownerReference", "in": "query", "description": "Optional filter on the reference of the owner of the unit.", "schema": { "type": "string" } }, { "name": "estateAgentReference", "in": "query", "description": "Optional filter on the reference of the estate agent of the unit.", "schema": { "type": "string" } }, { "name": "addressStreetAndHouseNumber", "in": "query", "description": "Optional filter on the street and house number of the address of the unit.", "schema": { "type": "string" } }, { "name": "addressPostalCode", "in": "query", "description": "Optional filter on the postal code of the address of the unit.", "schema": { "type": "string" } }, { "name": "addressCity", "in": "query", "description": "Optional filter on the city of the address of the unit.", "schema": { "type": "string" } }, { "name": "addressCountryISOCode", "in": "query", "description": "Optional filter on the country ISO code of the address of the unit.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitSearchResult" } } } } }, "x-d360-narrative-url": "

Get units filtered and paged

This endpoint returns a paged list of existing units, optionally filtered by the given query parameters.

Integrators use it to display or synchronize multiple units at once, for example when populating a list view in an external application, rather than retrieving units one at a time.

Request Fields

Field

Type

Required

Description

pageSize

integer

No

Maximum number of units to return per page. Defaults to 100 when not given. Minimum 1, maximum 1000.

pageNumber

integer

No

Page number to retrieve. Defaults to 1 when not given. Minimum 1, maximum 9999.

name

string

No

Filters results on the name of the unit.

reference

string

No

Filters results on the internal identifier of the unit.

externalIdentifier

string

No

Filters results on the external identifier of the unit.

complexReference

string

No

Filters results on the reference of the complex the unit belongs to.

sectionReference

string

No

Filters results on the reference of the section the unit belongs to.

ownerReference

string

No

Filters results on the reference of the owner of the unit.

estateAgentReference

string

No

Filters results on the reference of the estate agent of the unit.

addressStreetAndHouseNumber

string

No

Filters results on the street and house number of the unit's address.

addressPostalCode

string

No

Filters results on the postal code of the unit's address.

addressCity

string

No

Filters results on the city of the unit's address.

addressCountryISOCode

string

No

Filters results on the country ISO code of the unit's address.

Response Fields

Field

Type

Required

Description

paging.pageSize

integer

No

Page size used for this result set. Minimum 1, maximum 1000.

paging.pageNumber

integer

No

Page number returned in this result set. Minimum 1, maximum 9999.

sorting.columnName

string

No

Field the results are sorted on.

sorting.order

integer

No

Sort direction for columnName. 0 is ascending, 1 is descending.

units

array of object

No

The list of units matching the filter, for the requested page. Empty or omitted when no units match.

units.name

string

No

Name of the unit.

units.reference

string

No

Internal identifier of the unit.

units.externalIdentifier

string

No

External identifier of the unit, as set by the integrating system.

units.complexReference

string

No

Reference of the complex the unit belongs to.

units.sectionReference

string

No

Reference of the section the unit belongs to, if applicable.

units.estateAgentReference

string

No

Reference of the estate agent associated with the unit.

units.addressStreetAndHouseNumber

string

No

Street and house number of the unit's address.

units.addressPostalCode

string

No

Postal code of the unit's address.

units.addressCity

string

No

City of the unit's address.

units.addressCountryISOCode

string

No

Country ISO code of the unit's address.

units.rawFloorArea

number (double)

No

Raw floor area of the unit, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

units.rentableFloorArea

number (double)

No

Rentable floor area of the unit, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

units.usableFloorArea

number (double)

No

Usable floor area of the unit, in square meters.

units.underManagementSince

string (date-time)

No

Date the unit came under management. ISO 8601 format.

units.salesDate

string (date-time)

No

Date the unit was sold, if applicable. ISO 8601 format.

units.lastModified

string (date-time)

Yes

Date and time the unit was last modified. ISO 8601 format, UTC.

" } } }, "components": { "schemas": { "UnitSearchResult": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/PagingInfo" }, "sorting": { "$ref": "#/components/schemas/SortingInfo" }, "units": { "type": "array", "items": { "$ref": "#/components/schemas/UnitSearchResultFilter" }, "nullable": true } }, "additionalProperties": false }, "PagingInfo": { "type": "object", "properties": { "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "pageNumber": { "maximum": 9999, "minimum": 1, "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SortingInfo": { "type": "object", "properties": { "columnName": { "type": "string", "nullable": true }, "order": { "type": "integer", "description": "Ascending = 0\nDescending = 1", "format": "int32", "x-enumNames": [ "Ascending", "Descending" ] } }, "additionalProperties": false }, "UnitSearchResultFilter": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "externalIdentifier": { "type": "string", "nullable": true }, "complexReference": { "type": "string", "nullable": true }, "sectionReference": { "type": "string", "nullable": true }, "estateAgentReference": { "type": "string", "nullable": true }, "addressStreetAndHouseNumber": { "type": "string", "nullable": true }, "addressPostalCode": { "type": "string", "nullable": true }, "addressCity": { "type": "string", "nullable": true }, "addressCountryISOCode": { "type": "string", "nullable": true }, "rawFloorArea": { "type": "number", "format": "double", "nullable": true }, "rentableFloorArea": { "type": "number", "format": "double", "nullable": true }, "usableFloorArea": { "type": "number", "format": "double", "nullable": true }, "underManagementSince": { "type": "string", "format": "date-time", "nullable": true }, "salesDate": { "type": "string", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "format": "date-time" } }, "additionalProperties": false } } } } ````