v1

latestOpenAPI 3.0.02026-07-267316.2 KB
Workspace

Retrieve information about a workspace (scope: settings.read)

get/workspace/{workspace-id}

Path parameters

workspace-idstring required

The identifier for the workspace

Response

The workspace information was retrieved successfully

workspacestring required

The workspace id (matches the workspace-id sent with the request)

namestring required

The name of the workspace, as assigned in the dashboard

Example response

{
  "workspace": "z3plqkvf52r",
  "name": "Standards Brand Guidelines"
}