# IRPCFolderUISettings.GetFolderUISettings

Location: [gRPC API](https://developer.m-files.com/APIs/gRPC-API/index.md) > [Vault API](https://developer.m-files.com/APIs/gRPC-API/vault/index.md) > [Folder UI settings](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFolderUISettings/index.md)

HTML version: https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFolderUISettings/GetFolderUISettings/

Badges: `Vault API / standard` `read` `session` `idempotent` `returns metadata structure version`

Gets the display settings of a folder as an opaque blob.

- **Service:** [Folder UI settings](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFolderUISettings/index.md) `MFiles.IRPCFolderUISettings`
- **gRPC method:** `/MFiles.IRPCFolderUISettings/GetFolderUISettings`
- **HTTP (mf-http-grpc):** `POST /grpc/v1/get-folder-uisettings`
- **Request:** [`GetFolderUISettingsRequest`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFolderUISettings/GetFolderUISettings/index.md#request)
- **Response:** [`GetFolderUISettingsResponse`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFolderUISettings/GetFolderUISettings/index.md#response)
- **Book and level:** Vault API, standard
- **Kind:** read
- **Session:** Required: the session ID from LogIn in the mfiles-session-id-bin metadata.
- **Idempotent:** yes
- **Returns metadata structure version:** yes (in the mfiles-metadata-version-bin trailer)
- **Streaming:** none (unary)

<a id="remarks"></a>

## Remarks

- Requires a vault session. No special vault rights are needed.
- With `common_settings` false, returns the caller's own settings, falling back to the common
  settings and then to the program defaults (empty `data`). With true, returns the common
  settings or empty `data`.
- Returns the newest stored data version that is at most `max_data_version_interpretable`.

<a id="request"></a>

## Request: GetFolderUISettingsRequest

> Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

| Field | Type | Description |
|---|---|---|
| `common_settings` | `bool` | True for the common settings; false for the caller's effective settings. |
| `uisfid` | [`UISettingsFolderID`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.UISettingsFolderID/index.md) | The folder. |
| `uisfid.type` | [`UISettingsFolderType`](https://developer.m-files.com/APIs/gRPC-API/Reference/Enums/MFiles.UISettingsFolderType/index.md) | The type that describes the folder whose UI settings are being retrieved. |
| `uisfid.view` | `int32` | If not zero, specifies the view where the folder is located. |
| `max_data_version_interpretable` | `int32` | The newest data version that the caller understands. |

<a id="response"></a>

## Response: GetFolderUISettingsResponse

> Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

| Field | Type | Description |
|---|---|---|
| `data` | `bytes` | The settings blob, starting with its data version as a 32-bit little-endian integer; empty means the program defaults. |