list_objects Method

What does it do?

The method will return a list of Objects (files) that belong to the user being authenticated in the request.

How do you use it?

A list of objects are returned in an array labeled "objects", if there are no files, than the objects listing will be present, but empty.

The Object ID can be used in with other methods to modify the results. For example, in conjuction with the get_object method

Required Parameters

This method has no Required Parameters

Modifiers

Modifiers are additional fields added to the POST request that effect the outcome. The fields are optional.

box_id - If this field is not present, than the unboxed objects will be returned. Likewise if this field is set to "0", the unboxed objects are returned. Set this field to a valid Box ID and the objects that box contains will be returned in the response.
filter_file_extension - You can specify to have only files with a specific file extension to be returned in the response. Seperate multiple extensions with a "|" (pipe). For example:
```
&filter_file_extension=mp3|wav|ogg
```
Will result in only files with the .mp3, .wav, and .ogg extensions

Example Response

        {
            "status":"ok",
            "objects":
            [
                {
                    "object_id":"65937",
                    "file_name":"some_image_file.jpg"
                },
                {
                    "object_id":"41277",
                    "file_name":"anothervideo.mpg"
                }
            ]
            
        }

Response Descriptions

object_id - a unique id of the object file. No 2 objects will ever have the same ID
box_name - The file name for the object, So that it can be identified.