Workspaces

Get workspace

Changed on

Get a workspace where one of the caller's roles grants workspace:read, with the caller's role. Instance admins can get any workspace, with a null role when they are not a member.

get/workspace/{workspaceId}

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/workspace/{workspaceId}
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Response

The workspace

idstring required
namestring required
slugstring required
logostring nullable required
descriptionstring nullable required
createdAtstring date-time required
rolestring nullable required

The caller's workspace role: a built-in role (owner, admin, member, viewer) or the name of a custom role defined in the workspace. Several roles are comma-separated, for example owner,viewer. Null when an instance admin views a workspace they are not a member of.

Changes