Get an article by ID

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

Type	Description
`authentication_error`	Authentication failed (401)
`authorization_error`	Permission denied (403)
`invalid_request_error`	Invalid request parameters or resource not found (400, 404, 410)
`api_error`	Server-side error (500)
`rate_limit_error`	Too 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

Create an article

Request

Creates a new article in your organization's help center.

Request Body

Required attributes:

title - The title of the article

Optional attributes:

description - A brief description of the article
body - The HTML content of the article (supports external image URLs and base64 data URIs)
formatter - Content formatter: "default" or "ai" (AI converts markdown/html to Featurebase format)
parentId - The ID of the parent collection
icon - Icon object with type and value
state - "live" or "draft" (defaults to "draft")
translations - Dictionary of translations keyed by locale

Response

Returns the created article object with:

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)
author - Author information (name, authorId, avatarUrl)
translations - Translations for different locales
createdAt - ISO 8601 timestamp when created
updatedAt - ISO 8601 timestamp when last updated

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

titlestring<= 512 charactersrequired

The title of the article

Example: "Getting Started Guide"

descriptionstring<= 512 characters

A brief description of the article

Example: "Learn how to get started with our platform"

bodystring

The HTML content of the article (supports external image URLs and base64 data URIs)

Example: "Welcome to our getting started guide."

formatterstring

Content formatter - "ai" converts markdown/html to Featurebase format using AI

Default "default"

Enum"default""ai"

Example: "default"

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

The ID of the parent collection

Example: "6474684"

iconobject or null(ArticleIconInput_Nova)

Icon object for the article

statestring

Article state - "live" publishes immediately, "draft" saves as draft

Default "draft"

Enum"live""draft"

Example: "draft"

translationsobject

Dictionary of translations keyed by locale code

curl -i -X POST \
  https://docs.featurebase.app/_mock/rest-api/v2/help_center/articles \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "title": "Getting Started Guide",
    "description": "Learn how to get started with our platform",
    "body": "<p>Welcome to our getting started guide.</p>",
    "formatter": "default",
    "parentId": "6474684",
    "icon": {
      "value": "📖",
      "type": "emoji"
    },
    "state": "draft",
    "translations": {
      "bn": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "bs": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "pt-BR": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "bg": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "ca": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "hr": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "cs": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "da": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "nl": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "en": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "et": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "fi": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "fr": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "de": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "el": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "hi": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "hu": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "id": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "it": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "ja": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "ko": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "lv": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "lt": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "ms": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "mn": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "nb": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "pl": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "pt": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "ro": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "ru": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "sr": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "zh-CN": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "sk": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "sl": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "es": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "sw": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "sv": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "th": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "zh-TW": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "tr": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "uk": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "vi": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      }
    }
  }'

Responses

Success

Bodyapplication/json

objectstringrequired

Object type identifier

Value"article"

Example: "article"

idstringrequired

Article unique identifier

Example: "1234567"

titlestring

Article title

Example: "Getting Started Guide"

descriptionstring

Article description

Example: "Learn how to get started"

bodystring

Article body content (HTML)

Example: "Welcome to our guide."

slugstring

URL slug

Example: "1234567-getting-started-guide"

iconobject or null(ArticleIcon)

Article icon

parentIdstring or null

Parent collection ID

Example: "6474684"

helpCenterIdstringrequired

Help Center ID

Example: "j7c5g8ah3ewxp4lo"

organizationstringrequired

Organization ID

Example: "6595518396205e06b897ad65"

statestringrequired

Article state

Enum"live""draft"

Example: "live"

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"]

publishedLocalesArray of strings

Published locales

Items Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"

Example: ["en"]

featurebaseUrlstring

Featurebase URL

Example: "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide"

externalUrlstring

External URL

Example: "https://help.yourdomain.com/en/articles/1234567-getting-started-guide"

authorobject(ArticleAuthor)

Article author

ordernumber or null

Display order

Example: 1

isPublishedboolean

Whether the article is published

Example: true

isDraftDiffersFromLiveboolean

Whether draft differs from live

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"

liveUpdatedAtstring

ISO 8601 timestamp when live version was last updated

Example: "2024-10-18T13:03:25.921Z"

pathstring

Path to article within help center hierarchy

Example: "/getting-started"

surveyIdstring

Associated survey ID

Example: "6743752ca81ae59d25cf834b"

visibleByArray of strings

Visibility settings

Example: ["everyone"]

translationCreatedAtstring

ISO 8601 timestamp when translation was created

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

translationUpdatedAtstring

ISO 8601 timestamp when translation was last updated

Example: "2024-10-19T14:22:15.123Z"

Response

application/json

{
  "object": "article",
  "id": "1234567",
  "title": "Getting Started Guide",
  "description": "Learn how to get started",
  "body": "<p>Welcome to our guide.</p>",
  "slug": "1234567-getting-started-guide",
  "icon": {
    "type": "emoji",
    "value": "📖"
  },
  "parentId": "6474684",
  "helpCenterId": "j7c5g8ah3ewxp4lo",
  "organization": "6595518396205e06b897ad65",
  "state": "live",
  "defaultLocale": "en",
  "locale": "en",
  "availableLocales": [
    "en",
    "de"
  ],
  "publishedLocales": [
    "en"
  ],
  "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide",
  "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide",
  "author": {
    "name": "John Doe",
    "authorId": "507f1f77bcf86cd799439011",
    "avatarUrl": null
  },
  "order": 1,
  "isPublished": true,
  "isDraftDiffersFromLive": 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",
  "liveUpdatedAt": "2024-10-18T13:03:25.921Z",
  "path": "/getting-started",
  "surveyId": "6743752ca81ae59d25cf834b",
  "visibleBy": [
    "everyone"
  ],
  "translationCreatedAt": "2024-10-18T12:33:09.099Z",
  "translationUpdatedAt": "2024-10-19T14:22:15.123Z"
}

Get an article by ID

Request

Retrieves a specific article by its unique identifier.

Returns the article object if found in your organization's help center.

Query Parameters

state - Article state to retrieve: "live" or "draft" (default "live")

Response

Returns an article object with:

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

Errors

404 - Article not found in your organization's help center

Security

bearerAuth

Path

idstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$required

Article unique identifier

Example: 1234567

Query

statestring

Article state to retrieve

Default "live"

Enum"live""draft"

Example: state=live

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/1234567?state=live' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json

objectstringrequired

Object type identifier

Value"article"

Example: "article"

idstringrequired

Article unique identifier

Example: "1234567"

titlestring

Article title

Example: "Getting Started Guide"

descriptionstring

Article description

Example: "Learn how to get started"

bodystring

Article body content (HTML)

Example: "Welcome to our guide."

slugstring

URL slug

Example: "1234567-getting-started-guide"

iconobject or null(ArticleIcon)

Article icon

parentIdstring or null

Parent collection ID

Example: "6474684"

helpCenterIdstringrequired

Help Center ID

Example: "j7c5g8ah3ewxp4lo"

organizationstringrequired

Organization ID

Example: "6595518396205e06b897ad65"

statestringrequired

Article state

Enum"live""draft"

Example: "live"

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"]

publishedLocalesArray of strings

Published locales

Items Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"

Example: ["en"]

featurebaseUrlstring

Featurebase URL

Example: "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide"

externalUrlstring

External URL

Example: "https://help.yourdomain.com/en/articles/1234567-getting-started-guide"

authorobject(ArticleAuthor)

Article author

ordernumber or null

Display order

Example: 1

isPublishedboolean

Whether the article is published

Example: true

isDraftDiffersFromLiveboolean

Whether draft differs from live

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"

liveUpdatedAtstring

ISO 8601 timestamp when live version was last updated

Example: "2024-10-18T13:03:25.921Z"

pathstring

Path to article within help center hierarchy

Example: "/getting-started"

surveyIdstring

Associated survey ID

Example: "6743752ca81ae59d25cf834b"

visibleByArray of strings

Visibility settings

Example: ["everyone"]

translationCreatedAtstring

ISO 8601 timestamp when translation was created

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

translationUpdatedAtstring

ISO 8601 timestamp when translation was last updated

Example: "2024-10-19T14:22:15.123Z"

Response

application/json

{
  "object": "article",
  "id": "1234567",
  "title": "Getting Started Guide",
  "description": "Learn how to get started",
  "body": "<p>Welcome to our guide.</p>",
  "slug": "1234567-getting-started-guide",
  "icon": {
    "type": "emoji",
    "value": "📖"
  },
  "parentId": "6474684",
  "helpCenterId": "j7c5g8ah3ewxp4lo",
  "organization": "6595518396205e06b897ad65",
  "state": "live",
  "defaultLocale": "en",
  "locale": "en",
  "availableLocales": [
    "en",
    "de"
  ],
  "publishedLocales": [
    "en"
  ],
  "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide",
  "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide",
  "author": {
    "name": "John Doe",
    "authorId": "507f1f77bcf86cd799439011",
    "avatarUrl": null
  },
  "order": 1,
  "isPublished": true,
  "isDraftDiffersFromLive": 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",
  "liveUpdatedAt": "2024-10-18T13:03:25.921Z",
  "path": "/getting-started",
  "surveyId": "6743752ca81ae59d25cf834b",
  "visibleBy": [
    "everyone"
  ],
  "translationCreatedAt": "2024-10-18T12:33:09.099Z",
  "translationUpdatedAt": "2024-10-19T14:22:15.123Z"
}

Update an article

Request

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

Path Parameters

id - The unique identifier of the article to update

Request Body

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

title - The new title of the article
description - The new description of the article
body - The new HTML content of the article
formatter - Content formatter: "default" or "ai"
icon - Updated icon object for the article
parentId - New parent collection ID
authorId - ID of the new author (must be a member of the organization)
state - "live" or "draft" - if "live", publishes immediately
translations - Dictionary of updated translations keyed by locale

Response

Returns the updated article object with:

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)
author - Author information (name, authorId, avatarUrl)
translations - Translations for different locales
createdAt - ISO 8601 timestamp when created
updatedAt - ISO 8601 timestamp when last updated

Errors

404 - Article not found in your organization's help center

Security

bearerAuth

Path

idstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$required

The article unique identifier

Example: 1234567

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<= 512 characters

The new title of the article

Example: "Updated Getting Started Guide"

descriptionstring<= 512 characters

The new description of the article

Example: "Updated description"

bodystring

The new HTML content of the article

Example: "Updated content."

formatterstring

Content formatter

Default "default"

Enum"default""ai"

Example: "default"

iconobject or null

Icon object for the article

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

New parent collection ID

Example: "6474684"

authorIdstring

ID of the new author (must be a member of the organization)

Example: "507f1f77bcf86cd799439011"

statestring

Article state - if "live", publishes immediately

Enum"live""draft"

Example: "live"

translationsobject

Dictionary of updated translations keyed by locale code

curl -i -X PATCH \
  https://docs.featurebase.app/_mock/rest-api/v2/help_center/articles/1234567 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "title": "Updated Getting Started Guide",
    "description": "Updated description",
    "body": "<p>Updated content.</p>",
    "formatter": "default",
    "icon": {
      "value": "📖",
      "type": "emoji"
    },
    "parentId": "6474684",
    "authorId": "507f1f77bcf86cd799439011",
    "state": "live",
    "translations": {
      "bn": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "bs": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "pt-BR": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "bg": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "ca": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "hr": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "cs": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "da": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "nl": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "en": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "et": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "fi": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "fr": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "de": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "el": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "hi": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "hu": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "id": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "it": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "ja": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "ko": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "lv": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "lt": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "ms": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "mn": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "nb": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "pl": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "pt": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "ro": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "ru": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "sr": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "zh-CN": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "sk": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "sl": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "es": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "sw": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "sv": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "th": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "zh-TW": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "tr": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "uk": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      },
      "vi": {
        "title": "Getting Started Guide",
        "description": "Learn how to get started",
        "body": "<p>Welcome to our guide.</p>"
      }
    }
  }'

Responses

Success

Bodyapplication/json

objectstringrequired

Object type identifier

Value"article"

Example: "article"

idstringrequired

Article unique identifier

Example: "1234567"

titlestring

Article title

Example: "Getting Started Guide"

descriptionstring

Article description

Example: "Learn how to get started"

bodystring

Article body content (HTML)

Example: "Welcome to our guide."

slugstring

URL slug

Example: "1234567-getting-started-guide"

iconobject or null(ArticleIcon)

Article icon

parentIdstring or null

Parent collection ID

Example: "6474684"

helpCenterIdstringrequired

Help Center ID

Example: "j7c5g8ah3ewxp4lo"

organizationstringrequired

Organization ID

Example: "6595518396205e06b897ad65"

statestringrequired

Article state

Enum"live""draft"

Example: "live"

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"]

publishedLocalesArray of strings

Published locales

Items Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"

Example: ["en"]

featurebaseUrlstring

Featurebase URL

Example: "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide"

externalUrlstring

External URL

Example: "https://help.yourdomain.com/en/articles/1234567-getting-started-guide"

authorobject(ArticleAuthor)

Article author

ordernumber or null

Display order

Example: 1

isPublishedboolean

Whether the article is published

Example: true

isDraftDiffersFromLiveboolean

Whether draft differs from live

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"

liveUpdatedAtstring

ISO 8601 timestamp when live version was last updated

Example: "2024-10-18T13:03:25.921Z"

pathstring

Path to article within help center hierarchy

Example: "/getting-started"

surveyIdstring

Associated survey ID

Example: "6743752ca81ae59d25cf834b"

visibleByArray of strings

Visibility settings

Example: ["everyone"]

translationCreatedAtstring

ISO 8601 timestamp when translation was created

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

translationUpdatedAtstring

ISO 8601 timestamp when translation was last updated

Example: "2024-10-19T14:22:15.123Z"

Response

application/json

{
  "object": "article",
  "id": "1234567",
  "title": "Getting Started Guide",
  "description": "Learn how to get started",
  "body": "<p>Welcome to our guide.</p>",
  "slug": "1234567-getting-started-guide",
  "icon": {
    "type": "emoji",
    "value": "📖"
  },
  "parentId": "6474684",
  "helpCenterId": "j7c5g8ah3ewxp4lo",
  "organization": "6595518396205e06b897ad65",
  "state": "live",
  "defaultLocale": "en",
  "locale": "en",
  "availableLocales": [
    "en",
    "de"
  ],
  "publishedLocales": [
    "en"
  ],
  "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide",
  "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide",
  "author": {
    "name": "John Doe",
    "authorId": "507f1f77bcf86cd799439011",
    "avatarUrl": null
  },
  "order": 1,
  "isPublished": true,
  "isDraftDiffersFromLive": 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",
  "liveUpdatedAt": "2024-10-18T13:03:25.921Z",
  "path": "/getting-started",
  "surveyId": "6743752ca81ae59d25cf834b",
  "visibleBy": [
    "everyone"
  ],
  "translationCreatedAt": "2024-10-18T12:33:09.099Z",
  "translationUpdatedAt": "2024-10-19T14:22:15.123Z"
}

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

Featurebase API (2026-01-01.nova)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

API Versioning

Authentication

Error Handling

Boards

Posts

Post Statuses

Comments

Custom Fields

Changelogs

Admins

Teams

Brands

Contacts

Companies

Surveys

Help Centers

Create an article

Request

Request Body

Response

Responses

Was this helpful?

Get an article by ID

Request

Query Parameters

Response

Errors

Responses

Was this helpful?

Update an article

Request

Path Parameters

Request Body

Response

Errors

Responses

Was this helpful?

Conversations

Webhooks

Featurebase API (2026-01-01.nova)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

API Versioning

Authentication

Error Handling

Boards

Posts

Post Statuses

Comments

Custom Fields

Changelogs

Admins

Teams

Brands

Contacts

Companies

Surveys

Help Centers

Create an article

RequestExpand all

Request Body

Response

Responses

Was this helpful?

Get an article by ID

Request

Query Parameters

Response

Errors

Responses

Was this helpful?

Update an article

RequestExpand all

Path Parameters

Request Body

Response

Errors

Responses

Was this helpful?

Conversations

Webhooks

Featurebase API (2026-01-01.nova)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Request

Request