Sign in

v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB
Taxonomy

taxonomiesClassificationsSearch

List taxonomy classifications in an organization based on taxonomy slug

post/v1/entity/taxonomies/classifications:search

Query parameters

string
OR
string[]

The taxonomy slug(s) to search within. When provided with multiple taxonomy slugs, the search will be performed across all the provided taxonomies.

querystring
Example:sales

The label names to search for (lowercase insensitive)

archivedboolean

Filter by archived status. Deprecated. Use include_archived instead.

include_archived'true' | 'false' | 'only'

Whether to include archived labels in the search results

  • true: include archived labels
  • false: exclude archived labels
  • only: include only archived labels

By default, no archived labels are included in the search results.

'relation' | 'schema' | 'system'
OR
string[]

Taxonomy type(s) to exclude from the results. Useful to filter out relation labels, schema labels, and system labels.

Request body

Example request

{
  "classificationIds": [
    "taxonomy-slug:classification-slug"
  ]
}

Response

Returns the classifications for the taxonomy slug provided

hitsinteger

Example response

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