---
title: "List taxonomy runs"
method: GET
path: "/v1/taxonomy/runs"
tags: ["Taxonomy"]
---

# List taxonomy runs

`GET /v1/taxonomy/runs`

Returns taxonomy run history for a tenant, most recent first. Optionally filter by scope_type,
source_type, field_id, and source_id. source_id is a tri-state filter: omit it for no source
filter, pass an empty string to scope to the canonical "no source" bucket, or pass a concrete
value to match that source.

## Query parameters

- `tenant_id` string, required
- `scope_type` 'field' | 'directory' — Taxonomy input scope. `field` covers one (source_type, source_id, field_id) field scope. `directory` covers all text feedback records for the tenant/directory and must not include source_type, source_id, or field_id.
- `source_type` string
- `source_id` string
- `field_id` string
- `limit` integer

## Response `200`

Taxonomy run history

- ListTaxonomyRunsOutputBody
  - `data` TaxonomyRunData[], required
    - `id` string, uuid, required
    - `scope_type` 'field' | 'directory', required — Taxonomy input scope. `field` covers one (source_type, source_id, field_id) field scope. `directory` covers all text feedback records for the tenant/directory and must not include source_type, source_id, or field_id.
    - `tenant_id` string, required
    - `source_type` string, required
    - `source_id` string, required — Empty string is the canonical "no source" bucket.
    - `field_id` string, required
    - `field_label` string — Human-readable field label; absent when unknown.
    - `status` 'pending' | 'running' | 'succeeded' | 'failed' | 'canceled', required — Lifecycle state of a taxonomy run. Allowed transitions are pending -> running|failed|canceled and running -> succeeded|failed|canceled.
    - `params` object — Opaque run parameters recorded by Hub.
    - `metrics` object — Opaque run metrics recorded by the taxonomy service.
    - `record_count` integer, required
    - `embedding_count` integer, required
    - `cluster_count` integer, required
    - `node_count` integer, required
    - `error` string — Sanitized failure message; present on failed runs.
    - `error_code` 'insufficient_data' | 'service_unavailable' | 'generation_failed' | 'invalid_output' | 'internal_error' — Machine-readable reason a taxonomy run failed or a prerequisite was not met.
    - `started_at` string, date-time
    - `finished_at` string, date-time
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `400` — Bad Request (e.g. missing/invalid tenant_id or query parameters)
- `401` — Unauthorized (missing or invalid API key)
- `default` — Error

---

[API](https://skmtc.net/formbricks/apis/formbricks-hub-api.md) · [All operations](https://skmtc.net/formbricks/apis/formbricks-hub-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/formbricks/formbricks-hub-api/revisions/8d06d9728138/schema)