---
title: "POST /workspaces-list"
method: POST
path: "/workspaces-list"
---

# POST /workspaces-list

`POST /workspaces-list`

Retrieves information about workspaces in the current account.

## Request body

- object
  - `maxResults` integer — <p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
  - `nextToken` string — The string that specifies the next page of results.

## Response `200`

Success

- ListWorkspacesResponse
  - `workspaceSummaries` WorkspaceSummary[] — A list of objects that contain information about the workspaces.
    - `workspaceId` string, required — The ID of the workspace.
    - `arn` string, required — The ARN of the workspace.
    - `description` string — The description of the workspace.
    - `linkedServices` LinkedService[] — A list of services that are linked to the workspace.
    - `creationDateTime` string, date-time, required — The date and time when the workspace was created.
    - `updateDateTime` string, date-time, required — The date and time when the workspace was last updated.
  - `nextToken` string — The string that specifies the next page of results.

## Other responses

- `480` — InternalServerException
- `481` — ThrottlingException
- `482` — ValidationException
- `483` — ServiceQuotaExceededException

---

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