Manage Applications

    Get specific folder metadata

    get
    https://api.box.com/2.0
    /folders/:folder_id/metadata/:scope/:template_key

    Retrieve a specific metadata template instance for a folder

    Request

    application/json

    Path Parameters

    stringin pathrequired
    0

    The 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.

    stringin pathrequired
    enterprise_27335

    The scope of the metadata template

    Value is one of "global", "enterprise_<id>"

    stringin pathrequired
    blueprintTemplate

    The name of the metadata template

    Response

    application/jsonMetadata

    An instance of the metadata template that includes additional "key:value" pairs defined by the user or an application.

    application/jsonClient Error

    Returned if the metadata template specified was not applied to this folder.

    You can now try out some of our APIs live, right here in the documentation.
    Log In

    Request Example

    cURL
    curl -X GET https://api.box.com/2.0/folders/4353455/metadata/enterprise_27335/blueprintTemplate \
         -H "Authorization: Bearer <ACCESS_TOKEN>"
    .NET
    Dictionary<string, object> metadata = await client.MetadataManager.
        .GetFolderMetadataAsync(folderId: "11111", "enterprise", "marketingCollateral");
    Java
    BoxFolder folder = new BoxFolder(api, "id");
    Metadata metadata = folder.getMetadata();
    
    // Unknown type metadata field, you can test for type or try to get as any type
    JsonValue unknownValue = metadata.getValue("/someField");
    
    // String or Enum metadata fields
    String stringValue = metadata.getString("/author");
    
    // Float metadata fields can be interpreted as any numeric type
    float floatValue = metadata.getFloat("/price");
    
    // Date metadata fields
    Date dateValue = metadata.getDate("/deadline");
    Python
    metadata = client.folder(folder_id='22222').metadata(scope='enterprise', template='myMetadata').get()
    print('Got metadata instance {0}'.format(metadata['$id']))
    Node
    client.folders.getMetadata('11111', client.metadata.scopes.ENTERPRISE, 'marketingCollateral')
    	.then(metadata => {
    		/* metadata -> {
    			audience: 'internal',
    			documentType: 'Q1 plans',
    			competitiveDocument: 'no',
    			status: 'active',
    			author: 'Jones',
    			currentState: 'proposal',
    			'$type': 'marketingCollateral-d086c908-2498-4d3e-8a1f-01e82bfc2abe',
    			'$parent': 'folder_11111',
    			'$id': '2094c584-68e1-475c-a581-534a4609594e',
    			'$version': 0,
    			'$typeVersion': 0,
    			'$template': 'marketingCollateral',
    			'$scope': 'enterprise_12345' }
    		*/
    	});

    Response Example

    {
      "$canEdit": true,
      "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
      "$parent": "folder_59449484661,",
      "$scope": "enterprise_27335",
      "$template": "blueprintTemplate",
      "$type": "blueprintTemplate-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
      "$typeVersion": 2,
      "$version": 1
    }