Manage Applications

    List enterprise templates

    get
    https://api.box.com/2.0
    /metadata_templates/enterprise

    Used to retrieve all metadata templates within a user's enterprise

    Request

    application/json

    Query Parameters

    integer / int64in queryoptional
    10001000-1000

    The maximum number of items to return per page.

    stringin queryoptional
    JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

    The position marker at which to begin the response.

    This requires usemarker to be set to true.

    Response

    application/jsonMetadata Templates

    Returns all of the metadata templates within an enterprise and their corresponding schema.

    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/metadata_templates/enterprise \
         -H "Authorization: Bearer <ACCESS_TOKEN>"
    .NET
    BoxEnterpriseMetadataTemplateCollection<BoxMetadataTemplate> templates = await client.MetadataManager
        .GetEnterpriseMetadataAsync();
    Java
    Iterable<MetadataTemplate> templates = MetadataTemplate.getEnterpriseMetadataTemplates(api);
    for (MetadataTemplate templateInfo : templates) {
        // Do something with the metadata template.
    }
    Python
    templates = client.get_metadata_templates()
    for template in templates:
        print('Metadata template {0} is in enterprise scope'.format(template.templateKey))
    Node
    client.metadata.getTemplates('enterprise')
    	.then(templates => {
    		/* templates -> {
    			limit: 100,
    			entries: 
    			[ { templateKey: 'documentFlow',
    				scope: 'enterprise_12345',
    				displayName: 'Document Flow',
    				hidden: false,
    				fields: 
    					[ { type: 'string',
    						key: 'currentDocumentStage',
    						displayName: 'Current Document Stage',
    						hidden: false }
    					{ type: 'string',
    						key: 'needsApprovalFrom',
    						displayName: 'Needs Approval From',
    						hidden: false },
    					{ type: 'string',
    						key: 'nextDocumentStage',
    						displayName: 'Next Document Stage',
    						hidden: false }
    					{ type: 'float',
    						key: 'maximumDaysAllowedInCurrentStage',
    						displayName: 'Maximum Days Allowed In Current Stage',
    						hidden: false }
    				{ templateKey: 'marketingCollateral',
    				scope: 'enterprise_12345',
    				displayName: 'Marketing Collateral',
    				hidden: false,
    				fields: 
    					[ { type: 'string',
    						key: 'audience1',
    						displayName: 'Audience',
    						hidden: false },
    					{ type: 'string',
    						key: 'previousState',
    						displayName: 'Previous State',
    						hidden: false } ] },
    				{ templateKey: 'productInfo',
    				scope: 'enterprise_12345',
    				displayName: 'Product Info',
    				hidden: false,
    				fields: 
    					[ { type: 'float',
    						key: 'skuNumber',
    						displayName: 'SKU Number',
    						hidden: false },
    					{ type: 'enum',
    						key: 'department',
    						displayName: 'Department',
    						hidden: false,
    						options: 
    						[ { key: 'Beauty' },
    						{ key: 'Shoes' },
    						{ key: 'Accessories' },
    						{ key: 'Clothing' },
    						{ key: 'Handbags' },
    						{ key: 'Bedding' },
    						{ key: 'Watches' } ] },
    					{ type: 'date',
    						key: 'displayDate',
    						displayName: 'Display Date',
    						hidden: false } ] } ],
    			next_marker: null,
    			prev_marker: null }
    		*/
    	});

    Response Example

    {
      "limit": 1000,
      "next_marker": 3000,
      "prev_marker": 1000,
      "entries": [
        {
          "scope": "enterprise_123456",
          "templateKey": "productInfo",
          "displayName": "Product Info",
          "hidden": true,
          "fields": [
            {
              "type": "string",
              "key": "category",
              "displayName": "Category",
              "description": "The category",
              "hidden": true,
              "options": [
                {
                  "id": "f7a9895f",
                  "key": "category1"
                }
              ]
            }
          ],
          "id": "f7a9891f"
        }
      ]
    }