---
title: "List Workspaces"
method: GET
path: "/workspaces"
tags: ["workspaces"]
---

# List Workspaces

`GET /workspaces`

## Query parameters

- `filter[environment]` string
- `filter[workspace]` string
- `filter[account]` string
- `filter[created-by]` string
- `filter[name]` string
- `filter[environment-type]` string
- `filter[run][status]` string
- `filter[run][created-by]` string
- `filter[agent-pool]` string
- `filter[software-version]` string
- `filter[provider-configuration]` string
- `filter[var-set]` string
- `filter[vcs-provider]` string
- `filter[federated-to-env]` string
- `filter[federated-by-env]` string
- `filter[vcs-repo][identifier]` string
- `filter[state-consumer-of]` string
- `page[number]` string
- `page[size]` string
- `query` string
- `filter[updated-at]` string
- `filter[deletion-protection-enabled]` string
- `filter[has-resources]` string
- `filter[updated-by]` string
- `filter[tag]` string
- `filter[run][resource-drifts]` string
- `filter[favorite]` string
- `filter[environment][name]` string
- `sort[favorite-first]` string
- `filter[drift-detection-enabled]` boolean
- `include` string[]
- `sort` string[]
- `fields` object
  - `agent-pools` string — The comma-separated list of fields to return in response for AgentPool resource.
  - `configuration-versions` string — The comma-separated list of fields to return in response for ConfigurationVersion resource.
  - `container-image-versions` string — The comma-separated list of fields to return in response for ContainerImageVersion resource.
  - `drift-reports` string — The comma-separated list of fields to return in response for DriftReport resource.
  - `environments` string — The comma-separated list of fields to return in response for Environment resource.
  - `module-versions` string — The comma-separated list of fields to return in response for ModuleVersion resource.
  - `modules` string — The comma-separated list of fields to return in response for Module resource.
  - `runs` string — The comma-separated list of fields to return in response for Run resource.
  - `tags` string — The comma-separated list of fields to return in response for Tag resource.
  - `users` string — The comma-separated list of fields to return in response for User resource.
  - `vcs-providers` string — The comma-separated list of fields to return in response for VcsProvider resource.
  - `workspace-readme` string — The comma-separated list of fields to return in response for WorkspaceReadme resource.
  - `workspaces` string — The comma-separated list of fields to return in response for Workspace resource.

## Response `200`

Success.

## Other responses

- `404` — Environment not found, or user unauthorized to perform action.
- `4XX` — Client error.
- `5XX` — Server error.

---

[API](https://skmtc.net/scalr/apis/scalr-iacp-api.md) · [All operations](https://skmtc.net/scalr/apis/scalr-iacp-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scalr/scalr-iacp-api/versions/fc927526ad12/schema)