# List

Launch stage: Public Preview

`GET /api/2.1/settings-metadata`

List valid setting keys and metadata. These settings are available to be referenced via
 GET `settingsv2/getpublicworkspacesetting` and
 PATCH `settingsv2/patchpublicworkspacesetting` APIs

API scopes: settings

## Query parameters

- `page_size` (int32, optional)
  The maximum number of settings to return. The service may return fewer than this value.
   If unspecified, at most 200 settings will be returned.
   The maximum value is 1000; values above 1000 will be coerced to 1000.
- `page_token` (string, optional)
  A page token, received from a previous `ListWorkspaceSettingsMetadataRequest` call.
   Provide this to retrieve the subsequent page.
  
   When paginating, all other parameters provided to `ListWorkspaceSettingsMetadataRequest` must match
   the call that provided the page token.

## Returns

Returns a list of SettingsMetadata objects.

## Response

```json
{
  "settings_metadata": [
    {
      "name": "string",
      "description": "string",
      "type": "string",
      "docs_link": "string",
      "preview_phase": "string",
      "display_name": "string"
    }
  ],
  "next_page_token": "string"
}
```