Get a taxonomy run's tree

GET

/v1/taxonomy/runs/{run_id}/tree

curl --request GET \
  --url 'http://localhost:8080/v1/taxonomy/runs/019f177f-9aa3-705e-8195-cea2aa187268/tree?tenant_id=org-123' \
  --header 'Authorization: Bearer <token>'

• Deployed Formbricks Hub instance (self-hosted or Formbricks Cloud)
• Formbricks staging Hub server
• Formbricks Cloud
• Formbricks Cloud (staging)
• Local development server

Returns the run and its taxonomy tree (visible nodes only; soft-removed nodes are excluded). Tenant-scoped; returns 404 if the run does not belong to the tenant.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

run_id

required

string format: uuid

Example

019f177f-9aa3-705e-8195-cea2aa187268

Taxonomy run ID.

Query Parameters

tenant_id

required

string

>= 1 characters <= 255 characters /^[^\x00]*$/

Example

org-123

Tenant that owns the run.

Responses

200

The run and its taxonomy tree

Media typeapplication/json

object

run

required

A persisted taxonomy generation run.

object

id

required

string format: uuid

scope_type

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.

string

Allowed values: field directory

tenant_id

required

string

source_type

required

string

source_id

required

Empty string is the canonical “no source” bucket.

string

field_id

required

string

field_label

Human-readable field label; absent when unknown.

string

status

required

Lifecycle state of a taxonomy run. Allowed transitions are pending -> running|failed|canceled and running -> succeeded|failed|canceled.

string

Allowed values: pending running succeeded failed canceled

params

Opaque run parameters recorded by Hub.

object

key

additional properties

any

metrics

Opaque run metrics recorded by the taxonomy service.

object

key

additional properties

any

record_count

required

integer format: int64

embedding_count

required

integer format: int64

cluster_count

required

integer format: int64

node_count

required

integer format: int64

error

Sanitized failure message; present on failed runs.

string

error_code

Machine-readable reason a taxonomy run failed or a prerequisite was not met.

string

Allowed values: insufficient_data service_unavailable generation_failed invalid_output internal_error

started_at

string format: date-time

finished_at

string format: date-time

created_at

required

string format: date-time

updated_at

required

string format: date-time

root

required

One of:

object

A node in a taxonomy tree. Non-root nodes have a parent; leaf nodes reference the cluster they summarize.

object

id

required

string format: uuid

run_id

required

string format: uuid

parent_id

Parent node ID; absent for the root node.

string format: uuid

cluster_id

Cluster this node summarizes; typically present on leaf nodes.

string format: uuid

node_type

required

Position of a node within the taxonomy tree.

string

Allowed values: root branch leaf

label

required

string

original_label

Label as originally generated, before any rename.

string

description

string

level

required

Depth in the tree; the root is level 0.

integer format: int64

sort_order

required

integer format: int64

metadata

object

key

additional properties

any

removed_at

Set when the node has been soft-removed.

string format: date-time

removed_by

Actor that soft-removed the node.

string

created_at

required

string format: date-time

updated_at

required

string format: date-time

children

Array<object> recursive

null

null

Example

{
  "run": {
    "scope_type": "field",
    "status": "pending",
    "error_code": "insufficient_data"
  },
  "root": {
    "node_type": "root"
  }
}

400

Bad Request (e.g. invalid run_id or missing/invalid tenant_id)

Media typeapplication/problem+json

RFC 9457 problem details (application/problem+json). Branch on the stable code member rather than on title or type.

object

code

required

Stable, machine-readable error code; the primary value to branch on. service_unavailable indicates a feature or dependency is temporarily unavailable and the request may be retried later. tenant_write_conflict indicates the write conflicted with an in-progress tenant data purge (or vice versa) and may be retried later unchanged. All other codes are terminal until the request itself is changed.

string

Allowed values: validation bad_request unauthorized forbidden not_found conflict tenant_write_conflict method_not_allowed content_too_large service_unavailable internal_server_error

detail

A human-readable explanation specific to this occurrence of the problem.

string

details

Optional structured context for this problem, e.g. resource_type on a 404.

object

key

additional properties

any

instance

A URI reference (typically the request path) identifying the specific occurrence of the problem.

string

invalid_params

Field-level validation failures (RFC 9457 “invalid_params” extension). Present on validation errors.

Array<object>

<= 100 items

A single invalid request parameter (RFC 9457 “invalid_params” extension member).

object

name

required

Dotted path to the offending request field, e.g. ‘field_type’ or ‘items[0].field_type’.

string

reason

required

Human- and agent-readable explanation of why the value is invalid, naming allowed values or constraints where applicable so the request can be corrected without guessing.

string

request_id

required

Identifier for this request, also returned in the X-Request-ID response header; include it when reporting a problem.

string

status

required

HTTP status code

integer format: int64

title

required

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference identifying the problem type.

string format: uri

Example

{
  "code": "validation",
  "detail": "One or more request parameters are invalid",
  "instance": "/v1/feedback-records",
  "invalid_params": [
    {
      "name": "field_type",
      "reason": "must be one of: text, categorical, nps, csat, ces, rating, number, boolean, date"
    }
  ],
  "request_id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "status": 400,
  "title": "Bad Request",
  "type": "https://hub.formbricks.com/problems/bad-request"
}

401

Unauthorized (missing or invalid API key)

Media typeapplication/problem+json

RFC 9457 problem details (application/problem+json). Branch on the stable code member rather than on title or type.

object

code

required

Stable, machine-readable error code; the primary value to branch on. service_unavailable indicates a feature or dependency is temporarily unavailable and the request may be retried later. tenant_write_conflict indicates the write conflicted with an in-progress tenant data purge (or vice versa) and may be retried later unchanged. All other codes are terminal until the request itself is changed.

string

Allowed values: validation bad_request unauthorized forbidden not_found conflict tenant_write_conflict method_not_allowed content_too_large service_unavailable internal_server_error

detail

A human-readable explanation specific to this occurrence of the problem.

string

details

Optional structured context for this problem, e.g. resource_type on a 404.

object

key

additional properties

any

instance

A URI reference (typically the request path) identifying the specific occurrence of the problem.

string

invalid_params

Field-level validation failures (RFC 9457 “invalid_params” extension). Present on validation errors.

Array<object>

<= 100 items

A single invalid request parameter (RFC 9457 “invalid_params” extension member).

object

name

required

Dotted path to the offending request field, e.g. ‘field_type’ or ‘items[0].field_type’.

string

reason

required

Human- and agent-readable explanation of why the value is invalid, naming allowed values or constraints where applicable so the request can be corrected without guessing.

string

request_id

required

Identifier for this request, also returned in the X-Request-ID response header; include it when reporting a problem.

string

status

required

HTTP status code

integer format: int64

title

required

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference identifying the problem type.

string format: uri

Example

{
  "code": "validation",
  "detail": "One or more request parameters are invalid",
  "instance": "/v1/feedback-records",
  "invalid_params": [
    {
      "name": "field_type",
      "reason": "must be one of: text, categorical, nps, csat, ces, rating, number, boolean, date"
    }
  ],
  "request_id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "status": 400,
  "title": "Bad Request",
  "type": "https://hub.formbricks.com/problems/bad-request"
}

404

Not Found – no run with this ID for the tenant.

Media typeapplication/problem+json

RFC 9457 problem details (application/problem+json). Branch on the stable code member rather than on title or type.

object

code

required

Stable, machine-readable error code; the primary value to branch on. service_unavailable indicates a feature or dependency is temporarily unavailable and the request may be retried later. tenant_write_conflict indicates the write conflicted with an in-progress tenant data purge (or vice versa) and may be retried later unchanged. All other codes are terminal until the request itself is changed.

string

Allowed values: validation bad_request unauthorized forbidden not_found conflict tenant_write_conflict method_not_allowed content_too_large service_unavailable internal_server_error

detail

A human-readable explanation specific to this occurrence of the problem.

string

details

Optional structured context for this problem, e.g. resource_type on a 404.

object

key

additional properties

any

instance

A URI reference (typically the request path) identifying the specific occurrence of the problem.

string

invalid_params

Field-level validation failures (RFC 9457 “invalid_params” extension). Present on validation errors.

Array<object>

<= 100 items

A single invalid request parameter (RFC 9457 “invalid_params” extension member).

object

name

required

Dotted path to the offending request field, e.g. ‘field_type’ or ‘items[0].field_type’.

string

reason

required

Human- and agent-readable explanation of why the value is invalid, naming allowed values or constraints where applicable so the request can be corrected without guessing.

string

request_id

required

Identifier for this request, also returned in the X-Request-ID response header; include it when reporting a problem.

string

status

required

HTTP status code

integer format: int64

title

required

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference identifying the problem type.

string format: uri

Example

{
  "code": "validation",
  "detail": "One or more request parameters are invalid",
  "instance": "/v1/feedback-records",
  "invalid_params": [
    {
      "name": "field_type",
      "reason": "must be one of: text, categorical, nps, csat, ces, rating, number, boolean, date"
    }
  ],
  "request_id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "status": 400,
  "title": "Bad Request",
  "type": "https://hub.formbricks.com/problems/bad-request"
}

default

Error

Media typeapplication/problem+json

RFC 9457 problem details (application/problem+json). Branch on the stable code member rather than on title or type.

object

code

required

Stable, machine-readable error code; the primary value to branch on. service_unavailable indicates a feature or dependency is temporarily unavailable and the request may be retried later. tenant_write_conflict indicates the write conflicted with an in-progress tenant data purge (or vice versa) and may be retried later unchanged. All other codes are terminal until the request itself is changed.

string

Allowed values: validation bad_request unauthorized forbidden not_found conflict tenant_write_conflict method_not_allowed content_too_large service_unavailable internal_server_error

detail

A human-readable explanation specific to this occurrence of the problem.

string

details

Optional structured context for this problem, e.g. resource_type on a 404.

object

key

additional properties

any

instance

A URI reference (typically the request path) identifying the specific occurrence of the problem.

string

invalid_params

Field-level validation failures (RFC 9457 “invalid_params” extension). Present on validation errors.

Array<object>

<= 100 items

A single invalid request parameter (RFC 9457 “invalid_params” extension member).

object

name

required

Dotted path to the offending request field, e.g. ‘field_type’ or ‘items[0].field_type’.

string

reason

required

Human- and agent-readable explanation of why the value is invalid, naming allowed values or constraints where applicable so the request can be corrected without guessing.

string

request_id

required

Identifier for this request, also returned in the X-Request-ID response header; include it when reporting a problem.

string

status

required

HTTP status code

integer format: int64

title

required

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference identifying the problem type.

string format: uri

Example

{
  "code": "validation",
  "detail": "One or more request parameters are invalid",
  "instance": "/v1/feedback-records",
  "invalid_params": [
    {
      "name": "field_type",
      "reason": "must be one of: text, categorical, nps, csat, ces, rating, number, boolean, date"
    }
  ],
  "request_id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "status": 400,
  "title": "Bad Request",
  "type": "https://hub.formbricks.com/problems/bad-request"
}