> ## Documentation Index
> Fetch the complete documentation index at: https://www.unkey.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Unkey is two separate products. Compute builds, deploys, and runs apps behind a gateway. API Management issues API keys, enforces rate limits, manages identities and permissions, and reports usage. Say which product a page belongs to; a reader can use either without the other.
> Every Unkey API endpoint is an HTTP POST to https://api.unkey.com/v2/{service}.{procedure} with a root key in the Authorization: Bearer header. Root keys are workspace scoped.
> Error codes have the form err:{system}:{category}:{specific} and each has a page at /errors/{system}/{category}/{specific}.
> The word environment means production or preview in Compute. Rate limiting has four meanings on this site; the glossary lists them.

# unkey workspace flags get

> Read your workspace's feature flags and their enabled states.

> [!NOTE]
>
> Create a root key with the permissions listed on this page under **Root Keys** in the dashboard sidebar. CLI commands can instead use a session from [unkey login](https://www.unkey.com/docs/platform/cli/login.md) with the required permissions. See [Permission reference](https://www.unkey.com/docs/platform/root-keys/permissions-legacy.md) for every permission.

Get feature flags for the workspace associated with your credentials.

Each flag is keyed by its slug and includes its current value, description,
and whether it can be enabled or disabled. A workspace-specific value takes
precedence over the flag's default. If no flags are available, `data` is an
empty object.

This command takes no request-building flags and does not accept `--body`.

## Usage

```bash theme={"system"}
unkey workspace flags get [flags]
```

## Flags

This command accepts only the shared flags below.

### Shared flags

These flags control authentication, requests, and output. [CLI output and shared flags](https://www.unkey.com/docs/platform/cli/output-and-flags.md) describes them in full.

**--root-key** `string`

Root key used for the request. Falls back to `UNKEY_ROOT_KEY`, then stored credentials, including a CLI session. See [CLI authentication](https://www.unkey.com/docs/platform/cli/authentication.md) for the full precedence order.

**--api-url** `string` (default: [https://api.unkey.com](https://api.unkey.com))

Base URL of the API. Falls back to `UNKEY_API_BASE_URL`. You don't normally need to set it.

**--config** `string` (default: \~/.unkey/config.toml)

Path of the TOML config file. Falls back to `UNKEY_CONFIG`. An explicit `--config` takes precedence over a stored CLI session. Browser login stores a session, not a root key in this file. See [CLI authentication](https://www.unkey.com/docs/platform/cli/authentication.md).

**--output** `enum` (default: human)

Use `human` (default) for name-first summary tables and labeled details, or `json` for the unchanged full response envelope, including all fields and pagination. Terminal tables use relative timestamps and may shorten display names and descriptions, but never identifiers, slugs, or credentials. Redirected human output keeps complete values and uses RFC3339 UTC timestamps. Falls back to `UNKEY_OUTPUT`; other values are rejected. `--json` also selects JSON output. Add `--debug` to print the request ID to stderr. See [Output formats](https://www.unkey.com/docs/platform/cli/output-and-flags.md#output-formats).

**--debug** `boolean`

Print the successful response's request ID to stderr, separate from stdout.

**--json** `boolean`

Print the full response as JSON. Takes precedence over a valid `--output` or `UNKEY_OUTPUT` value.

## Required permissions

Your root key must have the following permission:

* `unkey:v1:<workspace_id>:flags#read`

See [Root key permissions](https://www.unkey.com/docs/platform/root-keys/permissions.md).

## Examples

```bash theme={"system"}
unkey workspace flags get
```

## API endpoint

The command calls `POST /v2/workspace.getFlags` and prints its response. See the [endpoint definition](https://github.com/unkeyed/unkey/blob/main/svc/api/openapi/spec/paths/v2/workspace/getFlags/index.yaml) for the HTTP contract. The request has no body.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.