Use this call to retrieve the IDs and names of all modules for a specified model.

This helps an integration identify which modules exist before retrieving views, line items, or data from a specific module.

Note: To use this call, you must be a Workspace Administrator.

Method and endpoint

GET

/models/{modelId}/modules

Parameters

ParameterDetails
{modelId}
  • Required
  • Type: String
  • Description: the ID for the model
  • Example: 75A40874E6B64FA3AE074327899685

Curl example

curl -X GET 'https://api.anaplan.com/2/0/models/{modelId}/modules' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Accept: application/json'

Response

Response header

Content-Type: application/json

Response 200 body

{
  "meta": {
    "paging": {
      "currentPageSize": 1,
      "offset": 0,
      "totalSize": 1
    },
    "schema": "https://api.anaplan.com/2/0/objects/module"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "modules": [{
      "id": "102000000125",
      "name": "REV01 Price Book"
    },
    {
      "id": "102000000121",
      "name": "REV02 Volume Inputs"
    }]
}