Skip to content
REST API
/
/
Delete a post

Featurebase API (2026-01-01.nova)

Welcome to the Featurebase API. This API allows you to programmatically interact with your Featurebase organization.

This documentation reflects API version 2026-01-01.nova.

Download OpenAPI description
index.json
index.yaml
Overview
URL
https://featurebase.app
License
Proprietary
Languages
Servers
Mock server
https://docs.featurebase.app/_mock/rest-api/
Production
https://do.featurebase.app/

API Versioning

This API uses date-based versioning. Each version is identified by a release date and slug, e.g., 2026-01-01.nova.

Specifying a Version

Include the version in the request header:

Featurebase-Version: 2026-01-01.nova

Or set a default version for your organization in the dashboard settings.

Version Compatibility

  • Newer versions may add new fields to responses (always backwards-compatible)
  • Breaking changes (removed/renamed fields, changed behavior) only occur in new versions
  • Your integration will continue to work as long as you pin to a specific version

Authentication

All API requests require authentication via API key.

Include in headers:

Authorization: Bearer <api-key>

Create and manage your API keys in the Featurebase dashboard.

Error Handling

The API uses conventional HTTP response codes to indicate success or failure:

  • 2xx - Success
  • 4xx - Client errors (bad request, unauthorized, not found, etc.)
  • 5xx - Server errors (internal error)

Error Response Format

All errors follow a consistent format:

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "Post not found",
    "param": "id",
    "status": 404
  }
}

Error Types

TypeDescription
authentication_errorAuthentication failed (401)
authorization_errorPermission denied (403)
invalid_request_errorInvalid request parameters or resource not found (400, 404, 410)
api_errorServer-side error (500)
rate_limit_errorToo many requests (429)

Boards

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

Operations

Posts

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

Operations

Update a post

Request

Updates an existing post. Only provided fields will be modified.

Updatable Fields

  • title - Post title (minimum 2 characters)
  • content - Post content in HTML format
  • boardId - Move post to a different board
  • statusId - Update post status
  • tags - Replace existing tags with new set
  • commentsEnabled - Enable/disable comments
  • inReview - Put post in/out of moderation queue
  • customFields - Update custom field values
  • eta - Set estimated completion date (null to clear)
  • createdAt - Update creation date (for backdating)
  • assigneeId - Admin ID to assign this post to (null to unassign)
  • visibility - Post-level visibility restriction: 'public' (no additional restrictions), 'authorOnly' (only author and admins), or 'companyOnly' (only users in author's company). Note: even 'public' posts are still subject to board-level and organization-level access controls.
  • author - Change post attribution (id, userId, email, name, profilePicture)

Status Update Notifications

  • sendStatusUpdateEmail - When changing status, optionally send email notification to voters (default: false)

Response

Returns the updated post object with all fields populated.

Security
bearerAuth
Path
idstringrequired

Post unique identifier

Example: 507f1f77bcf86cd799439011
Headers
Featurebase-Versionstring(FeaturebaseVersion)

API version for this request. Defaults to your organization's configured API version if not specified.

Example: 2026-01-01.nova
Bodyapplication/json
titlestring[ 2 .. 512 ] characters

Post title

Example: "Updated: Add dark mode support"
contentstring

Post content (HTML)

Example: "<p>Updated content with more details.</p>"
boardIdstring

Board ID to move post to

Example: "507f1f77bcf86cd799439011"
tagsstring or Array of strings

Tag names to set (replaces existing)

Example: ["feature","ui"]
Any of:

Tag names to set (replaces existing)

<= 255 characters
string<= 255 characters
commentsEnabledboolean or null

Whether comments are enabled on this post

Example: true
statusIdstring

Status ID to set

Example: "507f1f77bcf86cd799439012"
inReviewboolean or null

Whether post is pending moderation

Example: false
customFieldsobject

Custom field values. Keys must be valid ObjectIds. Values can be: string, boolean, number, ISO date string, array of strings, ObjectId string, or null.

Example: {"507f1f77bcf86cd799439011":"high"}
etastring or null

Estimated completion date (null to clear)

Example: "2025-12-31T23:59:59.000Z"
createdAtstring or null

Creation date (for backdating)

Example: "2025-01-15T10:30:00.000Z"
sendStatusUpdateEmailboolean or null

Whether to send status update email to voters

Example: false
assigneeIdstring or null

Admin ID to assign this post to (null to unassign)

Example: "507f1f77bcf86cd799439013"
visibilitystring

Post visibility. 'public' = visible to all users, 'authorOnly' = only visible to the author and admins, 'companyOnly' = only visible to users in the same company as the author

Enum"public""authorOnly""companyOnly"
Example: "public"
authorobject

Author to attribute the post to. If not provided, uses the authenticated user. Supports multiple identification methods: id (Featurebase ID), userId (external SSO ID), or email.

upvotesinteger or null>= 0

Set the upvotes count directly. Use with caution as this overrides the actual vote count.

Example: 10
curl -i -X PATCH \
  https://docs.featurebase.app/_mock/rest-api/v2/posts/507f1f77bcf86cd799439011 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "title": "Updated: Add dark mode support",
    "content": "<p>Updated content with more details.</p>",
    "boardId": "507f1f77bcf86cd799439011",
    "tags": [
      "feature",
      "ui"
    ],
    "commentsEnabled": true,
    "statusId": "507f1f77bcf86cd799439012",
    "inReview": false,
    "customFields": {
      "507f1f77bcf86cd799439011": "high"
    },
    "eta": "2025-12-31T23:59:59.000Z",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "sendStatusUpdateEmail": false,
    "assigneeId": "507f1f77bcf86cd799439013",
    "visibility": "public",
    "author": {
      "id": "507f1f77bcf86cd799439011",
      "userId": "usr_12345",
      "email": "john@example.com",
      "name": "John Doe",
      "profilePicture": "https://example.com/avatar.png"
    },
    "upvotes": 10
  }'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"post"
Example: "post"
idstringrequired

Unique identifier

Example: "507f1f77bcf86cd799439011"
slugstringrequired

URL-friendly slug

Example: "add-dark-mode-support"
postUrlstringrequired

Full URL to view the post

Example: "https://feedback.example.com/p/add-dark-mode-support"
titlestringrequired

Post title

Example: "Add dark mode support"
contentstringrequired

Post content in HTML format

Example: "<p>It would be great to have a dark mode option for the dashboard.</p>"
boardIdstringrequired

Board (category) ID this post belongs to

Example: "507f1f77bcf86cd799439011"
authorobject or null(PostAuthor)required
author.​idstring or nullrequired

Author unique identifier

Example: "507f1f77bcf86cd799439011"
author.​namestringrequired

Author display name

Example: "John Doe"
author.​emailstring or nullrequired

Author email (if available)

Example: "john@example.com"
author.​profilePicturestring or nullrequired

Author profile picture URL

Example: "https://cdn.example.com/avatars/john.png"
author.​typestringrequired

Type of user who authored the post

Enum"admin""customer""guest""integration""bot""lead"
Example: "customer"
statusobject(PostStatus)required
status.​objectstringrequired

Object type identifier

Value"post_status"
Example: "post_status"
status.​idstringrequired

Unique identifier

Example: "507f1f77bcf86cd799439011"
status.​namestringrequired

Display name

Example: "In Progress"
status.​colorstringrequired

Color for UI display

Example: "Blue"
status.​typestringrequired

The workflow stage this status represents

Enum"reviewing""unstarted""active""completed""canceled"
Example: "active"
status.​isDefaultbooleanrequired

Whether this is the default status for new posts

Example: false
tagsArray of objects(PostTag)required

Tags attached to this post

Example: [{"id":"507f1f77bcf86cd799439011","name":"bug","color":"#FF5722"}]
tags[].​idstringrequired

Tag unique identifier

Example: "507f1f77bcf86cd799439011"
tags[].​namestringrequired

Tag name

Example: "bug"
tags[].​colorstring or nullrequired

Tag color hex code

Example: "#FF5722"
featuresobject(PostFeatures)required
features.​commentsEnabledbooleanrequired

Whether comments are allowed on this post

Example: true
upvotesnumberrequired

Total number of upvotes

Example: 42
commentCountnumberrequired

Total number of comments

Example: 5
inReviewbooleanrequired

Whether the post is pending moderation review

Example: false
isPinnedbooleanrequired

Whether the post is pinned to the top

Example: false
accessobject(PostAccess)required
access.​userIdsArray of stringsrequired

User IDs explicitly granted access to this post. Empty array means no user-level restrictions (post uses board/org visibility). Non-empty means only these users (plus admins) can see the post.

Example: []
access.​companyExternalIdsArray of stringsrequired

External company IDs explicitly granted access to this post. Empty array means no company-level restrictions. Non-empty means only users belonging to these companies can see the post.

Example: []
assigneeIdstring or nullrequired

ID of the admin assigned to this post, null if unassigned

Example: "507f1f77bcf86cd799439013"
etastring or nullrequired

Estimated completion time as ISO 8601 timestamp, null if not set

Example: "2025-01-01T00:00:00.000Z"
customFieldsobjectrequired

Custom field values keyed by field ID

Example: {"cf_priority":"high","cf_effort":3}
customFields.​property name*anyadditional property
createdAtstringrequired

ISO 8601 timestamp when created

Example: "2023-12-12T00:00:00.000Z"
updatedAtstringrequired

ISO 8601 timestamp when last modified

Example: "2023-12-13T00:00:00.000Z"
Response
application/json
{
  "object": "post",
  "id": "507f1f77bcf86cd799439011",
  "slug": "add-dark-mode-support",
  "postUrl": "https://feedback.example.com/p/add-dark-mode-support",
  "title": "Add dark mode support",
  "content": "<p>It would be great to have a dark mode option for the dashboard.</p>",
  "boardId": "507f1f77bcf86cd799439011",
  "author": {
    "id": "507f1f77bcf86cd799439011",
    "name": "John Doe",
    "email": "john@example.com",
    "profilePicture": "https://cdn.example.com/avatars/john.png",
    "type": "customer"
  },
  "status": {
    "object": "post_status",
    "id": "507f1f77bcf86cd799439011",
    "name": "In Progress",
    "color": "Blue",
    "type": "active",
    "isDefault": false
  },
  "tags": [
    { … }
  ],
  "features": {
    "commentsEnabled": true
  },
  "upvotes": 42,
  "commentCount": 5,
  "inReview": false,
  "isPinned": false,
  "access": {
    "userIds": [],
    "companyExternalIds": []
  },
  "assigneeId": "507f1f77bcf86cd799439013",
  "eta": "2025-01-01T00:00:00.000Z",
  "customFields": {
    "cf_priority": "high",
    "cf_effort": 3
  },
  "createdAt": "2023-12-12T00:00:00.000Z",
  "updatedAt": "2023-12-13T00:00:00.000Z"
}

Delete a post

Request

Permanently deletes a post. This action cannot be undone.

What Gets Deleted

When you delete a post:

  • The post itself is permanently removed
  • All comments on the post are deleted
  • Vote records are removed
  • Any associated notifications are cleared

Response

Returns a deletion confirmation object with:

  • id - The ID of the deleted post
  • object - Always "post"
  • deleted - Always true

Permissions

Requires member-level access or higher to delete posts.

Security
bearerAuth
Path
idstringrequired

Post unique identifier

Example: 507f1f77bcf86cd799439011
Headers
Featurebase-Versionstring(FeaturebaseVersion)

API version for this request. Defaults to your organization's configured API version if not specified.

Example: 2026-01-01.nova
curl -i -X DELETE \
  https://docs.featurebase.app/_mock/rest-api/v2/posts/507f1f77bcf86cd799439011 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json
idstringrequired

Unique identifier of the deleted post

Example: "507f1f77bcf86cd799439011"
objectstringrequired

Object type identifier

Value"post"
Example: "post"
deletedbooleanrequired

Indicates the resource was deleted

Valuetrue
Example: true
Response
application/json
{
  "id": "507f1f77bcf86cd799439011",
  "object": "post",
  "deleted": true
}

List voters on a post

Request

Returns all voters (upvoters) for a specific post.

Voters are users who have upvoted the post. Each voter is returned in the standard user format with:

  • Basic info: id, name, email, profilePicture
  • User type (admin, customer, guest, etc.)
  • Companies the user belongs to
  • Activity stats: commentsCreated, postsCreated, lastActivity
  • Preferences: subscribedToChangelog, locale, verified

Pagination

This endpoint uses cursor-based pagination:

  • limit - Number of voters to return (1-100, default 10)
  • cursor - Opaque cursor from a previous response's nextCursor field

Example: To paginate through results:

  1. First request: GET /v2/posts/{id}/voters?limit=10
  2. If nextCursor is not null, use it for the next page
  3. Next request: GET /v2/posts/{id}/voters?limit=10&cursor={nextCursor}

Response Format

Returns a list object with:

  • object - Always "list"
  • data - Array of user objects
  • nextCursor - Cursor for the next page (null if no more results)

Permissions

Requires member-level access or higher.

Security
bearerAuth
Path
idstringrequired

Post unique identifier

Example: 507f1f77bcf86cd799439011
Query
limitinteger[ 1 .. 100 ]

A limit on the number of voters to be returned, between 1 and 100.

Default 10
Example: limit=10
cursorstring<= 512 characters

An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page of results.

Example: cursor=eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
Headers
Featurebase-Versionstring(FeaturebaseVersion)

API version for this request. Defaults to your organization's configured API version if not specified.

Example: 2026-01-01.nova
curl -i -X GET \
  'https://docs.featurebase.app/_mock/rest-api/v2/posts/507f1f77bcf86cd799439011/voters?limit=10&cursor=eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"list"
Example: "list"
dataArray of objects(User)required

Array of users

Example: []
data[].​objectstringrequired

Object type identifier

Value"contact"
Example: "contact"
data[].​idstringrequired

Unique identifier

Example: "676f0f6765bdaa7d7d760f88"
data[].​userIdstring

External user ID from SSO

Example: "676f0f673dbb299c8a4f3057"
data[].​organizationIdstring

Organization ID the user belongs to

Example: "5febde12dc56d60012d47db6"
data[].​companiesArray of objects(Company)

Companies the user belongs to

data[].​emailstring or null

User email

Example: "john@example.com"
data[].​namestringrequired

User display name

Example: "John Steezy"
data[].​profilePicturestring or null

Profile picture URL

Example: "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/anon_23.png"
data[].​commentsCreatednumber

Number of comments created

Example: 0
data[].​postsCreatednumber

Number of posts created

Example: 0
data[].​lastActivitystring

Last activity ISO timestamp

Example: "2025-01-03T21:42:30.181Z"
data[].​subscribedToChangelogboolean

Whether subscribed to changelog

Example: true
data[].​manuallyOptedOutFromChangelogboolean

Whether manually opted out from changelog

Example: false
data[].​rolesArray of strings

User roles

Example: []
data[].​localestring

User locale

Example: "en"
data[].​verifiedboolean

Whether email is verified

Example: true
data[].​typestringrequired

Type of user

Enum"admin""customer""guest""integration""bot""lead"
Example: "customer"
data[].​descriptionstring

User description/bio

Example: ""
data[].​customFieldsobject

Custom field values on the user

nextCursorstring or nullrequired

Cursor for fetching the next page (cursor-based pagination)

Example: "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
paginationobject

Pagination metadata for page-based requests

Response
application/json
{
  "object": "list",
  "data": [],
  "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9",
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 42,
    "totalPages": 5
  }
}

Post Statuses

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

Operations

Comments

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

Operations

Custom Fields

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

Operations

Changelogs

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

Operations

Admins

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

Operations

Teams

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

Operations

Contacts

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

Operations

Companies

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

Operations

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.

Operations

Help Centers

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

Operations

Conversations

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

Operations

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.

Operations