Box Developer Documentation
 
    Latest version

    Get metadata template by ID

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

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

    Retrieves a metadata template by its ID.

    Request

    bearer [ACCESS_TOKEN]
    application/json

    Path Parameters

    stringin pathrequired
    f7a9891f

    The ID of the template

    Response

    application/jsonMetadata template

    Returns the metadata template that matches the ID.

    application/jsonMetadata template

    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.
    application/jsonClient error

    An unexpected client error.

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

    Request Example

    cURL
    curl -i -X GET "https://api.box.com/2.0/metadata_templates/d9671692-3df6-11ea-b77f-2e728ce88125" \
         -H "authorization: Bearer <ACCESS_TOKEN>"

    Response Example

    {
      "id": "58063d82-4128-7b43-bba9-92f706befcdf",
      "type": "metadata_template",
      "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,
      "scope": "enterprise_123456",
      "templateKey": "productInfo"
    }