Skip to content
Support

API Reference

Libraries

npm install @formbricks/hub

API Overview

Health

Health check
GET/health

Feedback Records

List feedback records with filters
GET/v1/feedback-records
Create a new feedback record
POST/v1/feedback-records
Delete feedback records by user ID
DELETE/v1/feedback-records
Get a feedback record by ID
GET/v1/feedback-records/{id}
Delete a feedback record
DELETE/v1/feedback-records/{id}
Update a feedback record
PATCH/v1/feedback-records/{id}
Get similar feedback records
GET/v1/feedback-records/{id}/similar

Feedback RecordsSearch

Semantic search over feedback records
POST/v1/feedback-records/search/semantic

Webhooks

List webhooks
GET/v1/webhooks
Create a webhook
POST/v1/webhooks
Get a webhook by ID
GET/v1/webhooks/{id}
Update a webhook
PATCH/v1/webhooks/{id}
Delete a webhook
DELETE/v1/webhooks/{id}

Tenants

Delete tenant data
DELETE/v1/tenants/{tenant_id}/data

TenantsSettings

Get tenant settings
GET/v1/tenants/{tenant_id}/settings
Partially update tenant settings
PATCH/v1/tenants/{tenant_id}/settings

Taxonomy

List taxonomy-capable fields
GET/v1/taxonomy/fields

TaxonomyRuns

List taxonomy runs
GET/v1/taxonomy/runs
Start a taxonomy run
POST/v1/taxonomy/runs
Get a taxonomy run
GET/v1/taxonomy/runs/{run_id}
Get a taxonomy run's tree
GET/v1/taxonomy/runs/{run_id}/tree

TaxonomyRunsActive

Get the active taxonomy tree for a scope
GET/v1/taxonomy/runs/active/tree

TaxonomyNodes

Rename a taxonomy node
PATCH/v1/taxonomy/nodes/{node_id}
Soft-remove a taxonomy node
DELETE/v1/taxonomy/nodes/{node_id}
List feedback records for a taxonomy node
GET/v1/taxonomy/nodes/{node_id}/records