FOformbricks
Taxonomy

Get the active taxonomy tree for a scope

Changed on

Returns the currently active taxonomy run and its tree for a field or directory scope. Exactly one run is active per scope at a time. Returns 404 when no run has been activated for the scope.

get/v1/taxonomy/runs/active/tree

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/v1/taxonomy/runs/active/tree
  • Auth
    HTTP bearer

Query parameters

tenant_idstring required
Example:org-123

Tenant that owns the scope.

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.

Scope type. Omit for field scope; use directory with tenant_id only for directory taxonomy.

source_typestring

Source type of a field scope. Must be omitted for directory scope.

source_idstring

Source ID of the scope; empty string is the canonical "no source" bucket.

field_idstring

Field ID of a field scope. Must be omitted for directory scope.

Response

The active run and its taxonomy tree

Changes

  • 9c7d3d5bde69Revision changes
    • info

      added the new optional query request parameter scope_type

    • info

      the query request parameter field_id became optional

    • info

      the query request parameter source_type became optional

    • info

      added the required property / to the response with the status

  • 8c375b05c949Revision changes
    • info

      endpoint added