Skip to main content
GET
/
metadata_templates
/
{namespace}
/
{template_key}
/
fields
/
{field_key}
/
options
List metadata template's options for taxonomy field
curl --request GET \
  --url https://api.box.com/2.0/metadata_templates/{namespace}/{template_key}/fields/{field_key}/options \
  --header 'Authorization: Bearer <token>'
{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
      "displayName": "France",
      "level": 2,
      "parentId": "99df4513-7102-4896-8228-94635ee9d330",
      "nodePath": [
        "99df4513-7102-4896-8228-94635ee9d330"
      ],
      "ancestors": [
        {
          "id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
          "displayName": "France",
          "level": 2
        }
      ]
    }
  ]
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
namespace
string
required

The namespace of the metadata taxonomy.

​
template_key
string
required

The name of the metadata template.

​
field_key
string
required

The key of the metadata taxonomy field in the template.

Query Parameters

​
level
integer[]

Filters results by taxonomy level. Multiple values can be provided. Results include nodes that match any of the specified values.

​
parent
string[]

Node identifier of a direct parent node. Multiple values can be provided. Results include nodes that match any of the specified values.

​
ancestor
string[]

Node identifier of any ancestor node. Multiple values can be provided. Results include nodes that match any of the specified values.

​
query
string

Query text to search for the taxonomy nodes.

​
include-total-result-count
boolean

When set to true this provides the total number of nodes that matched the query. The response will compute counts of up to 10,000 elements. Defaults to false.

​
only-selectable-options
boolean

When set to true, this only returns valid selectable options for this template taxonomy field. Otherwise, it returns all taxonomy nodes, whether or not they are selectable. Defaults to true.

​
marker
string

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.

​
limit
integer<int64>

The maximum number of items to return per page.

Required range: x <= 1000

Response

Returns a list of the taxonomy nodes that match the specified parameters.

A list of metadata taxonomy nodes.

​
limit
integer<int64>

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

Example:

1000

​
next_marker
string | null

The marker for the start of the next page of results.

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

​
prev_marker
string | null

The marker for the start of the previous page of results.

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"

​
entries
Metadata taxonomy node · object[]

A list of metadata taxonomy nodes.