A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.
List metadata instances on folder
Retrieves all metadata for a given folder. This can not be used on the root
folder with ID 0.
Request
Path Parameters
12345The 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://*.app.box.com/folder/123
the folder_id is 123.
The root folder of a Box account is
always represented by the ID 0.
Response
Returns all the metadata associated with a folder.
This API does not support pagination and will therefore always return all of the metadata associated to the folder.
Returned when the request parameters are not valid.
forbidden- this operation is not allowed on the Root folder.
Returned when the user does not have access to the folder.
An unexpected client error.
Request Example
curl -i -X GET "https://api.box.com/2.0/folders/4353455/metadata" \
-H "authorization: Bearer <ACCESS_TOKEN>"await client.folderMetadata.getFolderMetadata(folder.id);client.folder_metadata.get_folder_metadata(folder.id)await client.FolderMetadata.GetFolderMetadataAsync(folderId: folder.Id);try await client.folderMetadata.getFolderMetadata(folderId: folder.id)client.getFolderMetadata().getFolderMetadata(folder.getId())await client.FolderMetadata.GetFolderMetadataAsync(folderId: folder.Id);await client.folderMetadata.getFolderMetadata(folder.id);Response Example
{
"entries": [
{
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "marketingCollateral",
"$version": 1
}
],
"limit": 100
}