# Featurebase

## Docs

- [featurebase-js](/guides/featurebase-js/index.md): Typed client SDK for the Featurebase Messenger. Install, boot, and start chatting with users in four lines.
- [API reference](/guides/featurebase-js/api-reference/index.md): Every method exported by featurebase-js, with signatures and examples.
- [Framework examples](/guides/featurebase-js/frameworks/index.md): Drop-in examples for React, Vue, Svelte, Angular, and plain HTML.
- [React helper](/guides/featurebase-js/react/index.md): <FeaturebaseProvider> and useFeaturebase() for declarative usage in React apps.
- [Editing article content](/guides/help-center/editing-articles/index.md): How to write and edit Help Center article bodies without losing formatting – the raw formatter for lossless round-trips and the find/replace edit_body endpoint for surgical, byte-stable edits.
- [Reports API overview](/guides/reports/index.md): Query your workspace analytics programmatically – conversation volume, response times, CSAT, SLAs, teammate performance and AI resolutions.
- [Query syntax reference](/guides/reports/query-syntax/index.md): The full reporting query grammar – metrics, aggregations, filters, grouping, comparison windows and drill-ins.
- [Training Data API](/guides/training-data/index.md): Keep the AI agent's knowledge in sync with reviewed documents and Q&A entries from your own systems.
- [Webhooks overview](/guides/webhooks/index.md): Receive real-time notifications when events occur in your Featurebase organization.
- [Consuming webhooks](/guides/webhooks/consuming/index.md): How to parse and handle incoming Featurebase webhook payloads.
- [Delivery behaviors](/guides/webhooks/delivery/index.md): Retry logic, ordering, deduplication, and webhook status semantics.
- [Handler examples](/guides/webhooks/handlers/index.md): Webhook handler code samples for popular languages and frameworks.
- [Security](/guides/webhooks/security/index.md): Verifying Featurebase webhook signatures with HMAC-SHA256.
- [Topic types](/guides/webhooks/topics/index.md): All available webhook event topics in Featurebase.
- [Introduction](/index.md): Welcome to the Featurebase API documentation.

## API Reference

Links below point to language-neutral HTTP documentation. SDK-specific docs follow the same URL structure with the language inserted after the base path: `/api/{language}/resources/...`.

Available languages: http, typescript

### [Support](/api/resources/support/index.md)


- [Conversations](/api/resources/support/subresources/conversations/index.md)

  - [List](/api/resources/support/subresources/conversations/methods/list/index.md): List conversations
  - [Create](/api/resources/support/subresources/conversations/methods/create/index.md): Create a conversation
  - [Retrieve](/api/resources/support/subresources/conversations/methods/retrieve/index.md): Get conversation by ID
  - [Delete](/api/resources/support/subresources/conversations/methods/delete/index.md): Delete a conversation
  - [Update](/api/resources/support/subresources/conversations/methods/update/index.md): Update a conversation
  - [Reply](/api/resources/support/subresources/conversations/methods/reply/index.md): Reply to a conversation
  - [Redact](/api/resources/support/subresources/conversations/methods/redact/index.md): Redact a conversation part
  - [Attach Tag](/api/resources/support/subresources/conversations/methods/attach_tag/index.md): Attach a tag to a conversation
  - [Detach Tag](/api/resources/support/subresources/conversations/methods/detach_tag/index.md): Detach a tag from a conversation
  - [Search](/api/resources/support/subresources/conversations/methods/search/index.md): Search conversations

  - [Participants](/api/resources/support/subresources/conversations/subresources/participants/index.md)

    - [Add](/api/resources/support/subresources/conversations/subresources/participants/methods/add/index.md): Add a contact to a conversation
    - [Remove](/api/resources/support/subresources/conversations/subresources/participants/methods/remove/index.md): Remove a contact from a conversation

- [Conversation Tags](/api/resources/support/subresources/conversation_tags/index.md)

  - [List](/api/resources/support/subresources/conversation_tags/methods/list/index.md): List workspace tags
  - [Create Or Rename](/api/resources/support/subresources/conversation_tags/methods/create_or_rename/index.md): Create or rename a tag
  - [Retrieve](/api/resources/support/subresources/conversation_tags/methods/retrieve/index.md): Get tag by ID
  - [Delete](/api/resources/support/subresources/conversation_tags/methods/delete/index.md): Delete a tag


- [Tickets](/api/resources/support/subresources/tickets/index.md)

  - [List](/api/resources/support/subresources/tickets/methods/list/index.md): List tickets
  - [Create](/api/resources/support/subresources/tickets/methods/create/index.md): Create a ticket
  - [Retrieve](/api/resources/support/subresources/tickets/methods/retrieve/index.md): Get a ticket
  - [Update](/api/resources/support/subresources/tickets/methods/update/index.md): Update a ticket
  - [Delete](/api/resources/support/subresources/tickets/methods/delete/index.md): Delete a ticket
  - [Reply](/api/resources/support/subresources/tickets/methods/reply/index.md): Reply to a ticket

  - [Custom Fields](/api/resources/support/subresources/tickets/subresources/custom_fields/index.md)

    - [List](/api/resources/support/subresources/tickets/subresources/custom_fields/methods/list/index.md): List custom fields
    - [Retrieve](/api/resources/support/subresources/tickets/subresources/custom_fields/methods/retrieve/index.md): Get a custom field by ID


  - [Categories](/api/resources/support/subresources/tickets/subresources/categories/index.md)

    - [List](/api/resources/support/subresources/tickets/subresources/categories/methods/list/index.md): List ticket categories
    - [Retrieve](/api/resources/support/subresources/tickets/subresources/categories/methods/retrieve/index.md): Get a ticket category by ID


  - [Statuses](/api/resources/support/subresources/tickets/subresources/statuses/index.md)

    - [List](/api/resources/support/subresources/tickets/subresources/statuses/methods/list/index.md): List ticket statuses
    - [Retrieve](/api/resources/support/subresources/tickets/subresources/statuses/methods/retrieve/index.md): Get a ticket status by ID

### [Feedback](/api/resources/feedback/index.md)


- [Boards](/api/resources/feedback/subresources/boards/index.md)

  - [List](/api/resources/feedback/subresources/boards/methods/list/index.md): List all boards
  - [Retrieve](/api/resources/feedback/subresources/boards/methods/retrieve/index.md): Get a board by ID


- [Posts](/api/resources/feedback/subresources/posts/index.md)

  - [List](/api/resources/feedback/subresources/posts/methods/list/index.md): List all posts
  - [Create](/api/resources/feedback/subresources/posts/methods/create/index.md): Create a new post
  - [Retrieve](/api/resources/feedback/subresources/posts/methods/retrieve/index.md): Get a post by ID
  - [Update](/api/resources/feedback/subresources/posts/methods/update/index.md): Update a post
  - [Delete](/api/resources/feedback/subresources/posts/methods/delete/index.md): Delete a post
  - [Merge](/api/resources/feedback/subresources/posts/methods/merge/index.md): Merge two posts
  - [Unmerge](/api/resources/feedback/subresources/posts/methods/unmerge/index.md): Unmerge a post
  - [Search](/api/resources/feedback/subresources/posts/methods/search/index.md): Search posts

  - [Voters](/api/resources/feedback/subresources/posts/subresources/voters/index.md)

    - [List](/api/resources/feedback/subresources/posts/subresources/voters/methods/list/index.md): List voters on a post
    - [Add](/api/resources/feedback/subresources/posts/subresources/voters/methods/add/index.md): Add a voter to a post
    - [Remove](/api/resources/feedback/subresources/posts/subresources/voters/methods/remove/index.md): Remove a voter from a post

- [Post Statuses](/api/resources/feedback/subresources/post_statuses/index.md)

  - [List](/api/resources/feedback/subresources/post_statuses/methods/list/index.md): List all post statuses
  - [Retrieve](/api/resources/feedback/subresources/post_statuses/methods/retrieve/index.md): Get a post status by ID


- [Comments](/api/resources/feedback/subresources/comments/index.md)

  - [List](/api/resources/feedback/subresources/comments/methods/list/index.md): List comments
  - [Create](/api/resources/feedback/subresources/comments/methods/create/index.md): Create a new comment
  - [Retrieve](/api/resources/feedback/subresources/comments/methods/retrieve/index.md): Get a comment by ID
  - [Update](/api/resources/feedback/subresources/comments/methods/update/index.md): Update a comment
  - [Delete 0](/api/resources/feedback/subresources/comments/methods/delete_0/index.md): Delete a comment
  - [Delete 1](/api/resources/feedback/subresources/comments/methods/delete_1/index.md): Delete a comment
  - [Search](/api/resources/feedback/subresources/comments/methods/search/index.md): Search comments


- [Custom Fields](/api/resources/feedback/subresources/custom_fields/index.md)

  - [List](/api/resources/feedback/subresources/custom_fields/methods/list/index.md): List custom fields
  - [Retrieve](/api/resources/feedback/subresources/custom_fields/methods/retrieve/index.md): Get a custom field by ID

### [Changelogs](/api/resources/changelogs/index.md)

- [List](/api/resources/changelogs/methods/list/index.md): List all changelogs
- [Create](/api/resources/changelogs/methods/create/index.md): Create a new changelog
- [Retrieve](/api/resources/changelogs/methods/retrieve/index.md): Get a changelog by ID
- [Update](/api/resources/changelogs/methods/update/index.md): Update a changelog
- [Delete](/api/resources/changelogs/methods/delete/index.md): Delete a changelog
- [Publish](/api/resources/changelogs/methods/publish/index.md): Publish a changelog
- [Unpublish](/api/resources/changelogs/methods/unpublish/index.md): Unpublish a changelog

- [Subscribers](/api/resources/changelogs/subresources/subscribers/index.md)

  - [Add](/api/resources/changelogs/subresources/subscribers/methods/add/index.md): Add changelog subscribers
  - [Remove](/api/resources/changelogs/subresources/subscribers/methods/remove/index.md): Remove changelog subscribers

### [Help Center](/api/resources/help_center/index.md)


- [Help Centers](/api/resources/help_center/subresources/help_centers/index.md)

  - [List](/api/resources/help_center/subresources/help_centers/methods/list/index.md): List help centers
  - [Retrieve](/api/resources/help_center/subresources/help_centers/methods/retrieve/index.md): Get a help center by ID


- [Collections](/api/resources/help_center/subresources/collections/index.md)

  - [List](/api/resources/help_center/subresources/collections/methods/list/index.md): List collections
  - [Create](/api/resources/help_center/subresources/collections/methods/create/index.md): Create a collection
  - [Retrieve](/api/resources/help_center/subresources/collections/methods/retrieve/index.md): Get a collection by ID
  - [Update](/api/resources/help_center/subresources/collections/methods/update/index.md): Update a collection
  - [Delete](/api/resources/help_center/subresources/collections/methods/delete/index.md): Delete a collection


- [Articles](/api/resources/help_center/subresources/articles/index.md)

  - [List](/api/resources/help_center/subresources/articles/methods/list/index.md): List articles
  - [Create](/api/resources/help_center/subresources/articles/methods/create/index.md): Create an article
  - [Retrieve](/api/resources/help_center/subresources/articles/methods/retrieve/index.md): Get an article by ID
  - [Update](/api/resources/help_center/subresources/articles/methods/update/index.md): Update an article
  - [Delete](/api/resources/help_center/subresources/articles/methods/delete/index.md): Delete an article
  - [Edit Body](/api/resources/help_center/subresources/articles/methods/edit_body/index.md): Edit an article body (find/replace)
  - [Search](/api/resources/help_center/subresources/articles/methods/search/index.md): Search articles


- [Redirect Rules](/api/resources/help_center/subresources/redirect_rules/index.md)

  - [List](/api/resources/help_center/subresources/redirect_rules/methods/list/index.md): List redirect rules
  - [Create](/api/resources/help_center/subresources/redirect_rules/methods/create/index.md): Create a redirect rule
  - [Retrieve By URL](/api/resources/help_center/subresources/redirect_rules/methods/retrieve_by_url/index.md): Get a redirect rule by URL
  - [Retrieve](/api/resources/help_center/subresources/redirect_rules/methods/retrieve/index.md): Get a redirect rule by ID
  - [Update](/api/resources/help_center/subresources/redirect_rules/methods/update/index.md): Update a redirect rule
  - [Delete](/api/resources/help_center/subresources/redirect_rules/methods/delete/index.md): Delete a redirect rule

### [Organization](/api/resources/organization/index.md)


- [Admins](/api/resources/organization/subresources/admins/index.md)

  - [List](/api/resources/organization/subresources/admins/methods/list/index.md): List admins
  - [Retrieve](/api/resources/organization/subresources/admins/methods/retrieve/index.md): Get an admin by ID
  - [List Roles](/api/resources/organization/subresources/admins/methods/list_roles/index.md): List admin roles


- [Teams](/api/resources/organization/subresources/teams/index.md)

  - [List](/api/resources/organization/subresources/teams/methods/list/index.md): List all teams
  - [Retrieve](/api/resources/organization/subresources/teams/methods/retrieve/index.md): Get team by ID


- [Brands](/api/resources/organization/subresources/brands/index.md)

  - [List](/api/resources/organization/subresources/brands/methods/list/index.md): List all brands
  - [Retrieve](/api/resources/organization/subresources/brands/methods/retrieve/index.md): Get brand by ID

### [Users](/api/resources/users/index.md)


- [Contacts](/api/resources/users/subresources/contacts/index.md)

  - [List](/api/resources/users/subresources/contacts/methods/list/index.md): List contacts
  - [Create Or Update](/api/resources/users/subresources/contacts/methods/create_or_update/index.md): Create or update a contact
  - [Retrieve](/api/resources/users/subresources/contacts/methods/retrieve/index.md): Get contact by ID
  - [Delete](/api/resources/users/subresources/contacts/methods/delete/index.md): Delete contact by ID
  - [Block](/api/resources/users/subresources/contacts/methods/block/index.md): Block a contact
  - [Unblock](/api/resources/users/subresources/contacts/methods/unblock/index.md): Unblock a contact
  - [Search](/api/resources/users/subresources/contacts/methods/search/index.md): Search contacts

  - [By User ID](/api/resources/users/subresources/contacts/subresources/by_user_id/index.md)

    - [Retrieve](/api/resources/users/subresources/contacts/subresources/by_user_id/methods/retrieve/index.md): Get contact by external user ID
    - [Delete](/api/resources/users/subresources/contacts/subresources/by_user_id/methods/delete/index.md): Delete contact by external user ID

    - [Email Preferences](/api/resources/users/subresources/contacts/subresources/by_user_id/subresources/email_preferences/index.md)

      - [Retrieve](/api/resources/users/subresources/contacts/subresources/by_user_id/subresources/email_preferences/methods/retrieve/index.md): Get contact email preferences by external user ID
      - [Update](/api/resources/users/subresources/contacts/subresources/by_user_id/subresources/email_preferences/methods/update/index.md): Update contact email preferences by external user ID

  - [Email Preferences](/api/resources/users/subresources/contacts/subresources/email_preferences/index.md)

    - [Retrieve](/api/resources/users/subresources/contacts/subresources/email_preferences/methods/retrieve/index.md): Get contact email preferences by ID
    - [Update](/api/resources/users/subresources/contacts/subresources/email_preferences/methods/update/index.md): Update contact email preferences by ID

- [Companies](/api/resources/users/subresources/companies/index.md)

  - [List](/api/resources/users/subresources/companies/methods/list/index.md): List all companies
  - [Create Or Update](/api/resources/users/subresources/companies/methods/create_or_update/index.md): Create or update a company
  - [Retrieve](/api/resources/users/subresources/companies/methods/retrieve/index.md): Get company by ID
  - [Delete](/api/resources/users/subresources/companies/methods/delete/index.md): Delete a company
  - [Delete By Company ID](/api/resources/users/subresources/companies/methods/delete_by_company_id/index.md): Delete a company by external company ID
  - [Search](/api/resources/users/subresources/companies/methods/search/index.md): Search companies

  - [Contacts](/api/resources/users/subresources/companies/subresources/contacts/index.md)

    - [List](/api/resources/users/subresources/companies/subresources/contacts/methods/list/index.md): List contacts attached to a company
    - [Attach](/api/resources/users/subresources/companies/subresources/contacts/methods/attach/index.md): Attach a contact to a company
    - [Remove](/api/resources/users/subresources/companies/subresources/contacts/methods/remove/index.md): Remove a contact from a company

### [Surveys](/api/resources/surveys/index.md)

- [List](/api/resources/surveys/methods/list/index.md): List surveys
- [Retrieve](/api/resources/surveys/methods/retrieve/index.md): Get a survey by ID
- [List Responses](/api/resources/surveys/methods/list_responses/index.md): Get survey responses


### [Webhooks](/api/resources/webhooks/index.md)

- [List](/api/resources/webhooks/methods/list/index.md): List webhooks
- [Create](/api/resources/webhooks/methods/create/index.md): Create a webhook
- [Retrieve](/api/resources/webhooks/methods/retrieve/index.md): Get webhook by ID
- [Update](/api/resources/webhooks/methods/update/index.md): Update a webhook
- [Delete](/api/resources/webhooks/methods/delete/index.md): Delete a webhook
- [Refresh Secret](/api/resources/webhooks/methods/refresh_secret/index.md): Refresh webhook signing secret


### [Conversation Attributes](/api/resources/conversation_attributes/index.md)

- [List](/api/resources/conversation_attributes/methods/list/index.md): List conversation custom attributes
- [Retrieve](/api/resources/conversation_attributes/methods/retrieve/index.md): Get a conversation custom attribute by ID


### [Audit Logs](/api/resources/audit_logs/index.md)

- [List](/api/resources/audit_logs/methods/list/index.md): List audit logs


### [Reports](/api/resources/reports/index.md)

- [List Datasets](/api/resources/reports/methods/list_datasets/index.md): List report datasets
- [Query](/api/resources/reports/methods/query/index.md): Run a report query
- [Lookup Filter Values](/api/resources/reports/methods/lookup_filter_values/index.md): Look up report filter values
- [Drill In](/api/resources/reports/methods/drill_in/index.md): Drill into report rows


### [Training Data](/api/resources/training_data/index.md)

- [Search](/api/resources/training_data/methods/search/index.md): Search existing knowledge for a passage
- [Oracle](/api/resources/training_data/methods/oracle/index.md): Ask what to do with a Q&A entry

- [Files](/api/resources/training_data/subresources/files/index.md)

  - [List](/api/resources/training_data/subresources/files/methods/list/index.md): List training files
  - [Create](/api/resources/training_data/subresources/files/methods/create/index.md): Add a training file
  - [Retrieve](/api/resources/training_data/subresources/files/methods/retrieve/index.md): Get a training file
  - [Update](/api/resources/training_data/subresources/files/methods/update/index.md): Update a training file
  - [Delete](/api/resources/training_data/subresources/files/methods/delete/index.md): Delete a training file


- [Qna](/api/resources/training_data/subresources/qna/index.md)

  - [List](/api/resources/training_data/subresources/qna/methods/list/index.md): List Q&A entries
  - [Create](/api/resources/training_data/subresources/qna/methods/create/index.md): Create a Q&A entry
  - [Retrieve](/api/resources/training_data/subresources/qna/methods/retrieve/index.md): Get a Q&A entry
  - [Update](/api/resources/training_data/subresources/qna/methods/update/index.md): Update a Q&A entry
  - [Delete](/api/resources/training_data/subresources/qna/methods/delete/index.md): Delete a Q&A entry