List Flat Fields

GET 
/v1/open-api/flat-field

The company's apartment (flat) custom field definitions, with their options. Use it to interpret the fields array on an apartment and to build customFields conditions for POST /v1/open-api/flat/filter.

Requires grant PERMISSION_OPEN_API_CONTRACT:READ.

Responses

200

The company's flat custom fields.

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.