BObox
Metadata instances (Files)

List metadata instances on file

Changed on

Retrieves all metadata for a given file.

get/files/{file_id}/metadata

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/files/{file_id}/metadata
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Path parameters

file_idstring 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

viewstring

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.

limitinteger

The limit that was used for this page of results.

Example response

{
  "entries": [
    {
      "$parent": "folder_59449484661,",
      "$template": "marketingCollateral",
      "$scope": "enterprise_27335",
      "$version": 1
    }
  ],
  "limit": 100
}

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status