Sample - Box Platform API
GET/metadata_taxonomies/{namespace}/{taxonomy_key}

Get metadata taxonomy by taxonomy key

Used to retrieve a metadata taxonomy by taxonomy key.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
namespacestringrequired
The namespace of the metadata taxonomy.
taxonomy_keystringrequired
The key of the metadata taxonomy.

4 status codes
200Returns the metadata taxonomy identified by the taxonomy key.
idstringrequired
A unique identifier of the metadata taxonomy.
keystringoptional
A unique identifier of the metadata taxonomy. The identifier must be unique within the namespace to which it belongs.
displayNamestringrequired
The display name of the metadata taxonomy. This can be seen in the Box web app.
namespacestringrequired
A namespace that the metadata taxonomy is associated with.
levelsarray<MetadataTaxonomyLevel>optional
Levels of the metadata taxonomy.
400Returned when the request parameters are not valid.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
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.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
404Returned when a taxonomy with the given `namespace` and `taxonomy_key` cannot be found.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
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.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
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.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 400 is returned: Returned when the request parameters are not valid. A 404 is returned: Returned when a taxonomy with the given namespace and taxonomy_key cannot be found. Any other status is an error: An unexpected client error.