Box Developer Documentation
Log in
Latest version

Find metadata template by instance ID

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

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Finds a metadata template by searching for the ID of an instance of the template.

Request

bearer [ACCESS_TOKEN]
application/json

Query Parameters

integer (int64)in queryoptional
1000
1000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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.

string (uuid)in queryrequired
01234500-12f1-1234-aa12-b1d234cb567e

The ID of an instance of the metadata template to find.

Response

application/jsonMetadata templates

Returns a list containing the 1 metadata template that matches the instance ID.

application/jsonClient error

Returned when the request parameters are not valid.

application/jsonClient error

An unexpected client error.

get
Find metadata template by instance ID
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


Node/TypeScript v10
await client.metadataTemplates.getMetadataTemplatesByInstanceId({
  metadataInstanceId: createdMetadataInstance.id!,
} satisfies GetMetadataTemplatesByInstanceIdQueryParams);
Python v10
client.metadata_templates.get_metadata_templates_by_instance_id(
    created_metadata_instance.id
)
.NET v10
await client.MetadataTemplates.GetMetadataTemplatesByInstanceIdAsync(queryParams: new GetMetadataTemplatesByInstanceIdQueryParams(metadataInstanceId: NullableUtils.Unwrap(createdMetadataInstance.Id)));
Swift v10
try await client.metadataTemplates.getMetadataTemplatesByInstanceId(queryParams: GetMetadataTemplatesByInstanceIdQueryParams(metadataInstanceId: createdMetadataInstance.id!))
Java v10
client.getMetadataTemplates().getMetadataTemplatesByInstanceId(new GetMetadataTemplatesByInstanceIdQueryParams(createdMetadataInstance.getId()))

Response Example

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