> ## Documentation Index
> Fetch the complete documentation index at: https://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 api identities list-identities

> List the identities in your workspace one page at a time.

<Note>
  You need a root key with the permissions listed on this page. Create one in the dashboard under **Settings > Root Keys**. See [Permission reference](/docs/platform/root-keys/permissions-legacy) for every permission.
</Note>

List identities. Results come in pages. Pass the `cursor` from one response to get the next page. Calls `POST /v2/identities.listIdentities`. See [Identities](/docs/api-management/identities/overview).

## Usage

```bash theme={"system"}
unkey api identities list-identities [flags]
```

## Flags

<ParamField body="--cursor" type="string">
  Cursor from the previous response.
</ParamField>

<ParamField body="--limit" type="integer">
  Maximum number of identities per page. 1 to 100. Defaults to 100.
</ParamField>

<ParamField body="--search" type="string">
  Return only identities whose id or external id contains this text. Not case-sensitive. Up to 256 characters.
</ParamField>

### Shared flags

Every `unkey api` command takes these. See [CLI output and shared flags](/docs/platform/cli/output-and-flags).

<ParamField body="--root-key" type="string">
  Root key used for the request. Falls back to `UNKEY_ROOT_KEY`, then to the key stored by `unkey auth login`.
</ParamField>

<ParamField body="--api-url" type="string" default="https://api.unkey.com">
  Base URL of the API. Falls back to `UNKEY_API_BASE_URL`. You don't normally need to set it.
</ParamField>

<ParamField body="--config" type="string" default="~/.unkey/config.toml">
  Path of the config file written by `unkey auth login`. Falls back to `UNKEY_CONFIG`.
</ParamField>

<ParamField body="--output" type="string">
  Output format. Falls back to `UNKEY_OUTPUT`. `json` prints the full response. Any other value prints the request ID and `data`.
</ParamField>

<ParamField body="--body" type="string">
  Send this JSON as the whole request body instead of using the command's flags. You can't combine it with them.
</ParamField>

## Required permissions

`identity.*.read_identity`. A root key with only `identity.<identityId>.read_identity` fails as soon as the page includes any other identity. See [Root key permissions](/docs/platform/root-keys/permissions).

## Examples

```bash First page theme={"system"}
unkey api identities list-identities --limit=50
```

```bash Search theme={"system"}
unkey api identities list-identities --search=user_123
```

Or send the whole request as JSON:

```bash Raw body theme={"system"}
unkey api identities list-identities --body='{"limit":50,"search":"user_"}'
```