Terraform Cloud icon

Terraform Cloud

Interact with the Terraform Cloud API

Actions16

Workspace → Get Workspace Details

AI-generated

Summary

Retrieve detailed information about a specific Terraform Cloud workspace using its unique workspace ID.

Inputs

  • Workspace ID (required) — The unique identifier of the workspace (not its name) to fetch details for.

Output shape

a single JSON object containing detailed workspace information including its VCS settings and relationships (e.g., current and latest run)

The operation returns the workspace data wrapped in a JSON object; the response includes an 'include' query parameter to expand related resources like 'current_run' and 'latest_run'.

Examples

Example 1: Fetch details for a workspace with ID 'ws-12345'

Set 'Workspace ID' parameter to 'ws-12345' and choose 'Get Workspace Details' operation under 'Workspace' resource.

Links

Discussion