List items in folder


Retrieves a page of items in a folder. These items can be files, folders, and web links.

To request more information about the folder itself, like its size, use the Get a folder endpoint instead.



Path Parameters

stringin pathrequired

The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://* the folder_id is 123.

The root folder of a Box account is always represented by the ID 0.

Query Parameters

stringin queryoptional

The direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.

Value is one of ASC,DESC

string arrayin queryoptional

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Additionally this field can be used to query any metadata applied to the file by specifying the metadata field as well as the scope and key of the template to retrieve, for example ?field=metadata.enterprise_12345.contractTemplate.

integer / int64in queryoptional

The maximum number of items to return per page.

stringin queryoptional

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

integer / int64in queryoptional

The offset of the item at which to begin the response.

Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.

stringin queryoptional

Defines the second attribute by which items are sorted.

The folder type affects the way the items are sorted:

  • Standard folder: Items are always sorted by their type first, with folders listed before files, and files listed before web links.

  • Root folder: This parameter is not supported for marker-based pagination on the root folder

(the folder with an id of 0).

  • Shared folder with parent path to the associated folder visible to the collaborator: Items are always sorted by their type first, with folders listed before files, and files listed before web links.

Value is one of id,name,date,size

booleanin queryoptional

Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time.

By setting this value to true, the API will return a marker field that can be passed as a parameter to this endpoint to get the next page of the response.

Request Headers

stringin header

The URL, and optional password, for the shared link of this item.

This header can be used to access items that have not been explicitly shared with a user.

Use the format shared_link=[link] or if a password is required then use shared_link=[link]&shared_link_password=[password].

This header can be used on the file or folder shared, as well as on any files or folders nested within the item.



Returns a collection of files, folders, and web links contained in a folder.

application/jsonClient error

Returned when the access token provided in the Authorization header is not recognized or not provided.

application/jsonClient error

Returned if the folder is not found, or the user does not have access to the folder.

application/jsonClient error

Returned if the folder_id is not in a recognized format.

application/jsonClient error

An unexpected client error.

List items in folder
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

curl -i -X GET "" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
BoxCollection<BoxItem> folderItems = await client.FoldersManager.GetFolderItemsAsync("11111", 100);
BoxFolder folder = new BoxFolder(api, "id");
for (BoxItem.Info itemInfo : folder) {
    if (itemInfo instanceof BoxFile.Info) {
        BoxFile.Info fileInfo = (BoxFile.Info) itemInfo;
        // Do something with the file.
    } else if (itemInfo instanceof BoxFolder.Info) {
        BoxFolder.Info folderInfo = (BoxFolder.Info) itemInfo;
        // Do something with the folder.
items = client.folder(folder_id='22222').get_items()
for item in items:
    print(f'{item.type.capitalize()} {} is named "{}"')
        usemarker: 'false',
        fields: 'name',
        offset: 0,
        limit: 25
    .then(items => {
        /* items -> {
            total_count: 2,
            [ { type: 'folder',
                id: '11111',
                sequence_id: '1',
                etag: '1',
                name: 'Personal Documents' },
                { type: 'file',
                id: '22222',
                sequence_id: '0',
                etag: '0',
                name: 'Q2 Strategy.pptx' } ],
            offset: 0,
            limit: 25,
            [ { by: 'type', direction: 'ASC' },
                { by: 'name', direction: 'ASC' } ] }
let iterator = client.folders.listItems(folderId: "22222", sort: .name, direction: .ascending) { results in
    switch results {
    case let .success(page):
        for item in page.entries {
            switch item {
            case let .file(file):
                print("File \( (ID: \( is in the folder")
            case let .folder(folder):
                print("Subfolder \( (ID: \( is in the folder")
            case let .webLink(webLink):
                print("Web link \( (ID: \( is in the folder")

    case let .failure(error):

Response Example

  "entries": [
      "id": "12345",
      "etag": "1",
      "type": "file",
      "sequence_id": "3",
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": "12345",
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
  "limit": 1000,
  "offset": 2000,
  "order": [
      "by": "type",
      "direction": "ASC"
  "total_count": 5000