---
title: "taxonomiesClassificationsSearch"
method: POST
path: "/v1/entity/taxonomies/classifications:search"
tags: ["Taxonomy"]
---

# taxonomiesClassificationsSearch

`POST /v1/entity/taxonomies/classifications:search`

List taxonomy classifications in an organization based on taxonomy slug

## Query parameters

- `taxonomySlug` union
  - string
  - string[]
- `query` string
- `archived` boolean
- `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.
- `exclude_types` union
  - 'relation' | 'schema' | 'system'
  - string[]

## Request body

- object
  - `classificationIds` ClassificationIdOrPattern[]
    - union
      - string
      - object
        - `pattern` string, required — Wildcard pattern to match classification IDs starting with the prefix before ':*'

## Response `200`

Returns the classifications for the taxonomy slug provided

- object
  - `results` TaxonomyClassification[]
    - `id` string
    - `slug` string, required — URL-friendly identifier for the classification
    - `name` string, required
    - `parents` ClassificationId[]
    - `color` string — Color of the classification
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `archived` boolean — Archived classification are not visible in the UI
    - `starred` boolean — Starred taxonomy classifications can represent "favorites" or commonly used classifications
    - `enabled_locations` union[] — List of locations where the classification is enabled to be used. If empty, it's enabled for all locations.
      - union
        - 'account' | 'contact' | 'contract' | 'email_template' | 'file' | 'journey' | 'meter_counter' | 'meter' | 'opportunity' | 'order' | 'partner' | 'price' | 'product' | 'submission' | 'tax' | 'message' | 'portal_user' | 'request' | 'comment' | 'user'
        - string
    - `enabled_purposes` string[] — List of purpose slugs where the classification is enabled to be used. If empty, it's enabled for all purposes.
    - `_manifest` string[], nullable — Manifest ID used to create/update the taxonomy classification
  - `hits` integer

## Other responses

- `429` — Too many requests

---

[API](https://skmtc.net/epilot/apis/entity-api.md) · [All operations](https://skmtc.net/epilot/apis/entity-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/epilot/entity-api/revisions/3020984570dc/schema)