Files

List files

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 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} 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.
get/v2/files

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Query parameters

namestring
'view' | 'explore' | 'edit'
OR
'view' | 'explore' | 'organize' | 'edit'

Choose organize for Can Contribute permissions or edit for Can Manage permissions.

V2FilesGetParametersTypeFiltersSchemaOneOf0Items[]

Note: Workspaces are not returned as part of the response. To retrieve a workspace, use the Single Document Type.

OR
'workspace' | 'folder' | 'workbook' | 'dataset' | 'data-model' | 'sql' | 'worksheet' | 'dashboard' | 'template' | 'table' | 'symlink' | 'report'
pagestring
limitnumber double
parentIdstring

Parent folder

directChildFilterboolean

Response

The response body.

nextPagestring 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.

totalnumber double

Total number of results. Useful to determine if there is a need to paginate.

hasMoreboolean

[Deprecated] Indicates whether more results are available.

Changes

No recorded changes to this operation across all 1 revision of this API.