list_boxes Method

What does it do?

The method will return a list of Boxes (like folders) that belong to the user being authenticated in the request.

How do you use it?

The list of boxes are returns in an array labeled "boxes"

The "Unboxed" box will always be present with a box_id of 0, even if the user has no boxes created. This box always contains objects that a user has not yet assigned to a custom box yet.

The Box ID can be used in with other methods to modify the results. For example, to list objects in a specified box with the list_objects method.

Required Parameters

This method has no Required Parameters

Modifiers

This method has no modifiers

Example Response

        {
            "status":"ok",
            "boxes":
            [
                {
                    "box_id":"2205",
                    "box_name":"MyBox"
                },
                {
                    "box_id":"2206",
                    "box_name":"TunesBox"
                },
                {
                    "box_id":"0",
                    "box_name":"Unboxed"
                }
            ]
            
        }

Response Descriptions

box_id - a unique id of the box. No 2 boxes will ever have the same ID
box_name - The label for the box, So that it can be identified.