---
title: "List documents for a deployment policy"
method: GET
path: "/v2/deploymentPolicies/{deploymentPolicyId}/files"
tags: ["Deployment policies"]
---

# List documents for a deployment policy

`GET /v2/deploymentPolicies/{deploymentPolicyId}/files`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/deploymentPolicies/{deploymentPolicyId}/files`
- Auth: HTTP bearer

List documents for a deployment policy

### Usage notes
- Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint.
- If the user associated with the API key does not have access to the document, the `inode` field is `null`.
- The `inode` field is one of `workbook`, `dataModel`, `report`, or `folder`. Use the `type` field to determine which shape is returned and which ID field is present.
- Folders are returned as a single entry. The documents they contain are not listed individually.

### Usage scenarios
- Review and audit documents deployed to specific tenant organizations.

## Path parameters

- `deploymentPolicyId` string, required

## Query parameters

- `pageToken` string
- `pageSize` integer

## Response `200`

The response body.

- DeploymentPoliciesListInodesForDeploymentResponse200
  - `entries` V2DeploymentPoliciesDeploymentPolicyIdFilesGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint
    - `inodeId` string, required
    - `inode` union, required
      - V2DeploymentPoliciesDeploymentPolicyIdFilesGetResponsesContentApplicationJsonSchemaEntriesItemsInode0
        - `name` string, required
        - `type` 'workbook', required
        - `workbookId` string, required
      - V2DeploymentPoliciesDeploymentPolicyIdFilesGetResponsesContentApplicationJsonSchemaEntriesItemsInode1
        - `name` string, required
        - `type` 'dataModel', required
        - `dataModelId` string, required
      - V2DeploymentPoliciesDeploymentPolicyIdFilesGetResponsesContentApplicationJsonSchemaEntriesItemsInode2
        - `name` string, required
        - `type` 'report', required
        - `reportId` string, required
      - V2DeploymentPoliciesDeploymentPolicyIdFilesGetResponsesContentApplicationJsonSchemaEntriesItemsInode3
        - `name` string, required
        - `type` 'folder', required
        - `folderId` string, required
    - `deploymentPolicyId` string, required
  - `nextPageToken` string: A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results. **Must be treated as an opaque string.**

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)
