Use read-only access. The exact set of entities depends on what you display.
Refer to the API Reference for full attribute and endpoint details.
| Entity | Access | Purpose |
|---|---|---|
| objects.realestate | read | Filtering; name, area metrics. |
| objects.building | read | Filtering; name, main address, area metrics. |
| common.address | read | Filtering by gate/door. |
| objects.apartment | read | Rentable/ownable spaces. |
| objects.industrialpremises | read | Rentable/ownable spaces. |
| objects.parkingspot | read | Can be in buildings. |
| objects.brfapartment | read | BRF apartments. |
| objects.commonarea | read | Common areas (optional). |
| accounts.tenant | read | Tenant information for display. |
| Entity | Access | Purpose |
|---|---|---|
| objects.community | read | Real estate may belong to a community. |
| objects.region | read | Community may belong to a region. |
| Entity | Access | Purpose |
|---|---|---|
| accounts.subtenant | read | Sub-tenant information. |
| accounts.subtenantcontractconnection | read | Sub-leasing link between contracts and sub-tenants. |
To show tenant names on screens, request access to personal information. Without it, you can still read accounts.tenant, but fields that may contain personal data will be hidden.