Workspace

List Workspaces

GET
List Workspaces in an Organization

Path parameters

organizationIdstringRequired
The ID of the Organization to list Workspaces for.

Query parameters

workspaceIdsstringOptional
A list of IDs for specific Workspaces to list. The API will list information only for Workspaces which have been specified in this list.
namesstringOptional
A list of names for specific Workspaces to filter by. The API will list information only for Workspaces which have been specified in this list.
offsetintegerOptional
The number of results to skip before returning values.
limitintegerOptional
The maximum number of results to return.
sortsenumOptional

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Response

This endpoint returns an object
limit
integer
The maximum number of workspaces that can be retrieved per page.
offset
integer
The offset for the current page of workspaces in the complete result.
totalCount
integer
The total number of Workspaces in the paginated result.
workspaces
list of objects
An array of Workspace objects representing a list of workspaces.
GET
1curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/workspaces \
2     -H "Authorization: Bearer <token>"
Response
1{
2  "limit": 0,
3  "offset": 0,
4  "totalCount": 0,
5  "workspaces": [
6    {
7      "cicdEnforcedDefault": true,
8      "createdAt": "2023-09-08T12:00:00Z",
9      "id": "clm8t5u4q000008jq4qoc3036",
10      "name": "My Workspace",
11      "organizationId": "clm8t5u4q000008jq4qoc3036",
12      "updatedAt": "2023-09-08T13:30:00Z",
13      "createdBy": {
14        "id": "clm8qv74h000008mlf08scq7k",
15        "apiTokenName": "my-token",
16        "avatarUrl": "https://avatar.url",
17        "fullName": "Jane Doe",
18        "username": "user1@company.com"
19      },
20      "description": "This is a test workspace",
21      "organizationName": "My Organization",
22      "updatedBy": {
23        "id": "clm8qv74h000008mlf08scq7k",
24        "apiTokenName": "my-token",
25        "avatarUrl": "https://avatar.url",
26        "fullName": "Jane Doe",
27        "username": "user1@company.com"
28      }
29    }
30  ]
31}
Built with