Skip to content
REST API
/
/
Delete a collection

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

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

Update a collection

Request

Updates an existing collection. Only include the fields you wish to update.

Path Parameters

  • id - The unique identifier of the collection to update

Request Body

All fields are optional. Only provided fields will be updated:

  • name - The new name of the collection
  • description - The new description of the collection
  • icon - An updated icon object for the collection (with type and value)
  • parentId - The new parent collection ID, if applicable (null for root level)
  • translations - A dictionary of updated translations keyed by locale code

Response

Returns the updated collection object with:

  • id - Unique identifier
  • name - Collection name
  • description - Collection description
  • slug - URL slug
  • icon - Collection icon (emoji or custom)
  • parentId - Parent collection ID (null for root collections)
  • helpCenterId - ID of the help center this collection belongs to
  • organization - Organization ID
  • defaultLocale - Default locale for content
  • locale - Current locale
  • availableLocales - Array of available locales
  • featurebaseUrl - Featurebase URL for the collection
  • externalUrl - External URL if custom domain is configured
  • articleCount - Number of articles in this collection
  • authorCount - Number of authors who contributed
  • order - Display order
  • translations - Translations for different locales
  • createdAt - ISO 8601 timestamp when created
  • updatedAt - ISO 8601 timestamp when last updated

Errors

  • 404 - Collection not found in your organization's help center
Security
bearerAuth
Path
idstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$required

The collection unique identifier

Example: 3416135
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
namestring<= 255 characters

The new name of the collection

Example: "Updated Collection"
descriptionstring<= 512 characters

The new description of the collection

Example: "Updated description in English."
iconobject or null(CollectionIcon_Nova)

An updated icon object for the collection

parentIdstring or null[ 1 .. 16 ] characters^[a-zA-Z0-9]+$

The new parent collection ID, if applicable

Example: null
translationsobject

A dictionary of updated translations keyed by locale

curl -i -X PATCH \
  https://docs.featurebase.app/_mock/rest-api/v2/help_center/collections/3416135 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "name": "Updated Collection",
    "description": "Updated description in English.",
    "icon": {
      "type": "emoji",
      "value": "📝"
    },
    "parentId": null,
    "translations": {
      "bn": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "bs": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "pt-BR": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "bg": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "ca": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "hr": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "cs": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "da": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "nl": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "en": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "et": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "fi": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "fr": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "de": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "el": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "hi": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "hu": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "id": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "it": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "ja": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "ko": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "lv": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "lt": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "ms": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "mn": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "nb": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "pl": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "pt": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "ro": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "ru": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "sr": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "zh-CN": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "sk": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "sl": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "es": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "sw": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "sv": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "th": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "zh-TW": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "tr": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "uk": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "vi": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      }
    }
  }'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"collection"
Example: "collection"
idstringrequired

Collection unique identifier

Example: "6474684"
namestring

Collection name

Example: "English Collection Name"
descriptionstring

Collection description

Example: "A description in English"
slugstring

URL slug

Example: "6474684-english-version"
iconobject or null(CollectionIcon)

Collection icon

parentIdstring or nullrequired

Parent collection ID

Example: null
helpCenterIdstringrequired

Help center ID

Example: "j7c5g8ah3ewxp4lo"
organizationstringrequired

Organization ID

Example: "6595518396205e06b897ad65"
defaultLocalestring

Default locale

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

Current locale

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

Available locales

Items Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"
Example: ["en","de"]
featurebaseUrlstring

Featurebase URL

Example: "https://yourorg.featurebase.app/en/help/collections/6474684-english-version"
externalUrlstring

External URL

Example: "https://help.yourdomain.com/en/collections/6474684-english-version"
articleCountnumber

Number of articles

Example: 15
authorCountnumber

Number of authors

Example: 3
ordernumber or null

Display order

Example: 1
pathstring

Collection path

Example: "ox6qrqprmsuqaunj/3876752/3513543"
collapseSidebarboolean

Whether to collapse sidebar

Example: false
translationsobject

Translations by locale code

createdAtstringrequired

ISO 8601 timestamp when created

Example: "2024-10-18T12:33:09.099Z"
updatedAtstringrequired

ISO 8601 timestamp when last updated

Example: "2024-10-18T13:03:25.921Z"
Response
application/json
{
  "object": "collection",
  "id": "6474684",
  "name": "English Collection Name",
  "description": "A description in English",
  "slug": "6474684-english-version",
  "icon": {
    "type": "emoji",
    "value": "🥾"
  },
  "parentId": null,
  "helpCenterId": "j7c5g8ah3ewxp4lo",
  "organization": "6595518396205e06b897ad65",
  "defaultLocale": "en",
  "locale": "en",
  "availableLocales": [
    "en",
    "de"
  ],
  "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/6474684-english-version",
  "externalUrl": "https://help.yourdomain.com/en/collections/6474684-english-version",
  "articleCount": 15,
  "authorCount": 3,
  "order": 1,
  "path": "ox6qrqprmsuqaunj/3876752/3513543",
  "collapseSidebar": false,
  "translations": {
    "bn": { … },
    "bs": { … },
    "pt-BR": { … },
    "bg": { … },
    "ca": { … },
    "hr": { … },
    "cs": { … },
    "da": { … },
    "nl": { … },
    "en": { … },
    "et": { … },
    "fi": { … },
    "fr": { … },
    "de": { … },
    "el": { … },
    "hi": { … },
    "hu": { … },
    "id": { … },
    "it": { … },
    "ja": { … },
    "ko": { … },
    "lv": { … },
    "lt": { … },
    "ms": { … },
    "mn": { … },
    "nb": { … },
    "pl": { … },
    "pt": { … },
    "ro": { … },
    "ru": { … },
    "sr": { … },
    "zh-CN": { … },
    "sk": { … },
    "sl": { … },
    "es": { … },
    "sw": { … },
    "sv": { … },
    "th": { … },
    "zh-TW": { … },
    "tr": { … },
    "uk": { … },
    "vi": { … }
  },
  "createdAt": "2024-10-18T12:33:09.099Z",
  "updatedAt": "2024-10-18T13:03:25.921Z"
}

Delete a collection

Request

Deletes an existing collection.

Path Parameters

  • id - The unique identifier of the collection to delete

Response

Returns a deletion confirmation object:

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

Errors

  • 404 - Collection not found in your organization's help center
Security
bearerAuth
Path
idstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$required

The collection unique identifier

Example: 3416135
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/help_center/collections/3416135 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json
idstringrequired

Unique identifier of the deleted collection

Example: "3416135"
objectstringrequired

Object type identifier

Value"collection"
Example: "collection"
deletedbooleanrequired

Indicates the resource was deleted

Valuetrue
Example: true
Response
application/json
{
  "id": "3416135",
  "object": "collection",
  "deleted": true
}

List articles

Request

Returns a paginated list of articles within your organization's help center.

Articles are the main content pieces that contain documentation, guides, and FAQs.

Query Parameters

  • limit - Number of items to return (1-100, default 10)
  • cursor - Cursor for pagination
  • state - Filter by article state: "live", "draft", or "all" (default "live")
  • parentId - Filter by parent collection ID

Response Format

Returns a list object with:

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

Article Object

Each article includes:

  • id - Unique identifier
  • title - Article title
  • description - Article description
  • body - Article content (HTML)
  • slug - URL slug
  • icon - Article icon (emoji or custom)
  • parentId - Parent collection ID
  • helpCenterId - ID of the help center this article belongs to
  • organization - Organization ID
  • state - Article state (live or draft)
  • defaultLocale - Default locale for content
  • locale - Current locale
  • availableLocales - Array of available locales
  • publishedLocales - Array of locales where article is published
  • featurebaseUrl - Featurebase URL for the article
  • externalUrl - External URL if custom domain is configured
  • author - Author information (name, authorId, avatarUrl)
  • order - Display order
  • isPublished - Whether the article is published
  • isDraftDiffersFromLive - Whether draft differs from live version
  • translations - Translations for different locales
  • createdAt - ISO 8601 timestamp when created
  • updatedAt - ISO 8601 timestamp when last updated
  • liveUpdatedAt - ISO 8601 timestamp when live version was 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 of results.

Example: cursor=eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
statestring

Filter articles by state. Use "all" to get both draft and live articles.

Default "live"
Enum"live""draft""all"
Example: state=live
parentIdstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$

Filter articles by parent collection ID

Example: parentId=6474684
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/articles?limit=10&cursor=eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9&state=live&parentId=6474684' \
  -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(Article)required

Array of article objects

Example: []
data[].​objectstringrequired

Object type identifier

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

Article unique identifier

Example: "1234567"
data[].​titlestring

Article title

Example: "Getting Started Guide"
data[].​descriptionstring

Article description

Example: "Learn how to get started"
data[].​bodystring

Article body content (HTML)

Example: "<p>Welcome to our guide.</p>"
data[].​slugstring

URL slug

Example: "1234567-getting-started-guide"
data[].​iconobject or null(ArticleIcon)

Article icon

data[].​parentIdstring or null

Parent collection ID

Example: "6474684"
data[].​helpCenterIdstringrequired

Help Center ID

Example: "j7c5g8ah3ewxp4lo"
data[].​organizationstringrequired

Organization ID

Example: "6595518396205e06b897ad65"
data[].​statestringrequired

Article state

Enum"live""draft"
Example: "live"
data[].​defaultLocalestring

Default locale

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

Current locale

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

Available locales

Items Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"
Example: ["en","de"]
data[].​publishedLocalesArray of strings

Published locales

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

Featurebase URL

Example: "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide"
data[].​externalUrlstring

External URL

Example: "https://help.yourdomain.com/en/articles/1234567-getting-started-guide"
data[].​authorobject(ArticleAuthor)

Article author

data[].​ordernumber or null

Display order

Example: 1
data[].​isPublishedboolean

Whether the article is published

Example: true
data[].​isDraftDiffersFromLiveboolean

Whether draft differs from live

Example: false
data[].​translationsobject

Translations by locale code

data[].​createdAtstringrequired

ISO 8601 timestamp when created

Example: "2024-10-18T12:33:09.099Z"
data[].​updatedAtstringrequired

ISO 8601 timestamp when last updated

Example: "2024-10-18T13:03:25.921Z"
data[].​liveUpdatedAtstring

ISO 8601 timestamp when live version was last updated

Example: "2024-10-18T13:03:25.921Z"
data[].​pathstring

Path to article within help center hierarchy

Example: "/getting-started"
data[].​surveyIdstring

Associated survey ID

Example: "6743752ca81ae59d25cf834b"
data[].​visibleByArray of strings

Visibility settings

Example: ["everyone"]
data[].​translationCreatedAtstring

ISO 8601 timestamp when translation was created

Example: "2024-10-18T12:33:09.099Z"
data[].​translationUpdatedAtstring

ISO 8601 timestamp when translation was last updated

Example: "2024-10-19T14:22:15.123Z"
nextCursorstring or nullrequired

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

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

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