---
title: "List files"
method: GET
path: "/v2/files"
tags: ["Files"]
---

# List files

`GET /v2/files`

## Request

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

List all documents, such as workbooks and folders, accessible from the parent.

  ### Which files are returned by this endpoint

  The documents and folders accessible through this endpoint match those returned when you search in the Sigma UI. Some documents that you can view in the Sigma UI are not returned by this endpoint.

  - Returned documents and folders are limited to those that you have access to, such as through ownership, a document directly shared with you, a document link shared with you that you have opened, or access inherited through a folder or a workspace. This restriction also applies to users granted the Admin account type.
  - Newly created files are not returned immediately after creation. Updated files are reflected immediately.
  - If no `typeFilters` are set, only workbooks, folders, data models, datasets (deprecated), and reports are returned. To return other file types, such as a shortcut (symlink), specify a file type using the `typeFilters` option.

  ### Usage notes

  - Use the **parentId** to specify a folder and return details about the nested files and documents:
    - Retrieve the ID to use as a **parentId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.
    - To use the "My Documents" folder as the parent folder, call the [/v2/members/{memberId}](https://help.sigmacomputing.com/reference/get-member) endpoint and use the `homeFolderId` included in the response.
    - If parentId is not specified, it is assumed to be the root.
  - Use the available filters to return files that contain a specific keyword in the name, files with specific permissions granted to the user associated with the API credentials, or files of a specific type.

## Query parameters

- `name` string
- `permissionFilter` union
  - 'view' | 'explore' | 'edit'
  - 'view' | 'explore' | 'organize' | 'edit': Choose **organize** for Can Contribute permissions or **edit** for Can Manage permissions.
- `typeFilters` union
  - V2FilesGetParametersTypeFiltersSchemaOneOf0Items[]: **Note**: Workspaces are not returned as part of the response. To retrieve a workspace, use the **Single Document Type**.
  - 'workspace' | 'folder' | 'workbook' | 'dataset' | 'data-model' | 'sql' | 'worksheet' | 'dashboard' | 'template' | 'table' | 'symlink' | 'report'
- `page` string
- `limit` number, double
- `parentId` string
- `directChildFilter` boolean

## Response `200`

The response body.

- FilesListResponse200
  - `entries` V2FilesGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint
    - `id` string, required
    - `urlId` string, required
    - `name` string, required
    - `type` 'workspace' | 'folder' | 'workbook' | 'dataset' | 'data-model' | 'sql' | 'worksheet' | 'dashboard' | 'template' | 'table' | 'symlink' | 'report', required
    - `parentId` string, required
    - `parentUrlId` string, required
    - `permission` 'create' | 'annotate' | 'organize' | 'explore' | 'view' | 'edit' | 'apply', required
    - `path` string, required
    - `badge` string, nullable, required
    - `isArchived` boolean, required
    - `description` string
    - `ownerId` string, nullable
    - `parentSourceUrlId` string: For a document deployed to a tenant organization, the `urlId` of the source document in the parent organization. Only present when the document was deployed from a parent organization. The source document can be a workbook, template, data model, dataset, or report.
    - `createdBy` string, required: The identifier of the user who created this object.
    - `updatedBy` string, required: The identifier of the user or process that last updated this object.
    - `createdAt` string, date-time, required: When the object was created.
    - `updatedAt` string, date-time, required: When the object was last updated.
  - `nextPage` string, nullable, required: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`.
  - `total` number, double: Total number of results. Useful to determine if there is a need to paginate.
  - `hasMore` boolean: **[Deprecated]** Indicates whether more results are available.

---

[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)