Use this call to retrieve lists for a specified workspace and model.

This helps an integration discover available lists and collect list IDs before reading, updating, or validating list item data.

Method and endpoint

GET

/workspaces/{workspaceId}/models/{modelId}/lists

Parameters

ParameterDetails
{workspaceId}
  • Required
  • Type: String
  • Description: The workspace ID
  • Example: 8a8196b15b7dbae6015b8694411d13fe
{modelId}
  • Required
  • Type: String
  • Description: the ID for the model
  • Example: 75A40874E6B64FA3AE074327899685

Curl example

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

Response

Response 200 body

{
    "meta": {
        "paging": {
            "currentPageSize": 5,
            "offset": 0,
            "totalSize": 5
        },
        "schema": "https://api.anaplan.com/2/0/models/75A40874E6B64FA3AE0743278996850F/objects/list"
    },
    "status": {
        "code": 200,
        "message": "Success"
    },
    "lists": [
        {
            "id": "101000000000",
            "name": "Organization"
        },
        {
            "id": "101000000001",
            "name": "opportunities"
        },
        {
            "id": "101000000002",
            "name": "sales rep"
        },
        {
            "id": "101000000003",
            "name": "Bakery"
        },
        {
            "id": "101000000004",
            "name": "List2"
        }
    ]
}