---
title: "List Realms for a Tenant"
method: GET
path: "/v1/tenants/{tenant_id}/realms"
tags: ["Realms"]
---

# List Realms for a Tenant

`GET /v1/tenants/{tenant_id}/realms`

## Request

- Base URL: `https://api-us.beyondidentity.com`
- URL: `https://api-us.beyondidentity.com/v1/tenants/{tenant_id}/realms`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/docs/v1/tenants/:tenant_id/realms/get.ts> (a function with typed inputs; its response is checked against the schema)

To list all realms for a tenant, send a GET request to
`/v1/tenants/$TENANT_ID/realms`.

The response will contain at most 200 items and may contain a page token to
query the remaining items. If page size is not specified, the response will
contain 20 items. There is no defined ordering of the list of realms in the
response. Note that the maximum and default page sizes are subject to
change.

When paginating, the page size is maintained by the page token but may be
overridden on subsequent requests. The skip is not maintained by the page
token and must be specified on each subsequent request.

Page tokens expire after one week. Requests which specify an expired page
token will result in undefined behavior.

## Path parameters

- `tenant_id` string, required

## Query parameters

- `page_size` integer
- `page_token` string
- `skip` integer

## Response `200`

The response will be a JSON object with keys for `realms` and `total_size`. `realms` will be set to an array of realm objects, each of which contain the standard realm attributes. `total_size` will be set to the total number of items matched by the list request. If there are more items to be returned by the requested query, the response will also contain a key called `next_page_token`.

- ListRealmsResponse: Response for ListRealms.
  - `realms` Realm[], required: An unordered array of realms corresponding to the request.
    - `id` string: A unique identifier for the realm. This is automatically generated on creation. This field is immutable and read-only. This field is unique within the tenant.
    - `tenant_id` string: A unique identifier of the realm's tenant. This is automatically set on creation. This field is immutable and read-only.
    - `display_name` string: A human-readable name for the realm. This name is used for display purposes.
    - `classification` string: Classification of the realm. Can be either SECURE_WORFORCE or SECURE_CUSTOMER
    - `create_time` string, date-time: A time value given in ISO8601 combined date and time format that represents when the realm was created. This is automatically generated on creation. This field is read-only.
    - `update_time` string, date-time: A time value given in ISO8601 combined date and time format that represents when the realm was last updated. This is automatically updated when the realm is updated. This field is read-only.
  - `total_size` integer, required: Total number of results returned by the operation. This value may be larger than the number of resources returned, such as when returning a single page where multiple pages are available.
  - `next_page_token` string: Token used to fetch the next set of results. If this field is omitted, there are no subsequent pages.

## Other responses

- `400`: Bad request.
- `401`: Unauthorized.
- `403`: Forbidden.
- `500`: Server error.

---

[API](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api.md) - [All operations](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/revisions/42f3cac49392?raw)