curl --request GET \
--url https://partner.peaka.studio/api/v1/organizations/{organizationId}/workspaces \
--header 'Authorization: Bearer <token>'
[
{
"id": "56d43968-e31d-4010-9b75-018a79a51b17",
"name": "workspace 1",
"createdBy": "1673d60f-a0ea-41f4-9420-c91dbc2864f5",
"organizationId": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef",
"description": "sample description",
"createdAt": "2025-04-17T08:08:15.687751Z",
"defaultWorkspace": false
},
{
"id": "78cf8c83-8569-4d7c-a1ce-404dee7c5c6b",
"name": "workspace 2",
"createdBy": "1673d60f-a0ea-41f4-9420-c91dbc2864f5",
"organizationId": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef",
"description": "sample description",
"createdAt": "2025-04-17T08:05:58.312996Z",
"defaultWorkspace": false
},
{
"id": "eaa442d7-82ac-4a65-b302-093d0465eb67",
"name": "Default Workspace",
"createdBy": "1673d60f-a0ea-41f4-9420-c91dbc2864f5",
"organizationId": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef",
"description": "Default Workspace",
"createdAt": "2025-03-25T12:28:51.147125Z",
"defaultWorkspace": true
}
]
Returns all workspaces under the specified Organization.
A Workspace is a collaborative environment within an Organization that groups Projects together. It facilitates team collaboration, resource management, and organization of data operations.
The hierarchical structure in Peaka is:
Organization (top-level) → Workspace → Project
Projects contain data catalogs and workflows that teams manage within a Workspace.
curl --request GET \
--url https://partner.peaka.studio/api/v1/organizations/{organizationId}/workspaces \
--header 'Authorization: Bearer <token>'
[
{
"id": "56d43968-e31d-4010-9b75-018a79a51b17",
"name": "workspace 1",
"createdBy": "1673d60f-a0ea-41f4-9420-c91dbc2864f5",
"organizationId": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef",
"description": "sample description",
"createdAt": "2025-04-17T08:08:15.687751Z",
"defaultWorkspace": false
},
{
"id": "78cf8c83-8569-4d7c-a1ce-404dee7c5c6b",
"name": "workspace 2",
"createdBy": "1673d60f-a0ea-41f4-9420-c91dbc2864f5",
"organizationId": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef",
"description": "sample description",
"createdAt": "2025-04-17T08:05:58.312996Z",
"defaultWorkspace": false
},
{
"id": "eaa442d7-82ac-4a65-b302-093d0465eb67",
"name": "Default Workspace",
"createdBy": "1673d60f-a0ea-41f4-9420-c91dbc2864f5",
"organizationId": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef",
"description": "Default Workspace",
"createdAt": "2025-03-25T12:28:51.147125Z",
"defaultWorkspace": true
}
]
Use the Authorization header with the value 'Bearer <apiKey>' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication
List of Workspaces
The response is of type object
.