GET
/
v1
/
workspaces
/
slug
/
{workspaceSlug}
curl --request GET \
  --url https://api.ctrlplane.dev/api/v1/workspaces/slug/{workspaceSlug}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "googleServiceAccountEmail": "ctrlplane@ctrlplane-workspace.iam.gserviceaccount.com",
  "awsRoleArn": "arn:aws:iam::123456789012:role/ctrlplane-workspace-role"
}

Path Parameters

​
workspaceSlug
string
required
Example:

"my-workspace"

Response

200
application/json
Workspace found
​
id
string
required

The workspace ID

​
name
string
required

The name of the workspace

​
slug
string
required

The slug of the workspace

​
googleServiceAccountEmail
string | null

The email of the Google service account attached to the workspace

Example:

"ctrlplane@ctrlplane-workspace.iam.gserviceaccount.com"

​
awsRoleArn
string | null

The ARN of the AWS role attached to the workspace

Example:

"arn:aws:iam::123456789012:role/ctrlplane-workspace-role"