Get Houses

GET 
/v1/open-api/house/all

List the company's houses (residential projects) together with their buildings (blocks), ordered by house ID ascending. Deleted houses are never returned, and each house's buildings array carries only its non-deleted blocks, ordered by their display order.

These IDs are what the houseIds / buildingIds filters of POST /v1/open-api/contract/filter and POST /v1/open-api/flat/filter expect.

Requires grant PERMISSION_OPEN_API_CONTRACT:READ.

Request

Responses

200

The company's houses with their buildings.

401

Invalid, revoked or expired token (401) — also returned when the connection was revoked or the company is blocked.

Produced by the authentication filter, so the body is a reduced envelope: no error, no requestId, and errors is null rather than []. Every cause yields the same fixed English message.

403

The token lacks the required permission:scope grant (403).

429

Rate limit of 60 requests/minute exceeded (429). Like 401, this comes from the authentication filter: reduced envelope, fixed English message, no error object and no Retry-After header.