SMsmartsheet
workspaces

Get workspace metadata

Gets the metadata of a workspace.

get/workspaces/{workspaceId}/metadata

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: READ_SHEETS

Query parameters

include'source'

A comma-separated list of optional elements to include in the response:

  • source - adds the Source object indicating which object this resource was created from, if any
numericDatesboolean

You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request.

accessApiLevelnumber

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.

Response

The metadata of a workspace.

idinteger required

Workspace ID.

namestring required

Workspace name.

permalinkstring uri required

URL to the workspace in Smartsheet.

accessLevel'ADMIN' | 'COMMENTER' | 'EDITOR' | 'EDITOR_SHARE' | 'OWNER' | 'VIEWER' required

The user's access level to the workspace.

Changes

No recorded changes to this operation across all 16 revisions of this API.