---
title: "GET /workspaces"
method: GET
path: "/workspaces"
---

# GET /workspaces

`GET /workspaces`

Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_DescribeWorkspace.html">DescribeWorkspace</a>.

## Query parameters

- `maxResults` integer
- `nextToken` string

## Response `200`

Success

- ListWorkspacesResponse
  - `workspaces` WorkspaceSummary[], required — An array of structures that contain some information about the workspaces in the account.
    - `created` string, date-time, required — The date that the workspace was created.
    - `description` string, password — The customer-entered description of the workspace.
    - `endpoint` string, required — The URL endpoint to use to access the Grafana console in the workspace.
    - `grafanaVersion` string, required — The Grafana version that the workspace is running.
    - `id` string, required — The unique ID of the workspace.
    - `modified` string, date-time, required — The most recent date that the workspace was modified.
    - `name` string, password — The name of the workspace.
    - `notificationDestinations` NotificationDestinationType[] — The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.
    - `status` 'ACTIVE' | 'CREATING' | 'DELETING' | 'FAILED' | 'UPDATING' | 'UPGRADING' | 'DELETION_FAILED' | 'CREATION_FAILED' | 'UPDATE_FAILED' | 'UPGRADE_FAILED' | 'LICENSE_REMOVAL_FAILED' | 'VERSION_UPDATING' | 'VERSION_UPDATE_FAILED' | 'DEGRADED', required — The current status of the workspace.
    - `authentication` object, required — A structure containing information about the authentication methods used in the workspace.
      - `providers` AuthenticationProviderTypes[], required — Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
      - `samlConfigurationStatus` 'CONFIGURED' | 'NOT_CONFIGURED' — Specifies whether the workplace's user authentication method is fully configured.
    - `tags` object — The list of tags associated with the workspace.
    - `licenseType` 'ENTERPRISE' | 'ENTERPRISE_FREE_TRIAL' — <p>Specifies whether this workspace has a full Grafana Enterprise license.</p> <note> <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p> </note>
    - `grafanaToken` string — The token that ties this workspace to a Grafana Labs account. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise">Link your account with Grafana Labs</a>.
  - `nextToken` string — The token to use when requesting the next set of workspaces.

## Other responses

- `480` — ThrottlingException
- `481` — AccessDeniedException
- `482` — InternalServerException

---

[API](https://skmtc.net/aws/apis/grafana.md) · [All operations](https://skmtc.net/aws/apis/grafana/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/grafana/versions/76cc5bd3d508/schema)