> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get metadata template by ID
> Retrieves a metadata template by its ID.
This endpoint is in the version **2024.0**. No changes are required to continue using it. For more details, see **[Box API versioning](/guides/api-calls/api-versioning-strategy)**.
Learn more about [Box SDK versioning strategy](/guides/tooling/sdks/sdk-versioning/).
## OpenAPI
````yaml box-openapi.json get /metadata_templates/{template_id}
openapi: 3.0.2
info:
title: Box Platform API
description: >-
[Box Platform](https://developer.box.com) provides functionality to provide
access to content stored within [Box](https://box.com). It provides
endpoints for basic manipulation of files and folders, management of users
within an enterprise, as well as more complex topics such as legal holds and
retention policies.
termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
contact:
name: Box, Inc
url: https://developer.box.com
email: devrel@box.com
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '2024.0'
x-box-commit-hash: 3d705a6550
servers:
- url: https://api.box.com/2.0
description: Box Platform API server.
security:
- OAuth2Security: []
tags:
- name: AI
description: A set of endpoints used to interact with supported LLMs.
x-box-tag: ai
- name: AI Studio
description: A set of endpoints used to interact with AI Studio.
x-box-tag: ai_studio
- name: App item associations
x-box-tag: app_item_associations
- name: Authorization
description: A set of endpoints used to manage user authorization process.
x-box-tag: authorization
x-box-priority: true
- name: Box Sign requests
description: Box Sign requests are used to submit a file for signature.
x-box-tag: sign_requests
- name: Classifications
description: >-
Classification labels are used for content that is sensitive or under
security restrictions.
x-box-tag: classifications
- name: Classifications on files
description: >-
Classification labels are used for files that are sensitive or under
security restrictions.
x-box-tag: file_classifications
- name: Classifications on folders
description: >-
Classification labels are used for folders that are sensitive or under
security restrictions.
x-box-tag: folder_classifications
- name: Collaborations
description: >-
Collaborations define access permissions for users and groups to files and
folders, similar to access control lists.
x-box-tag: user_collaborations
- name: Collaborations (List)
description: >-
A set of endpoints used to retrieve file, folder, pending, and group
collaborations.
x-box-tag: list_collaborations
- name: Collections
description: >-
Collections are a way to group files, folders, and web links without
putting them all into a folder.
x-box-tag: collections
- name: Comments
description: >-
Comments are messages generated users on files, allowing users to
collaborate on a file, discussing any feedback they might have on the
content.
x-box-tag: comments
- name: Device pinners
description: >-
Device pinners allow enterprises to control what devices can use native
Box applications.
x-box-tag: device_pinners
- name: Domain restrictions (User exemptions)
description: >-
A set of endpoints that allow exempting users from restrictions imposed by
the list of allowed collaboration domains for a specific enterprise.
x-box-tag: collaboration_allowlist_exempt_targets
- name: Domain restrictions for collaborations
description: >-
A set of endpoints that manage domains for which users can collaborate
with files and folders in an enterprise.
x-box-tag: collaboration_allowlist_entries
- name: Downloads
description: >-
Downloads allow saving files to the application's server, or directly by
the end user in a browser.
x-box-tag: downloads
- name: Email aliases
description: >-
Email aliases provide a list of emails additional to the user's primary
login email.
x-box-tag: email_aliases
- name: Events
description: >-
Events provide a way for an application to subscribe to any actions
performed by any user, users, or service in an enterprise.
x-box-tag: events
- name: File requests
description: >-
File Requests provide a fast and secure way to request files and
associated metadata from anyone. Users can create new file requests based
on an existing file request, update file request settings, activate,
deactivate, and delete file requests programmatically.
x-box-tag: file_requests
- name: File version legal holds
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated. A File Version Legal Hold represents all the
policies that are assigned to a specific file version.
x-box-tag: file_version_legal_holds
- name: File version retentions
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. A file version retention is a record for a retained file.
x-box-tag: file_version_retentions
- name: File versions
description: A set of endpoints used to manage specific versions of a file.
x-box-tag: file_versions
- name: Files
description: >-
Files, together with Folders, are at the core of the Box API. Files can be
uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: files
- name: Folder Locks
description: >-
Folder locks define access restrictions placed by folder owners to prevent
specific folders from being moved or deleted.
x-box-tag: folder_locks
- name: Folders
description: >-
Folders, together with Files, are at the core of the Box API. Folders can
be uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: folders
- name: Integration mappings
description: >-
Integration Mappings allow the users to manage where content from partner
apps is stored in Box.
x-box-tag: integration_mappings
- name: Group memberships
description: Group memberships signify that a user is a part of the group.
x-box-tag: memberships
- name: Groups
description: Groups created in an enterprise.
x-box-tag: groups
- name: Invites
description: Invites are used to invite the user to an enterprise.
x-box-tag: invites
- name: Legal hold policies
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated.
x-box-tag: legal_hold_policies
- name: Legal hold policy assignments
description: >-
A Legal Hold Policy Assignment is a relation between a policy and
custodian. In this case, as custodian can be a user, folder, file, or file
version.
x-box-tag: legal_hold_policy_assignments
- name: Metadata cascade policies
description: >-
A metadata cascade policy describes how metadata instances applied to a
folder should be applied to any item within that folder.
x-box-tag: metadata_cascade_policies
- name: Metadata instances (Files)
description: >-
A metadata instance describes the relation between a template and a file,
including the values that are assigned for every field.
x-box-tag: file_metadata
- name: Metadata instances (Folders)
description: >-
A metadata instance describes the relation between a template and a
folder, including the values that are assigned for every field.
x-box-tag: folder_metadata
- name: Metadata taxonomies
description: >-
A metadata taxonomy is a hierarchical classification system that helps
organize and manage metadata within an enterprise.
x-box-tag: metadata_taxonomies
- name: Metadata templates
description: >-
A metadata template describes a reusable set of key/value pairs that can
be assigned to a file.
x-box-tag: metadata_templates
- name: Recent items
description: >-
Recent items represent items such as files or folders that the user
accessed recently.
x-box-tag: recent_items
- name: Retention policies
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. Admins can create retention policies and then assign them
to specific folders or their entire enterprise.
x-box-tag: retention_policies
- name: Retention policy assignments
description: >-
A Retention Policy Assignment is a relation between a policy and folder or
enterprise. Creating an assignment puts a retention on all the file
versions that belong to that folder or enterprise.
x-box-tag: retention_policy_assignments
- name: Search
description: >-
The Box API provides a way to find content in Box using full-text search
queries.
x-box-tag: search
- name: Session termination
description: >-
Session termination API is used to validate the roles and permissions of
the group, and creates asynchronous jobs to terminate the group's
sessions.
x-box-tag: session_termination
- name: Shared links (Files)
description: >-
Files shared links are URLs that are generated for files stored in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_files
- name: Shared links (Folders)
description: >-
Folders shared links are URLs that are generated for folders stored in
Box, which provide direct, read-only access to the resource.
x-box-tag: shared_links_folders
- name: Shared links (Web Links)
description: >-
Web links for files are URLs that are generated for web links in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_web_links
- name: Shared links (App Items)
description: >-
URLs generated for app items stored in Box, which provide direct,
read-only access to the resource.
x-box-tag: shared_links_app_items
- name: Shield information barriers
description: >-
Shield information barrier in Box defines an ethical wall. An ethical wall
is a mechanism that prevents exchanges or communication that could lead to
conflicts of interest and therefore result in business activities
ethically or legally questionable.
x-box-tag: shield_information_barriers
- name: Shield information barrier segments
description: >-
Shield information barrier segment represents a defined group of users. A
user can be a member of only one segment, which makes segments different
from groups.
x-box-tag: shield_information_barrier_segments
- name: Shield information barrier segment members
description: >-
Shield information barrier segment member represents a user that is
assigned to a specific segment.
x-box-tag: shield_information_barrier_segment_members
- name: Shield information barrier reports
description: >-
Shield information barrier reports contain information on what existing
collaborations will be removed permanently when the information barrier is
enabled.
x-box-tag: shield_information_barrier_reports
- name: Shield information barrier segment restrictions
description: >-
Shield information barrier segment restriction is an access restriction
based on the content (file or folder) owner.
x-box-tag: shield_information_barrier_segment_restrictions
- name: Box Sign templates
description: >-
Sign templates allow you to use a predefined Box Sign template when
creating a signature request. The template includes placeholders that are
automatically populated with data when creating the request.
x-box-tag: sign_templates
- name: Skills
description: >-
Box Skills are designed to allow custom processing of files uploaded to
Box, with the intent of enhancing the underlying metadata of the file.
x-box-tag: skills
- name: Standard and Zones Storage Policies
description: >-
Storage policy assignment represents the storage zone for items in a given
enterprise.
x-box-tag: storage_policies
- name: Standard and Zones Storage Policy Assignments
description: >-
Storage policy assignment represents the relation between storage zone and
the assigned item (for example a file stored in a specific zone).
x-box-tag: storage_policy_assignments
- name: Task assignments
description: >-
A task assignment defines which task is assigned to which user to
complete.
x-box-tag: task_assignments
- name: Tasks
description: >-
Tasks allow users to request collaborators on a file to review a file or
complete a piece of work. Tasks can be used by developers to create
file-centric workflows.
x-box-tag: tasks
- name: Terms of service
description: A set of endpoints used to manage terms of service agreements.
x-box-tag: terms_of_services
- name: Terms of service user statuses
description: >-
A set of endpoints used to manage the status of terms of service for a
particular user.
x-box-tag: terms_of_service_user_statuses
- name: Transfer folders
description: >-
API designed to move all of the items (files, folders and workflows) owned
by a user into another user's account.
x-box-tag: transfer
- name: Trashed files
description: Files that were deleted and are in trash.
x-box-tag: trashed_files
- name: Trashed folders
description: Folders that were deleted and are in trash.
x-box-tag: trashed_folders
- name: Trashed items
description: Items that were deleted and are in trash.
x-box-tag: trashed_items
- name: Trashed web links
description: Web links that were deleted and are in trash.
x-box-tag: trashed_web_links
- name: Uploads
description: >-
The direct file upload API supports files up to 50MB in size and sends all
the binary data to the Box API in 1 API request.
x-box-tag: uploads
- name: Uploads (Chunked)
description: >-
The chunked upload endpoints support files from 20MB in size and allow an
application to upload the file in parts, allowing for more control to
catch any errors and retry parts individually.
x-box-tag: chunked_uploads
- name: User avatars
description: >-
User avatars are JPG or PNG files uploaded to Box to represent the user
image. They are then displayed in the user account.
x-box-tag: avatars
- name: Users
description: >-
Box API supports a variety of users, ranging from real employees logging
in with their Managed User account, to applications using App Users to
drive powerful automation workflows.
x-box-tag: users
- name: Watermarks (Files)
description: >-
A watermark is a semi-transparent overlay on an embedded file preview that
displays a viewer's email address or user ID and the time of access over
the file.
x-box-tag: file_watermarks
- name: Watermarks (Folders)
description: >-
A watermark is a semi-transparent overlay on an embedded folder preview
that displays a viewer's email address or user ID and the time of access
over the folder content.
x-box-tag: folder_watermarks
- name: Web links
description: >-
Web links are objects that point to URLs. These objects are also known as
bookmarks within the Box web application.
x-box-tag: web_links
- name: Webhooks
description: >-
Webhooks allow you to monitor Box content for events, and receive
notifications to a URL of your choice when they occur. For example, a
workflow may include waiting for a file to be downloaded to delete a
shared link.
x-box-tag: webhooks
- name: Workflows
description: >-
Box Relay Workflows are objects that represent a named collection of
flows.
x-box-tag: workflows
- name: Zip Downloads
description: >-
Zip downloads represent a successful request to create a ZIP archive with
files and folders.
x-box-tag: zip_downloads
externalDocs:
description: Box Developer Documentation.
url: https://developer.box.com
paths:
/metadata_templates/{template_id}:
get:
tags:
- Metadata templates
summary: Get metadata template by ID
description: Retrieves a metadata template by its ID.
operationId: get_metadata_templates_id
parameters:
- name: template_id
in: path
description: The ID of the template.
required: true
schema:
type: string
example: f7a9891f
responses:
'200':
description: Returns the metadata template that matches the ID.
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataTemplate'
'400':
description: >-
Returned if any of the request parameters are not valid.
- `bad_request`: Often returned with a message when the ID of the
template is not recognised.
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataTemplate'
default:
description: An unexpected client error.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
x-codeSamples:
- lang: curl
label: Get metadata template by ID
source: >-
curl -i -X GET
"https://api.box.com/2.0/metadata_templates/d9671692-3df6-11ea-b77f-2e728ce88125"
\
-H "authorization: Bearer "
- lang: dotnet
label: Get metadata template by ID
source: >-
await
client.MetadataTemplates.GetMetadataTemplateByIdAsync(templateId:
template.Id);
- lang: swift
label: Get metadata template by ID
source: >-
try await
client.metadataTemplates.getMetadataTemplateById(templateId:
template.id)
- lang: java
label: Get metadata template by ID
source: >-
client.getMetadataTemplates().getMetadataTemplateById(template.getId())
- lang: node
label: Get metadata template by ID
source: await client.metadataTemplates.getMetadataTemplateById(template.id);
- lang: python
label: Get metadata template by ID
source: client.metadata_templates.get_metadata_template_by_id(template.id)
components:
schemas:
MetadataTemplate:
description: A template for metadata that can be applied to files and folders.
type: object
properties:
id:
description: The ID of the metadata template.
type: string
example: 58063d82-4128-7b43-bba9-92f706befcdf
type:
description: The value will always be `metadata_template`.
type: string
example: metadata_template
enum:
- metadata_template
nullable: false
scope:
description: >-
The scope of the metadata template can either be `global` or
`enterprise_*`. The `global` scope is used for templates that are
available to any Box enterprise. The `enterprise_*` scope represents
templates that have been created within a specific enterprise, where
`*` will be the ID of that enterprise.
type: string
example: enterprise_123456
templateKey:
description: >-
A unique identifier for the template. This identifier is unique
across the `scope` of the enterprise to which the metadata template
is being applied, yet is not necessarily unique across different
enterprises.
type: string
example: productInfo
maxLength: 64
pattern: ^[a-zA-Z_][-a-zA-Z0-9_]*$
displayName:
description: >-
The display name of the template. This can be seen in the Box web
app and mobile apps.
type: string
example: Product Info
maxLength: 4096
hidden:
description: >-
Defines if this template is visible in the Box web app UI, or if it
is purely intended for usage through the API.
type: boolean
example: true
fields:
description: >-
An ordered list of template fields which are part of the template.
Each field can be a regular text field, date field, number field, as
well as a single or multi-select list.
type: array
items:
type: object
description: >-
A field within a metadata template. Fields can be a basic text,
date, or number field, or a list of options.
allOf:
- title: Metadata Field (Read)
description: >-
A field within a metadata template. Fields can be a basic
text, date, or number field, or a list of options.
required:
- type
- key
- displayName
type: object
properties:
type:
description: >-
The type of field. The basic fields are a `string` field
for text, a `float` field for numbers, and a `date` fields
to present the user with a date-time picker.
Additionally, metadata templates support an `enum` field
for a basic list of items, and ` multiSelect` field for a
similar list of items where the user can select more than
one value.
**Note**: The `integer` value is deprecated. It is still
present in the response, but cannot be used in the POST
request.
type: string
example: string
enum:
- string
- float
- date
- enum
- multiSelect
- integer
- taxonomy
key:
description: >-
A unique identifier for the field. The identifier must be
unique within the template to which it belongs.
type: string
example: category
maxLength: 256
displayName:
description: >-
The display name of the field as it is shown to the user
in the web and mobile apps.
type: string
example: Category
maxLength: 4096
description:
description: A description of the field. This is not shown to the user.
type: string
example: The category
maxLength: 4096
hidden:
description: >-
Whether this field is hidden in the UI for the user and
can only be set through the API instead.
type: boolean
example: true
options:
description: >-
A list of options for this field. This is used in
combination with the `enum` and `multiSelect` field types.
type: array
items:
title: Metadata Option (Write)
type: object
description: >-
An option for a Metadata Template Field.
Options only need to be provided for fields of type
`enum` and `multiSelect`. Options represent the value(s)
a user can select for the field either through the UI or
through the API.
required:
- key
properties:
key:
description: >-
The text value of the option. This represents both
the display name of the option and the internal key
used when updating templates.
type: string
example: Category 1
- properties:
id:
description: The unique ID of the metadata template field.
type: string
example: 822227e0-47a5-921b-88a8-494760b2e6d2
options:
description: >-
A list of options for this field. This is used in
combination with the `enum` and `multiSelect` field types.
type: array
items:
type: object
description: >-
An option for a Metadata Template Field.
Options are only present for fields of type `enum` and
`multiSelect`. Options represent the value(s) a user can
select for the field either through the UI or through
the API.
allOf:
- title: Metadata Option (Write)
type: object
description: >-
An option for a Metadata Template Field.
Options only need to be provided for fields of type
`enum` and `multiSelect`. Options represent the
value(s) a user can select for the field either
through the UI or through the API.
required:
- key
properties:
key:
description: >-
The text value of the option. This represents
both the display name of the option and the
internal key used when updating templates.
type: string
example: Category 1
- properties:
id:
description: The internal unique identifier of the option.
type: string
example: 45dc2849-a4a7-40a9-a751-4a699a589190
copyInstanceOnItemCopy:
description: >-
Whether or not to include the metadata when a file or folder is
copied.
type: boolean
example: true
required:
- type
- id
title: Metadata template
x-box-resource-id: metadata_template
x-box-tag: metadata_templates
ClientError:
description: A generic error.
type: object
properties:
type:
description: The value will always be `error`.
type: string
example: error
enum:
- error
nullable: false
status:
description: The HTTP status of the response.
type: integer
format: int32
example: 400
nullable: false
code:
description: A Box-specific error code.
type: string
example: item_name_invalid
enum:
- created
- accepted
- no_content
- redirect
- not_modified
- bad_request
- unauthorized
- forbidden
- not_found
- method_not_allowed
- conflict
- precondition_failed
- too_many_requests
- internal_server_error
- unavailable
- item_name_invalid
- insufficient_scope
message:
description: A short message describing the error.
type: string
example: Method Not Allowed
nullable: false
context_info:
description: >-
A free-form object that contains additional context about the error.
The possible fields are defined on a per-endpoint basis. `message`
is only one example.
type: object
example:
message: Something went wrong
additionalProperties: {}
nullable: true
help_url:
description: A URL that links to more information about why this error occurred.
type: string
example: >-
https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
nullable: false
request_id:
description: >-
A unique identifier for this response, which can be used when
contacting Box support.
type: string
example: abcdef123456
nullable: false
title: Client error
x-box-resource-id: client_error
securitySchemes:
OAuth2Security:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://account.box.com/api/oauth2/authorize
tokenUrl: https://api.box.com/oauth2/token
scopes:
root_readonly: Read all files and folders stored in Box
root_readwrite: Read and write all files and folders stored in Box
manage_app_users: Provision and manage app users
manage_managed_users: Provision and manage managed users
manage_groups: Manage an enterprise's groups
manage_webhook: Create webhooks programmatically through the API
manage_enterprise_properties: Manage enterprise properties
manage_data_retention: Manage data retention polices
manage_legal_hold: Manage Legal Holds
````