Use this to preview large datasets, that allows you to quickly read a limited subset of records without loading the entire data list.
This helps confirm that the integration is targeting the correct list and that the output structure is suitable before requesting a larger dataset.
Method and endpoint
GET
/workspaces/{workspaceId}/models/{modelId}/lists/{listId}/preview
Parameters
| Parameter | Required | Type | Description | Example |
{workspaceId} | Yes | String | The workspace ID | 8a8196b15b7dbae6015b8694411d13fe |
{modelId} | Yes | String | The model ID | 75A40874E6B64FA3AE0743278996850F |
{listId} | Yes | Number | The list ID | 101000000001 |
Curl example
curl --location --request GET`
'https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/lists/{listId}/preview'`
-H 'Authorization: {anaplan_auth_token}'`
-H 'Accept: text/csv'
Response
Response 200 body
,Parent,Code
Closed No Decision,,
Closed Lost,,
Disqualified,,
5. Closed Won,,
0. 1st Meeting/Discovery,,
1. Qualification and Discovery,,
2. Solution Development,,
3. Solution Validation,,
4. Negotiate and Close,,
