Skip to content
REST API
/
/
Create a redirect rule

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

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

List redirect rules

Request

Returns a paginated list of redirect rules within your organization.

Redirect rules map old Help Center URLs to new article or collection destinations, enabling seamless migration from legacy help center systems. Only Help Centers with a custom domain configured support redirect rules.

Query Parameters

  • limit - Number of items to return (1-100, default 10)
  • cursor - Cursor for pagination
  • helpCenterId - Filter by help center ID
  • locale - Filter by locale code
  • targetType - Filter by target type ("article" or "collection")

Response Format

Returns a list object with:

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

Redirect Rule Object

Each redirect rule includes:

  • id - Unique identifier (MongoDB ObjectId)
  • helpCenterId - Help center this rule belongs to
  • locale - Locale code used to resolve the target translation
  • fromUrl - Canonical source URL (query/hash stripped, hostname lowercased)
  • targetType - "article" or "collection"
  • targetId - ID of the target article or collection
  • createdAt - ISO 8601 timestamp when created
  • updatedAt - ISO 8601 timestamp when last updated
Security
bearerAuth
Query
limitinteger[ 1 .. 100 ]

A limit on the number of objects 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.

Example: cursor=eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
helpCenterIdstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$

Filter redirect rules by help center ID

Example: helpCenterId=ox6qrqprmsuqaunj
localestring

Filter redirect rules by locale

Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"
Example: locale=en
targetTypestring

Filter redirect rules by target type

Enum"article""collection"
Example: targetType=article
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/help_center/redirect_rules?limit=10&cursor=eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9&helpCenterId=ox6qrqprmsuqaunj&locale=en&targetType=article' \
  -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(RedirectRule)required

Array of redirect rules

Example: []
data[].​objectstringrequired

Object type identifier

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

Redirect rule unique identifier

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

Help center identifier

Example: "ox6qrqprmsuqaunj"
data[].​localestringrequired

Locale code for the redirect rule

Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"
Example: "en"
data[].​fromUrlstringrequired

Canonical source URL being redirected from (query and hash stripped)

Example: "https://help.example.com/en/old/getting-started"
data[].​targetTypestringrequired

Type of content the redirect points to

Enum"article""collection"
Example: "article"
data[].​targetIdstringrequired

Target article or collection ID

Example: "1234567"
data[].​createdAtstringrequired

ISO 8601 timestamp when created

Example: "2026-02-11T12:00:00.000Z"
data[].​updatedAtstringrequired

ISO 8601 timestamp when last updated

Example: "2026-02-11T12:00:00.000Z"
nextCursorstring or nullrequired

Cursor for fetching the next page. Null if there are no more results.

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

Create a redirect rule

Request

Creates a new redirect rule in your organization.

The fromUrl is normalized on creation: query parameters and hash fragments are stripped, the hostname is lowercased, and trailing slashes are removed. The fromUrl hostname must match the Help Center's configured custom domain.

The target article or collection must exist and have a resolvable URL (i.e., a published translation with a slug).

Request Body

Required attributes:

  • helpCenterId - The ID of the help center this rule belongs to
  • locale - Locale code used to resolve the target translation
  • fromUrl - The full absolute URL to redirect from (must match the help center's custom domain)
  • targetType - "article" or "collection"
  • targetId - The ID of the target article or collection

Response

Returns the created redirect rule object.

Errors

  • 400 - Invalid request data, fromUrl does not match custom domain, or target not found
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
Bodyapplication/json
helpCenterIdstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$required

Help center identifier this redirect rule belongs to

Example: "ox6qrqprmsuqaunj"
localestringrequired

Locale code for the redirect rule. Used to resolve the target article/collection translation.

Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"
Example: "en"
fromUrlstring<= 2048 charactersrequired

Full absolute URL to redirect from. Must use http or https protocol. Query parameters and hash fragments are stripped during normalization. The hostname must match the Help Center custom domain.

Example: "https://help.example.com/en/old/getting-started"
targetTypestringrequired

Type of content the redirect points to

Enum"article""collection"
Example: "article"
targetIdstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$required

ID of the target article or collection

Example: "10021362"
curl -i -X POST \
  https://docs.featurebase.app/_mock/rest-api/v2/help_center/redirect_rules \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "helpCenterId": "ox6qrqprmsuqaunj",
    "locale": "en",
    "fromUrl": "https://help.example.com/en/old/getting-started",
    "targetType": "article",
    "targetId": "10021362"
  }'

Responses

Created

Bodyapplication/json
objectstringrequired

Object type identifier

Value"redirect_rule"
Example: "redirect_rule"
idstringrequired

Redirect rule unique identifier

Example: "507f1f77bcf86cd799439011"
helpCenterIdstringrequired

Help center identifier

Example: "ox6qrqprmsuqaunj"
localestringrequired

Locale code for the redirect rule

Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"
Example: "en"
fromUrlstringrequired

Canonical source URL being redirected from (query and hash stripped)

Example: "https://help.example.com/en/old/getting-started"
targetTypestringrequired

Type of content the redirect points to

Enum"article""collection"
Example: "article"
targetIdstringrequired

Target article or collection ID

Example: "1234567"
createdAtstringrequired

ISO 8601 timestamp when created

Example: "2026-02-11T12:00:00.000Z"
updatedAtstringrequired

ISO 8601 timestamp when last updated

Example: "2026-02-11T12:00:00.000Z"
Response
application/json
{
  "object": "redirect_rule",
  "id": "507f1f77bcf86cd799439011",
  "helpCenterId": "ox6qrqprmsuqaunj",
  "locale": "en",
  "fromUrl": "https://help.example.com/en/old/getting-started",
  "targetType": "article",
  "targetId": "1234567",
  "createdAt": "2026-02-11T12:00:00.000Z",
  "updatedAt": "2026-02-11T12:00:00.000Z"
}

Get a redirect rule by URL

Request

Retrieves a specific redirect rule by its source URL.

The url query parameter is normalized before matching: query parameters and hash fragments are stripped, the hostname is lowercased, and trailing slashes are removed. This is the same normalization applied when creating a redirect rule.

Query Parameters

  • url (required) - Full absolute URL to look up (http or https)

Response

Returns a redirect rule object with:

  • id - Unique identifier (MongoDB ObjectId)
  • helpCenterId - Help center this rule belongs to
  • locale - Locale code
  • fromUrl - Canonical source URL being redirected from
  • targetType - "article" or "collection"
  • targetId - ID of the target article or collection
  • createdAt - ISO 8601 timestamp when created
  • updatedAt - ISO 8601 timestamp when last updated

Errors

  • 400 - Invalid URL format
  • 404 - No redirect rule exists for the given URL
Security
bearerAuth
Query
urlstring<= 2048 charactersrequired

Full absolute URL to look up. The URL is normalized before matching: query parameters and hash fragments are stripped, the hostname is lowercased, and trailing slashes are removed.

Example: url=https://help.example.com/en/old/getting-started
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/help_center/redirect_rules/by-url?url=https%3A%2F%2Fhelp.example.com%2Fen%2Fold%2Fgetting-started' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"redirect_rule"
Example: "redirect_rule"
idstringrequired

Redirect rule unique identifier

Example: "507f1f77bcf86cd799439011"
helpCenterIdstringrequired

Help center identifier

Example: "ox6qrqprmsuqaunj"
localestringrequired

Locale code for the redirect rule

Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"
Example: "en"
fromUrlstringrequired

Canonical source URL being redirected from (query and hash stripped)

Example: "https://help.example.com/en/old/getting-started"
targetTypestringrequired

Type of content the redirect points to

Enum"article""collection"
Example: "article"
targetIdstringrequired

Target article or collection ID

Example: "1234567"
createdAtstringrequired

ISO 8601 timestamp when created

Example: "2026-02-11T12:00:00.000Z"
updatedAtstringrequired

ISO 8601 timestamp when last updated

Example: "2026-02-11T12:00:00.000Z"
Response
application/json
{
  "object": "redirect_rule",
  "id": "507f1f77bcf86cd799439011",
  "helpCenterId": "ox6qrqprmsuqaunj",
  "locale": "en",
  "fromUrl": "https://help.example.com/en/old/getting-started",
  "targetType": "article",
  "targetId": "1234567",
  "createdAt": "2026-02-11T12:00:00.000Z",
  "updatedAt": "2026-02-11T12:00:00.000Z"
}

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