ns_getFolderByPath

Tool Name

ns_getFolderByPath

Tool Description

Lists the files and folders directly in a specified File Cabinet folder. Folders appear before files. Each group is sorted by internal ID.

The response includes file and folder details in entries and a nextCursor value when more results are available. The tool doesn't return file contents.

Changes to folder contents between requests can affect the results.

Annotation

Get Folder By Path

Properties

The following table lists the tool's properties.

Property

Type

Required or Optional

Description

path

string

Required

The File Cabinet folder path, for example /User Documents/Invoices. Use / for the File Cabinet root. Leading and trailing slashes are optional.

pageSize

number

Optional

The maximum number of entries returned per request. Specify an integer from 1 through 1,000. Defaults to 100 if omitted or null.

cursor

string

Optional

The nextCursor value from this tool's previous response for the same folder path. Use the value unchanged. Omit or use null for the first request.

Permissions

Your ability to list folder contents depends on your NetSuite role's file and folder permissions.

Related Topics

General Notices