Get Workspace

1 curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/workspaces/workspaceId \ 2 -H "Authorization: Bearer <token>"

1 { 2 "cicdEnforcedDefault": true, 3 "createdAt": "2023-09-08T12:00:00Z", 4 "createdBy": { 5 "apiTokenName": "my-token", 6 "avatarUrl": "https://avatar.url", 7 "fullName": "Jane Doe", 8 "id": "clm8qv74h000008mlf08scq7k", 9 "subjectType": "USER", 10 "username": "user1@company.com" 11 }, 12 "description": "This is a test workspace", 13 "id": "clm8t5u4q000008jq4qoc3036", 14 "name": "My Workspace", 15 "organizationId": "clm8t5u4q000008jq4qoc3036", 16 "organizationName": "My Organization", 17 "updatedAt": "2023-09-08T13:30:00Z", 18 "updatedBy": { 19 "apiTokenName": "my-token", 20 "avatarUrl": "https://avatar.url", 21 "fullName": "Jane Doe", 22 "id": "clm8qv74h000008mlf08scq7k", 23 "subjectType": "USER", 24 "username": "user1@company.com" 25 } 26 }

Get information about a Workspace.

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

createdByobjectOptional

descriptionstringOptional

The Workspace’s description.

organizationNamestringOptional

The name of the Organization to which the Workspace belongs.

updatedByobjectOptional

Path parameters

Headers

Response

Errors