Sign in

v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB
Taxonomy

getTaxonomyClassification

Get a classification for a taxonomy by slug

For backwards compatibility with purposes, you can also pass the classification id instead of the slug.

get/v2/entity/taxonomies/classifications/{classificationSlug}

Path parameters

classificationSlugstring required

Taxonomy Classification slug

Response

Taxonomy classification

idstring
slugstring required

URL-friendly identifier for the classification

namestring required
parentsClassificationId[]
colorstring

Color of the classification

created_atstring date-time
updated_atstring date-time
archivedboolean

Archived classification are not visible in the UI

starredboolean

Starred taxonomy classifications can represent "favorites" or commonly used classifications

enabled_purposesstring[]

List of purpose slugs where the classification is enabled to be used. If empty, it's enabled for all purposes.

_manifeststring[] nullable

Manifest ID used to create/update the taxonomy classification

Example response

{
  "id": "taxonomy-slug:classification-slug",
  "slug": "wallbox-pv",
  "name": "Wallbox PV",
  "parents": [
    "taxonomy-slug:classification-slug"
  ],
  "color": "#FF5733",
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}