Retrieves information on a specific workspace if the user has access.

This helps validate that a workspace exists, confirm access, and gather workspace metadata needed for other API workflows.

This endpoint can also return size-related details when requested. 

Method and endpoint

GET

/workspaces/{workspaceId}?tenantDetails=true

Parameters

ParameterDetails
workspaceId
  • Required
  • Type: string
  • Description: The workspace ID
  • Example: 8a8b8c8d8e8f8g8i
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 allotted quota (sizeAllowance). When set to false, or not defined, this call doesn't return an estimated current size of the workspace.
  • Example: true

Curl example

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

Response

Response headers

Content-Type: application/json

Response 200 body

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

Group models

View these endpoints for further details on models APIs: