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

# List workspaces

`GET /workspaces`

Retrieves a list of workspaces that the user has access to. It returns metadata for the workspaces only and doesn't include nested sub-structures.

> **See also:** [Pagination - SDK examples](/api/smartsheet/guides/basics/pagination-sdk-examples) demonstrates listing workspaces with token-based pagination.

## Query parameters

- `accessApiLevel` number
- `maxItems` integer
- `lastKey` string

## Response `200`

The response includes a `lastKey` field and the workspace listing.

- object
  - `lastKey` string — A token that is used to retrieve the next page of results when passed as the `lastKey` query parameter. This value will be absent when there are no further pages.
  - `data` WorkspaceListing[]
    - `id` number — Workspace ID.
    - `name` string — Workspace name.
    - `accessLevel` 'ADMIN' | 'COMMENTER' | 'EDITOR' | 'EDITOR_SHARE' | 'OWNER' | 'VIEWER'
    - `permalink` string — URL that represents a direct link to the workspace in Smartsheet.

## Other responses

- `default` — Generic Error Payload

---

[API](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference.md) · [All operations](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartsheet/smartsheet-openapi-reference/versions/b4afda95fb51/schema)