Skip to content
/Brands

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

Teams

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

Operations

Brands

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.

Operations

List all brands

Request

Returns all brands in your organization with cursor-based pagination.

Query Parameters

  • limit - Number of brands to return (1-100, default: 10)
  • cursor - Opaque cursor from a previous response for pagination

Response Structure

The response includes:

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

Brand Object

Each brand includes:

  • id - Featurebase internal ID (MongoDB ObjectId)
  • name - Brand display name
  • isDefault - Whether this is the default brand
  • createdAt - Creation timestamp
  • updatedAt - Last update timestamp
  • helpCenterId - Associated help center ID
  • senderEmailAddressId - Default sender email address ID

Example Response

{
  "object": "list",
  "data": [
    {
      "object": "brand",
      "id": "507f1f77bcf86cd799439011",
      "name": "Default Brand",
      "isDefault": true,
      "createdAt": "2025-01-01T12:00:00.000Z",
      "updatedAt": "2025-01-10T15:30:00.000Z",
      "helpCenterId": "11",
      "senderEmailAddressId": "507f1f77bcf86cd799439012"
    }
  ],
  "nextCursor": null
}

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

Security
bearerAuth
Query
limitinteger[ 1 .. 100 ]

A limit on the number of brands 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/brands?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(Brand)required

Array of brands

Example: []
data[].​objectstringrequired

Object type identifier

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

Featurebase internal ID

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

Brand display name

Example: "Default Brand"
data[].​isDefaultbooleanrequired

Whether this is the default brand

Example: true
data[].​createdAtstring or nullrequired

ISO date when brand was created

Example: "2025-01-01T12:00:00.000Z"
data[].​updatedAtstring or nullrequired

ISO date when brand was last updated

Example: "2025-01-10T15:30:00.000Z"
data[].​helpCenterIdstring or nullrequired

The ID of the help center associated with this brand

Example: "11"
data[].​senderEmailAddressIdstring or nullrequired

The ID of the default sending email address for this brand

Example: "507f1f77bcf86cd799439012"
nextCursorstring or null<= 512 charactersrequired

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

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

Get brand by ID

Request

Retrieves a single brand by its Featurebase ID.

Path Parameters

  • id - The Featurebase internal ID of the brand (MongoDB ObjectId)

Response

Returns a brand object with:

  • id - Featurebase internal ID
  • name - Brand display name
  • isDefault - Whether this is the default brand
  • createdAt - Creation timestamp
  • updatedAt - Last update timestamp
  • helpCenterId - Associated help center ID
  • senderEmailAddressId - Default sender email address ID

Example Response

{
  "object": "brand",
  "id": "507f1f77bcf86cd799439011",
  "name": "Default Brand",
  "isDefault": true,
  "createdAt": "2025-01-01T12:00:00.000Z",
  "updatedAt": "2025-01-10T15:30:00.000Z",
  "helpCenterId": "11",
  "senderEmailAddressId": "507f1f77bcf86cd799439012"
}

Error Responses

  • 404 Not Found - Brand with the specified ID does not exist

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

Security
bearerAuth
Path
idstringrequired

The Featurebase internal ID of the brand (MongoDB ObjectId)

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 GET \
  https://docs.featurebase.app/_mock/rest-api/v2/brands/507f1f77bcf86cd799439011 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"brand"
Example: "brand"
idstringrequired

Featurebase internal ID

Example: "507f1f77bcf86cd799439011"
namestringrequired

Brand display name

Example: "Default Brand"
isDefaultbooleanrequired

Whether this is the default brand

Example: true
createdAtstring or nullrequired

ISO date when brand was created

Example: "2025-01-01T12:00:00.000Z"
updatedAtstring or nullrequired

ISO date when brand was last updated

Example: "2025-01-10T15:30:00.000Z"
helpCenterIdstring or nullrequired

The ID of the help center associated with this brand

Example: "11"
senderEmailAddressIdstring or nullrequired

The ID of the default sending email address for this brand

Example: "507f1f77bcf86cd799439012"
Response
application/json
{
  "object": "brand",
  "id": "507f1f77bcf86cd799439011",
  "name": "Default Brand",
  "isDefault": true,
  "createdAt": "2025-01-01T12:00:00.000Z",
  "updatedAt": "2025-01-10T15:30:00.000Z",
  "helpCenterId": "11",
  "senderEmailAddressId": "507f1f77bcf86cd799439012"
}

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