Join BoxWorks 2024 to discover what's possible with content and AI!

List all global metadata templates

get

https://api.box.com/2.0

/metadata_templates/global

Used to retrieve all generic, global metadata templates available to all enterprises using Box.

Related Guides

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Query Parameters

limit integer (int64)in queryoptional

example1000max1000

The maximum number of items to return per page.

marker stringin queryoptional

exampleJV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

Response

200application/jsonMetadata templates

Returns all of the metadata templates available to all enterprises and their corresponding schema.

400application/jsonClient error

Returned when the request parameters are not valid.

defaultapplication/jsonClient error

An unexpected client error.

get

List all global metadata templates

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

Request Example

cURL

curl -i -X GET "https://api.box.com/2.0/metadata_templates/global" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

TypeScript Gen

await client.metadataTemplates.getGlobalMetadataTemplates();

Python Gen

client.metadata_templates.get_global_metadata_templates()

.NET Gen

await client.MetadataTemplates.GetGlobalMetadataTemplatesAsync();

Swift Gen (Beta)

try await client.metadataTemplates.getGlobalMetadataTemplates()

Java

Iterable<MetadataTemplate> templates = MetadataTemplate.getEnterpriseMetadataTemplates('global', api);
for (MetadataTemplate templateInfo : templates) {
    // Do something with the metadata template.
}

Python

templates = client.get_metadata_templates(scope='global)
for template in templates:
    print(f'Metadata template {template.templateKey} is in global scope')

.NET

BoxEnterpriseMetadataTemplateCollection<BoxMetadataTemplate> templates = await client.MetadataManager
    .GetEnterpriseMetadataAsync("global");

Node

client.metadata.getTemplates('global')
	.then(templates => {
		// ...
	});

iOS

let iterator = client.metadata.listEnterpriseTemplates(scope: "global")
iterator.next { results in
    switch results {
    case let .success(page):
        for template in page.entries {
            print("Template name: \(template.displayName)")
        }

    case let .failure(error):
        print(error)
    }
}

Response Example

{
  "entries": [
    {
      "id": "58063d82-4128-7b43-bba9-92f706befcdf",
      "type": "metadata_template",
      "scope": "enterprise_123456",
      "templateKey": "productInfo",
      "displayName": "Product Info",
      "hidden": true,
      "fields": [
        {
          "type": "string",
          "key": "category",
          "displayName": "Category",
          "description": "The category",
          "hidden": true,
          "options": [
            {
              "key": "Category 1",
              "id": "45dc2849-a4a7-40a9-a751-4a699a589190"
            }
          ],
          "id": "822227e0-47a5-921b-88a8-494760b2e6d2"
        }
      ],
      "copyInstanceOnItemCopy": true
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}