Workspace

Get Workspace

GET
Get information about a Workspace.

Path parameters

organizationIdstringRequired
The ID of the Organization to which the Workspace belongs.
workspaceIdstringRequired
The Workspace's ID.

Response

This endpoint returns an object
cicdEnforcedDefault
boolean
Whether CI/CD deploys are enforced by default.
createdAt
datetime

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

id
string
The Workspace's ID.
name
string
The Workspace's name.
organizationId
string
The ID of the organization to which the workspace belongs.
updatedAt
datetime

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

createdBy
objectOptional
description
stringOptional
The Workspace's description.
organizationName
stringOptional
The name of the Organization to which the Workspace belongs.
updatedBy
objectOptional
GET
1curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/workspaces/workspaceId \
2     -H "Authorization: Bearer <token>"
Response
1{
2  "cicdEnforcedDefault": true,
3  "createdAt": "2023-09-08T12:00:00Z",
4  "id": "clm8t5u4q000008jq4qoc3036",
5  "name": "My Workspace",
6  "organizationId": "clm8t5u4q000008jq4qoc3036",
7  "updatedAt": "2023-09-08T13:30:00Z",
8  "createdBy": {
9    "id": "clm8qv74h000008mlf08scq7k",
10    "apiTokenName": "my-token",
11    "avatarUrl": "https://avatar.url",
12    "fullName": "Jane Doe",
13    "subjectType": "USER",
14    "username": "user1@company.com"
15  },
16  "description": "This is a test workspace",
17  "organizationName": "My Organization",
18  "updatedBy": {
19    "id": "clm8qv74h000008mlf08scq7k",
20    "apiTokenName": "my-token",
21    "avatarUrl": "https://avatar.url",
22    "fullName": "Jane Doe",
23    "subjectType": "USER",
24    "username": "user1@company.com"
25  }
26}
Built with