Get Flat

GET 
/v1/open-api/flat/:id

Get a single apartment by ID (scoped to the token's company), with its building, house, terrace, currency and address.

Note: an unknown ID answers 409 Conflict (FLAT_NOT_FOUND), not 404.

Requires grant PERMISSION_OPEN_API_CONTRACT:READ.

Request

Responses

200

The apartment.

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).

409

Apartment not found (FLAT_NOT_FOUND) — this endpoint answers 409, not 404.

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.