Retrieves all workspaces a user has access to within the user's default tenant.

Lists all workspaces the user can access in their default tenant. Can optionally include tenant details such as workspace size and allowance.

This helps an integration identify which workspaces are available to the user before making more specific model, import, export, or process calls.

Method and endpoint

GET

/workspaces?tenantDetails=true

Parameters

ParameterDetails
tenantDetails
  • Optional
  • Type: Boolean
  • Description: When set to true, this call returns an estimate of the current size (currentSize) of the workspace from all the models it contains and the alotted quota (sizeAllowance). When set to false, or not defined, this call does not return an estimated current size of the workspace.
  • Example: true

Curl example

curl -X GET \
https://api.anaplan.com/2/0/workspaces?tenantDetails=true \
-H 'authorization: AnaplanAuthToken {anaplan_auth_token}'

Response

{
  "meta": {
    "schema": "https://api.anaplan.com/2/0/objects/workspace",
    "paging": {
      "currentPageSize": 1,
      "totalSize": 1,
      "offset": 0
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "workspaces": [
    {
    "id": "8a8b8c8d8e8f8g8i",
    "name": "Financial Planning",
    "active": true,
    "sizeAllowance": 1073741824,
    "currentSize": 873741824
    }
  ]
}