Get Workspace | Astronomer Documentation

{
  "cicdEnforcedDefault": true,
  "createdAt": "2023-09-08T12:00:00Z",
  "id": "clm8t5u4q000008jq4qoc3036",
  "name": "My Workspace",
  "organizationId": "clm8t5u4q000008jq4qoc3036",
  "updatedAt": "2023-09-08T13:30:00Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "defaultCloudProvider": "AWS",
  "defaultClusterId": "clmh9g6zj000008mg77if5wa2",
  "defaultRegion": "us-east-1",
  "description": "This is a test workspace",
  "organizationName": "My Organization",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  }
}

Get information about a Workspace.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

The ID of the Organization to which the Workspace belongs.

workspaceIdstringRequired

The Workspace's ID.

Response

cicdEnforcedDefaultboolean

Whether CI/CD deploys are enforced by default.

createdAtdatetime

The time when the Workspace was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ

idstring

The Workspace's ID.

namestring

The Workspace's name.

organizationIdstring

The ID of the organization to which the workspace belongs.

updatedAtdatetime

The time when the Workspace was updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ

createdByobject

defaultCloudProviderenum

The default cloud provider for new Deployments.

defaultClusterIdstring

The ID of the default cluster for new Deployments.

defaultRegionstring

The default region for new Deployments.

descriptionstring

The Workspace's description.

organizationNamestring

The name of the Organization to which the Workspace belongs.

updatedByobject

Errors

400

Get Workspace Request Bad Request Error

401

Get Workspace Request Unauthorized Error

403

Get Workspace Request Forbidden Error

404

Get Workspace Request Not Found Error

500

Get Workspace Request Internal Server Error

$	curl https://api.astronomer.io/v1/organizations/organizationId/workspaces/workspaceId \
>	-H "Authorization: Bearer <token>"