Skip to main content
GET
/
files
/
{file_id}
/
metadata
cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/metadata" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "entries": [
    {
      "$parent": "folder_59449484661,",
      "$template": "marketingCollateral",
      "$scope": "enterprise_27335",
      "$version": 1
    }
  ],
  "limit": 100
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
file_id
string
required

The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Query Parameters

​
view
string

Taxonomy field values are returned in API view by default, meaning the value is represented with a taxonomy node identifier. To retrieve the Hydrated view, where taxonomy values are represented with the full taxonomy node information, set this parameter to hydrated. This is the only supported value for this parameter.

Response

Returns all the metadata associated with a file.

This API does not support pagination and will therefore always return all of the metadata associated to the file.

A list of metadata instances that have been applied to a file or folder.

​
entries
Metadata instance · object[]

A list of metadata instances, as applied to this file or folder.

​
limit
integer

The limit that was used for this page of results.

Example:

100