# IRPCWorkspace.GetWorkspaceSettings

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) > [Workspaces](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCWorkspace/index.md)

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

Badges: `Vault API / standard` `write` `session or assertion` `returns metadata structure version`

Gets the tab order of the workspace of an object type: the caller's effective order, or the
default for all users.

- **Service:** [Workspaces](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCWorkspace/index.md) `MFiles.IRPCWorkspace`
- **gRPC method:** `/MFiles.IRPCWorkspace/GetWorkspaceSettings`
- **HTTP (mf-http-grpc):** `POST /grpc/v1/get-workspace-settings`
- **Request:** [`GetWorkspaceSettingsRequest`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCWorkspace/GetWorkspaceSettings/index.md#request)
- **Response:** [`GetWorkspaceSettingsResponse`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCWorkspace/GetWorkspaceSettings/index.md#response)
- **Book and level:** Vault API, standard
- **Kind:** write
- **Session:** Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata).
- **Idempotent:** no
- **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.
- `WORKSPACE_SETTINGS_SCOPE_EFFECTIVE` (default) returns the caller's own order, or the default
  order when the caller has none. `WORKSPACE_SETTINGS_SCOPE_DEFAULTS` returns the default order,
  limited to common views.
- The stored order is reconciled with the tab views that exist and that the caller can see:
  views that no longer exist are dropped and new views are appended. When nothing is stored,
  `view_ids` lists all visible tab views.
- An object type without workspace views, or an unknown ID, returns empty `view_ids`.

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

## Request: GetWorkspaceSettingsRequest

> 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 |
|---|---|---|
| `object_type_id` | `int32` | The source object type of the workspace. |
| `scope` | [`WorkspaceSettingsScope`](https://developer.m-files.com/APIs/gRPC-API/Reference/Enums/MFiles.WorkspaceSettingsScope/index.md) | Which order to return. Leave unset (`WORKSPACE_SETTINGS_SCOPE_EFFECTIVE`) for the caller's own effective order. Values: `WORKSPACE_SETTINGS_SCOPE_EFFECTIVE` (0), `WORKSPACE_SETTINGS_SCOPE_DEFAULTS` (1). |

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

## Response: GetWorkspaceSettingsResponse

> 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 |
|---|---|---|
| `workspace_settings` | [`WorkspaceSettings`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.WorkspaceSettings/index.md) | The tab view IDs in display order. |
| `workspace_settings.view_ids[]` | repeated `int32` | View IDs in order. |