Organization -- Workspaces

Read Workspace

Returns details of a specified Workspace, which is a collaborative environment within an Organization that groups Projects together.

A Workspace facilitates team collaboration, resource management, and organization of data operations.

The hierarchical structure in Peaka is:

<code>Organization (top-level) → Workspace → Project</code>

Projects contain data catalogs and workflows that teams manage within a Workspace.

get/organizations/{organizationId}/workspaces/{workspaceId}

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/organizations/{organizationId}/workspaces/{workspaceId}
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

Organization ID

workspaceIdstring required

Workspace ID

Response

Successful operation

idstring uuid

The unique identifier of the workspace

namestring

The name of the workspace

createdBystring uuid

The unique identifier of the user who created the workspace

organizationIdstring uuid

The unique identifier of the organization to which the workspace belongs

descriptionstring

Descriptive text about the workspace

createdAtstring

The date and time the workspace was created

defaultWorkspaceboolean

Whether the workspace is the default workspace for the organization.

This is a backward compatibility field in order to create projects in the default workspace if the workspace is not specified.

Changes

No recorded changes to this operation across all 1 revision of this API.