list_workspaces
Retrieve and filter workspaces in a Terraform Cloud organization. This tool provides a paginated list of workspaces, enabling discovery, configuration checks, and partial name searches efficiently.
Instructions
List workspaces in an organization.
Retrieves a paginated list of all workspaces in a Terraform Cloud organization. Results can be filtered using a search string to find specific workspaces by name. Use this tool to discover existing workspaces, check workspace configurations, or find specific workspaces by partial name match.
API endpoint: GET /organizations/{organization}/workspaces
Args: organization: The name of the organization to list workspaces from page_number: The page number to return (default: 1) page_size: The number of items per page (default: 20, max: 100) search: Optional search string to filter workspaces by name
Returns: Paginated list of workspaces with their configuration settings and metadata
See: docs/tools/workspace.md for reference documentation
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| organization | Yes | ||
| page_number | No | ||
| page_size | No | ||
| search | No |