Skip to content
/Admins

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

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

List admins

Request

Returns all admins for your organization.

This endpoint returns all admins at once (typically a small list). No pagination is supported.

Response Format

Returns a list object with:

  • object - Always "list"
  • data - Array of admin objects
  • nextCursor - Always null

Admin Object

Each admin includes:

  • id - Unique admin identifier
  • name - Admin's display name
  • email - Admin's email address
  • picture - Profile picture URL
  • roleId - ID of the role assigned to this admin
Security
bearerAuth
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/admins \
  -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(Admin)required

Array of admins

Example: []
data[].​objectstringrequired

Object type identifier

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

Unique identifier

Example: "5fef50c5e9458a0012f82456"
data[].​namestring

Admin display name

Example: "John Doe"
data[].​emailstring

Admin email address

Example: "john@example.com"
data[].​profilePicturestring or null

Profile picture URL

Example: "https://example.com/avatar.png"
data[].​roleIdstring

Role ID assigned to this admin

Example: "6648f22b7b23fb2f4307aafe"
nextCursorstring or nullrequired

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

Example: null
paginationobject

Pagination metadata for page-based requests

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

Get an admin by ID

Request

Retrieves a single admin by their unique identifier.

Returns the admin object if found and they belong to your organization.

Response

Returns an admin object with:

  • id - Unique admin identifier
  • name - Admin's display name
  • email - Admin's email address
  • picture - Profile picture URL
  • roleId - ID of the role assigned to this admin

Errors

  • 404 - Admin not found or doesn't belong to your organization
Security
bearerAuth
Path
idstringrequired

Admin unique identifier

Example: 5fef50c5e9458a0012f82456
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/admins/5fef50c5e9458a0012f82456 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"admin"
Example: "admin"
idstringrequired

Unique identifier

Example: "5fef50c5e9458a0012f82456"
namestring

Admin display name

Example: "John Doe"
emailstring

Admin email address

Example: "john@example.com"
profilePicturestring or null

Profile picture URL

Example: "https://example.com/avatar.png"
roleIdstring

Role ID assigned to this admin

Example: "6648f22b7b23fb2f4307aafe"
Response
application/json
{
  "object": "admin",
  "id": "5fef50c5e9458a0012f82456",
  "name": "John Doe",
  "email": "john@example.com",
  "profilePicture": "https://example.com/avatar.png",
  "roleId": "6648f22b7b23fb2f4307aafe"
}

List admin roles

Request

Returns all available admin roles and their permissions.

This endpoint returns all roles at once (typically a small list). No pagination is supported.

Response Format

Returns a list object with:

  • object - Always "list"
  • data - Array of admin role objects
  • nextCursor - Always null

Admin Role Object

Each role includes:

  • id - Unique role identifier
  • name - Role name (e.g., "Admin", "Viewer")
  • permissions - Object containing permission flags

Permissions

The permissions object contains boolean flags for each permission:

  • view_comments_private - Can view private comments
  • manage_comments - Can manage comments
  • manage_comments_private - Can manage private comments
  • set_comment_pinned - Can pin comments
  • moderate_comments - Can moderate comments
  • set_post_category - Can change post categories
  • set_post_pinned - Can pin posts
  • set_post_eta - Can set post ETA
  • set_post_tags - Can manage post tags
  • set_post_author - Can change post author
  • set_post_status - Can change post status
  • set_post_assignee - Can assign posts
  • set_post_custom_fields - Can edit custom fields
  • post_vote_on_behalf - Can vote on behalf of users
  • post_merge - Can merge posts
  • post_import - Can import posts
  • post_export - Can export posts
  • moderate_posts - Can moderate posts
  • view_users - Can view users
  • manage_users - Can manage users
  • view_posts_private - Can view private posts
  • view_private_post_tags - Can view private tags
  • manage_changelogs - Can manage changelogs
  • manage_surveys - Can manage surveys
  • manage_branding - Can manage branding
  • manage_billing - Can manage billing
  • manage_team_members - Can manage team members
  • manage_sso - Can manage SSO settings
  • manage_api - Can manage API settings
  • manage_statuses - Can manage statuses
  • manage_boards - Can manage boards
  • manage_post_tags - Can manage post tags
  • manage_custom_fields - Can manage custom fields
  • manage_moderation_settings - Can manage moderation
  • manage_roadmap - Can manage roadmap
  • manage_user_roles - Can manage user roles
  • manage_prioritization - Can manage prioritization
  • manage_notifications - Can manage notifications
  • manage_custom_domain - Can manage custom domain
  • manage_integrations - Can manage integrations
  • use_integrations - Can use integrations
  • manage_help_center - Can manage help center
  • auto_approve_posts - Posts auto-approved
Security
bearerAuth
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/admins/roles \
  -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(AdminRole)required

Array of admin roles

Example: []
data[].​objectstringrequired

Object type identifier

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

Role unique identifier

Example: "6648f22b7b23fb2f4307aafe"
data[].​namestringrequired

Role name

Example: "Admin"
data[].​permissionsobject(AdminRolePermissions)required

Role permissions

data[].​permissions.​view_comments_privateboolean

View private comments

Example: false
data[].​permissions.​manage_commentsboolean

Manage comments

Example: true
data[].​permissions.​manage_comments_privateboolean

Manage private comments

Example: false
data[].​permissions.​set_comment_pinnedboolean

Pin/unpin comments

Example: true
data[].​permissions.​moderate_commentsboolean

Moderate comments

Example: true
data[].​permissions.​set_post_categoryboolean

Set post category/board

Example: true
data[].​permissions.​set_post_pinnedboolean

Pin/unpin posts

Example: true
data[].​permissions.​set_post_etaboolean

Set post ETA

Example: true
data[].​permissions.​set_post_tagsboolean

Set post tags

Example: true
data[].​permissions.​set_post_authorboolean

Set post author

Example: true
data[].​permissions.​set_post_statusboolean

Set post status

Example: true
data[].​permissions.​set_post_assigneeboolean

Assign posts

Example: true
data[].​permissions.​set_post_custom_fieldsboolean

Set post custom fields

Example: true
data[].​permissions.​post_vote_on_behalfboolean

Vote on posts on behalf of users

Example: false
data[].​permissions.​post_mergeboolean

Merge posts

Example: true
data[].​permissions.​post_importboolean

Import posts

Example: false
data[].​permissions.​post_exportboolean

Export posts

Example: true
data[].​permissions.​moderate_postsboolean

Moderate posts

Example: true
data[].​permissions.​view_usersboolean

View users

Example: true
data[].​permissions.​manage_usersboolean

Manage users

Example: true
data[].​permissions.​view_posts_privateboolean

View private posts

Example: false
data[].​permissions.​view_private_post_tagsboolean

View private post tags

Example: false
data[].​permissions.​manage_changelogsboolean

Manage changelogs

Example: true
data[].​permissions.​manage_surveysboolean

Manage surveys

Example: true
data[].​permissions.​manage_brandingboolean

Manage branding

Example: false
data[].​permissions.​manage_billingboolean

Manage billing

Example: false
data[].​permissions.​manage_team_membersboolean

Manage team members

Example: true
data[].​permissions.​manage_ssoboolean

Manage SSO

Example: false
data[].​permissions.​manage_apiboolean

Manage API settings

Example: false
data[].​permissions.​manage_statusesboolean

Manage post statuses

Example: true
data[].​permissions.​manage_boardsboolean

Manage boards

Example: true
data[].​permissions.​manage_post_tagsboolean

Manage post tags

Example: true
data[].​permissions.​manage_custom_fieldsboolean

Manage custom fields

Example: true
data[].​permissions.​manage_moderation_settingsboolean

Manage moderation settings

Example: true
data[].​permissions.​manage_roadmapboolean

Manage roadmap

Example: true
data[].​permissions.​manage_user_rolesboolean

Manage user roles

Example: true
data[].​permissions.​manage_prioritizationboolean

Manage prioritization

Example: true
data[].​permissions.​manage_notificationsboolean

Manage notifications

Example: true
data[].​permissions.​manage_custom_domainboolean

Manage custom domain

Example: false
data[].​permissions.​manage_integrationsboolean

Manage integrations

Example: false
data[].​permissions.​use_integrationsboolean

Use integrations

Example: true
data[].​permissions.​manage_help_centerboolean

Manage help center

Example: true
data[].​permissions.​auto_approve_postsboolean

Auto-approve posts

Example: false
nextCursorstring or nullrequired

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

Example: null
Response
application/json
{
  "object": "list",
  "data": [],
  "nextCursor": null
}

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