1. Data integration
  2. Anaplan API
  3. Integration API v2.0
  4. Use the bulk APIs
  5. Obtain workspace and model IDs
  6. Get your list of models

Get the list of workspaces for your Anaplan user ID.  The results show a list of all models.  Note and record the id value related to the appropriate model and the currentWorkspaceId for the Workspace ID related to your model.

Method and endpoint

https://api.anaplan.com/2/0/models

GET

Parameters

ParameterDescription
AnaplanAuthToken:{token}Your Anaplan authentication token value.

Curl example

curl -X GET \
https://api.anaplan.com/2/0/models \
-H 'Authorization: AnaplanAuthToken {token}'

Response

{

   "meta":{

      "schema":"https://api.anaplan.com/2/0/objects/model",

      "paging":{

         "currentPageSize":697,

         "totalSize":697,

         "offset":0,

         "next":"https://api.anaplan.com/2/0/models?limit=20&offset=20"

      }

   },

   "models":[

      {

         "id":"F1111111C11111111B11111F1111E11F",

         "activeState":"UNLOCKED",

         "name":"Club S&P",

         "currentWorkspaceId":"A1111111B11111111C11111D1111E11F",

         "currentWorkspaceName":"Global S&P",

         "modelUrl":"https://rt.anaplan.com/anaplan/rt?selectedWorkspaceId=A1111111B11111111C11111D1111E11F&selectedModelId=F1111111C11111111B11111F1111E11F",

         "categoryValues":[

            

         ]

      }

   ]

}

Disclaimer

We may update our documentation occasionally, but will only do so in a way that does not negatively affect the features and functionality of the Anaplan service.