SMsmartsheet
workspaces

List workspaces

Retrieves a list of workspaces that the user has access to. It returns metadata for the workspaces only and doesn't include nested sub-structures.

See also: Pagination - SDK examples demonstrates listing workspaces with token-based pagination.

get/workspaces

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

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.

maxItemsinteger
Example:100

Request query parameter used in ListWorkspaces endpoints that support token based pagination.

The maximum amount of items to return in the response. The default and minimum are 100.

lastKeystring
Example:abcDefGhIjKlMnOpQrStUvWxYz

The lastKey token returned from the previous page of results. If not specified, the first page of results is returned.

Response

The response includes a lastKey field and the workspace listing.

lastKeystring

A token that is used to retrieve the next page of results when passed as the lastKey query parameter. This value will be absent when there are no further pages.

Example response

{
  "lastKey": "abcDefGhIjKlMnOpQrStUvWxYz"
}

Changes

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