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

Get metadata taxonomy node by ID

Retrieves a metadata taxonomy node by its identifier.

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

3 parameters
namespacestringrequired
The namespace of the metadata taxonomy.
taxonomy_keystringrequired
The key of the metadata taxonomy.
node_idstringrequired
The identifier of the metadata taxonomy node.

4 status codes
200Returns the metadata taxonomy node that matches the identifier.
idstringrequired
A unique identifier of the metadata taxonomy node.
displayNamestringrequired
The display name of the metadata taxonomy node.
levelintegerrequired
An index of the level to which the node belongs.
parentIdstringoptional
The identifier of the parent node.
nodePatharray<string>optional
An array of identifiers for all ancestor nodes. Not returned for root-level nodes.
ancestorsarray<MetadataTaxonomyAncestor>optional
An array of objects for all ancestor nodes. Not returned for root-level nodes.
400Returned if any of 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 if the taxonomy node with the given `node_id` 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 if any of the request parameters are not valid. A 404 is returned: Returned if the taxonomy node with the given node_id cannot be found. Any other status is an error: An unexpected client error.