# Get workspace (deprecated)

Gets a Workspace object.

> Important: We've set a 60 requests per minute per API token limit for this operation.

DEPRECATED - As early as the sunset date specified in this Changelog entry, this endpoint will be removed. See the Get workspace metadata and the Get workspace children endpoints for replacement functionality.

Endpoint: GET /workspaces/{workspaceId}
Version: 2.0.0
Security: APIToken, OAuth2

## Header parameters:

  - `Authorization` (string)
    API Access Token used to authenticate requests to Smartsheet APIs.

  - `smartsheet-integration-source` (string)
    Uses the following metadata to distinguish between human-initiated API requests and third-party service-initiated calls by AI Connectors or ITSM:

- Integration source type
- Organization name
- Integration source name 

Format:


TYPE,OrgName,SourceName


Examples: 

AI,SampleOrg,My-AI-Connector-v2

SCRIPT,SampleOrg2,Accounting-updater-script

APPLICATION,SampleOrg3,SheetUpdater
    Example: "AI,SampleOrg,My-AI-Connector-v2"

## Path parameters:

  - `workspaceId` (string, required)
    ID of the workspace being accessed.

## Query parameters:

  - `accessApiLevel` (number)
    Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1.

  - `include` (string)
    A comma-separated list of optional elements to include in the response:
  * source - adds the Source object indicating which object the folder was created from, if any
  * distributionLink
  * ownerInfo Returns the user with owner permissions, or the user with admin permissions if there is no owner assigned. If no owner or admins are assigned, the Plan Asset Admin is returned. If no Plan Asset Admin is assigned, the System Admin is returned.
  * sheetVersion
  * permalinks
    Enum: "source", "distributionLink", "ownerInfo", "sheetVersion"

  - `loadAll` (boolean)
    If set to true, the workspace's entire hierarchy of items and folders is returned.

## Response 200 fields (application/json):

  - `id` (number)
    Workspace ID.

  - `name` (string)
    Workspace name.

  - `accessLevel` (string)
    Enum: "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER"

  - `permalink` (string)
    URL that represents a direct link to the workspace in Smartsheet.

  - `folders` (array)
    Folders contained in the workspace.

  - `folders.id` (number)
    Folder ID.

  - `folders.folders` (array)
    Folders contained in folder.

  - `folders.name` (string)
    Folder name.

  - `folders.permalink` (string)
    URL that represents a direct link to the folder in Smartsheet.

  - `folders.reports` (array)
    Reports contained in folder.

  - `folders.reports.id` (number)
    Asset ID.

  - `folders.reports.name` (string)
    Asset name.

  - `folders.reports.permalink` (string)
    URL that represents a direct link to the asset in Smartsheet.

  - `folders.sheets` (array)
    Sheets contained in folder.

  - `folders.sights` (array)
    Dashboards contained in folder.

  - `folders.sights.createdAt` (any)

  - `folders.sights.modifiedAt` (any)

  - `folders.templates` (array)
    Templates contained in folder.

  - `folders.favorite` (boolean)
    Deprecated Returned only if the user has marked the folder as a favorite in their "Home" tab (value = true).

  - `reports` (array)
    Reports contained in the workspace.

  - `sheets` (array)
    Sheets contained in the workspace.

  - `sights` (array)
    Dashboards contained in the workspace.

## Response default fields (application/json):

  - `refId` (string)
    The ID of the specific error occurrence. Please include this information when contacting Smartsheet support.

  - `errorCode` (number)
    Custom error code from Smartsheet. See the complete [Error Code List](/api/smartsheet/error-codes).

  - `message` (string)
    Descriptive error message.