API Reference

Libraries

TypeScript

0.6.0

npm install featurebase-node

Read Docs

API Overview

Support

SupportConversations

Conversations are messenger/inbox conversations in your Featurebase organization. Use this endpoint to list and retrieve conversation information.

List conversations

GET/v2/conversations

Create a conversation

POST/v2/conversations

Get conversation by ID

GET/v2/conversations/{id}

Delete a conversation

DELETE/v2/conversations/{id}

Update a conversation

PATCH/v2/conversations/{id}

Reply to a conversation

POST/v2/conversations/{id}/reply

Redact a conversation part

POST/v2/conversations/redact

SupportConversationsTags

Conversations are messenger/inbox conversations in your Featurebase organization. Use this endpoint to list and retrieve conversation information.

Attach a tag to a conversation

POST/v2/conversations/{id}/tags

Detach a tag from a conversation

DELETE/v2/conversations/{id}/tags/{tagId}

SupportConversationsParticipants

Conversations are messenger/inbox conversations in your Featurebase organization. Use this endpoint to list and retrieve conversation information.

Add a contact to a conversation

POST/v2/conversations/{id}/participants

Remove a contact from a conversation

DELETE/v2/conversations/{id}/participants

SupportConversation Tags

Conversation tags let you organize, filter, and automate around inbox conversations. Use these endpoints to list, look up, create, rename, and delete workspace conversation tags.

List workspace tags

GET/v2/tags

Create or rename a tag

POST/v2/tags

Get tag by ID

GET/v2/tags/{id}

Delete a tag

DELETE/v2/tags/{id}

SupportTickets

Tickets represent support requests in your Featurebase organization. Create, update, reply to, and manage tickets via these endpoints.

List tickets

GET/v2/tickets

Create a ticket

POST/v2/tickets

Get a ticket

GET/v2/tickets/{id}

Update a ticket

PATCH/v2/tickets/{id}

Delete a ticket

DELETE/v2/tickets/{id}

Reply to a ticket

POST/v2/tickets/{id}/reply

SupportTicketsCustom Fields

Tickets represent support requests in your Featurebase organization. Create, update, reply to, and manage tickets via these endpoints.

List custom fields

GET/v2/tickets/custom_fields

Get a custom field by ID

GET/v2/tickets/custom_fields/{id}

SupportTicketsCategories

Tickets represent support requests in your Featurebase organization. Create, update, reply to, and manage tickets via these endpoints.

List ticket categories

GET/v2/tickets/categories

Get a ticket category by ID

GET/v2/tickets/categories/{id}

SupportTicketsStatuses

Tickets represent support requests in your Featurebase organization. Create, update, reply to, and manage tickets via these endpoints.

List ticket statuses

GET/v2/tickets/statuses

Get a ticket status by ID

GET/v2/tickets/statuses/{id}

Feedback

FeedbackBoards

Boards (post categories) organize feedback into distinct containers with their own settings.

List all boards

GET/v2/boards

Get a board by ID

GET/v2/boards/{id}

FeedbackPosts

User-submitted feedback and feature requests. Posts belong to boards and can be upvoted, commented on, and tracked through statuses.

List all posts

GET/v2/posts

Create a new post

POST/v2/posts

Get a post by ID

GET/v2/posts/{id}

Update a post

PATCH/v2/posts/{id}

Delete a post

DELETE/v2/posts/{id}

FeedbackPostsVoters

User-submitted feedback and feature requests. Posts belong to boards and can be upvoted, commented on, and tracked through statuses.

List voters on a post

GET/v2/posts/{id}/voters

Add a voter to a post

POST/v2/posts/{id}/voters

Remove a voter from a post

DELETE/v2/posts/{id}/voters

FeedbackPost Statuses

Post statuses define the workflow stages for posts (e.g., In Review, Active, Completed).

List all post statuses

GET/v2/post_statuses

Get a post status by ID

GET/v2/post_statuses/{id}

FeedbackComments

Threaded discussions on posts and changelogs. Comments support voting, moderation, and privacy controls.

List comments

GET/v2/comments

Create a new comment

POST/v2/comments

Get a comment by ID

GET/v2/comments/{id}

Update a comment

PATCH/v2/comments/{id}

Delete a comment

DELETE/v2/comments/{id}

Delete a comment

DELETE/v2/comment

FeedbackCustom Fields

Configurable input fields for posts in your Featurebase organization. Custom fields allow you to collect additional structured data when users create posts.

List custom fields

GET/v2/custom_fields

Get a custom field by ID

GET/v2/custom_fields/{id}

Changelogs

Release notes and updates published by the organization. Changelogs keep users informed about new features, improvements, and fixes.

List all changelogs

GET/v2/changelogs

Create a new changelog

POST/v2/changelogs

Get a changelog by ID

GET/v2/changelogs/{id}

Update a changelog

PATCH/v2/changelogs/{id}

Delete a changelog

DELETE/v2/changelogs/{id}

Publish a changelog

POST/v2/changelogs/{id}/publish

Unpublish a changelog

POST/v2/changelogs/{id}/unpublish

ChangelogsSubscribers

Release notes and updates published by the organization. Changelogs keep users informed about new features, improvements, and fixes.

Add changelog subscribers

POST/v2/changelogs/subscribers

Remove changelog subscribers

DELETE/v2/changelogs/subscribers

Help Center

Help CenterHelp Centers

Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.

List help centers

GET/v2/help_center/help_centers

Get a help center by ID

GET/v2/help_center/help_centers/{id}

Help CenterCollections

Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.

List collections

GET/v2/help_center/collections

Create a collection

POST/v2/help_center/collections

Get a collection by ID

GET/v2/help_center/collections/{id}

Update a collection

PATCH/v2/help_center/collections/{id}

Delete a collection

DELETE/v2/help_center/collections/{id}

Help CenterArticles

Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.

List articles

GET/v2/help_center/articles

Create an article

POST/v2/help_center/articles

Get an article by ID

GET/v2/help_center/articles/{id}

Update an article

PATCH/v2/help_center/articles/{id}

Delete an article

DELETE/v2/help_center/articles/{id}

Help CenterRedirect Rules

Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.

List redirect rules

GET/v2/help_center/redirect_rules

Create a redirect rule

POST/v2/help_center/redirect_rules

Get a redirect rule by URL

GET/v2/help_center/redirect_rules/by-url

Get a redirect rule by ID

GET/v2/help_center/redirect_rules/{id}

Update a redirect rule

PATCH/v2/help_center/redirect_rules/{id}

Delete a redirect rule

DELETE/v2/help_center/redirect_rules/{id}

Organization

OrganizationAdmins

Team members who manage your Featurebase organization. Admins have roles that define their permissions.

List admins

GET/v2/admins

Get an admin by ID

GET/v2/admins/{id}

List admin roles

GET/v2/admins/roles

OrganizationTeams

Teams are groups within your Featurebase organization. Use this endpoint to list and retrieve team information for conversation assignment and organization management.

List all teams

GET/v2/teams

Get team by ID

GET/v2/teams/{id}

OrganizationBrands

Brands represent distinct brand identities within your organization. Each brand can have its own help center and email sending address. Use this endpoint to list and retrieve brand information.

List all brands

GET/v2/brands

Get brand by ID

GET/v2/brands/{id}

Users

UsersContacts

Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.

List contacts

GET/v2/contacts

Create or update a contact

POST/v2/contacts

Get contact by ID

GET/v2/contacts/{id}

Delete contact by ID

DELETE/v2/contacts/{id}

Block a contact

POST/v2/contacts/{id}/block

Unblock a contact

POST/v2/contacts/{id}/unblock

UsersContactsBy User ID

Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.

Get contact by external user ID

GET/v2/contacts/by-user-id/{userId}

Delete contact by external user ID

DELETE/v2/contacts/by-user-id/{userId}

UsersContactsBy User IDEmail Preferences

Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.

Get contact email preferences by external user ID

GET/v2/contacts/by-user-id/{userId}/email-preferences

Update contact email preferences by external user ID

PATCH/v2/contacts/by-user-id/{userId}/email-preferences

UsersContactsEmail Preferences

Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.

Get contact email preferences by ID

GET/v2/contacts/{id}/email-preferences

Update contact email preferences by ID

PATCH/v2/contacts/{id}/email-preferences

UsersCompanies

Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.

List all companies

GET/v2/companies

Create or update a company

POST/v2/companies

Get company by ID

GET/v2/companies/{id}

Delete a company

DELETE/v2/companies/{id}

Delete a company by external company ID

DELETE/v2/companies/by-company-id/{companyId}

UsersCompaniesContacts

Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.

List contacts attached to a company

GET/v2/companies/{id}/contacts

Attach a contact to a company

POST/v2/companies/{id}/contacts

Remove a contact from a company

DELETE/v2/companies/{id}/contacts/{contactId}

Surveys

Surveys allow you to collect targeted feedback from your users within your product. Surveys can be targeted to specific user segments or pages and can contain multiple questions with conditional logic.

List surveys

GET/v2/surveys

Get a survey by ID

GET/v2/surveys/{id}

Get survey responses

GET/v2/surveys/{id}/responses

Webhooks

Webhooks allow you to receive real-time HTTP callbacks when events occur in your Featurebase organization. Configure webhook endpoints to subscribe to specific event types.

List webhooks

GET/v2/webhooks

Create a webhook

POST/v2/webhooks

Get webhook by ID

GET/v2/webhooks/{id}

Update a webhook

PATCH/v2/webhooks/{id}

Delete a webhook

DELETE/v2/webhooks/{id}

Refresh webhook signing secret

POST/v2/webhooks/{id}/secret