Box.com Search API to retrieve all files in a determined folder

Question

I'm searching a way to obtain all files of a specific folder.

But I can't find sufficient informations in the official documentation

I think about something like this: (I assume also to set a custom header with the access_token)

https://api.box.com/2.0/search?query=*

This way doesn't work, and I think that the query doen't accept a regex...

Any idea?

---

PS: A real usecase will help to understand this question:

my folder:

folderOne:
 |
 |_file1.jpg
 |
 |_file2.doc
 |
 |_folder1
 | |_file3.jpg
 | |_folder2
 |
 |_file4.pdf

with the search request I expect to get only file1.jpg, file2.doc and file4.pdf.

Answer 1

You can most easily accomplish this by querying for a folder's contents and then filtering client-side for the file items.

curl https://api.box.com/2.0/folders/FOLDER_ID/items \
-H "Authorization: Bearer ACCESS_TOKEN"

This will return a collection of items, from which you can select those whose type is file.

{
  "total_count": 4,
  "entries": [
     {
        "type": "folder",
        "id": "192429928",
        "name": "folder1"
     },
     {
        "type": "file",
        "id": "818853862",
        "name": "file1.jpg"
     },
     {
        "type": "file",
        "id": "818853843",
        "name": "file2.doc"
     },
     {
        "type": "file",
        "id": "818853832",
        "name": "file4.pdf"
     }
  ]
}

Pagination

Box will return all folder metadata before any file metadata. You can count these folders to determine the appropriate offset for file-only paging. For example, if your Box folder has 13 subfolders, and you want to page 25 files at a time:

/folders/FOLDER_ID/items?limit=25&offset=13
/folders/FOLDER_ID/items?limit=25&offset=38
/folders/FOLDER_ID/items?limit=25&offset=63
/folders/FOLDER_ID/items?limit=25&offset=...