Help Centers

Help centers are essential for providing users with accessible support and documentation. On this page, we'll explore the various help center endpoints you can use to manage them programmatically. We'll cover creating, updating, and retrieving help center collections and articles.

The Help Center Model

The Help Center model contains all the information about a help center, such as its title, description, navigation items, and more. It has the following properties:

Properties

Name
helpCenterId
Type
string
Description
The help center's unique ID.
Name
displayName
Type
string
Description
The display name of the help center. Usually your company name like "Featurebase".
Name
title
Type
string
Description
The title of the help center. Something like "How can we help you?" or "YourCompany Help Center".
Name
description
Type
string
Description
The description of the help center.
Name
navItems
Type
object[]
Description
An array of navigation items for the help center.
Name
isPublic
Type
boolean
Description
Indicates whether the help center is public.
Name
organizationId
Type
string
Description
The ID of the organization that the help center belongs to.
Name
defaultLocale
Type
string
Description
The default locale of the help center.
Name
locale
Type
string
Description
The locale of the help center.
Name
availableLocales
Type
string[]
Description
An array of available locales for the help center.
Name
createdAt
Type
Date
Description
The date when the help center was created.
Name
updatedAt
Type
Date
Description
The date when the help center was last updated.

GET/v2/help_center/help_centers

Get Help Centers

This endpoint allows you to retrieve a list of all your help centers. Currently, Featurebase only supports one help center per organization, but we plan on supporting multiple help centers in the future.

Request

GET

/v2/help_center/help_centers

curl -G https://do.featurebase.app/v2/help_center/help_centers \
  -H "X-API-Key: {token}"

Response

{
  "success": true,
  "results": [
    {
      "urls": {
        "featurebaseSubpath": "/help"
      },
      "helpCenterId": "2tgy0ig982j54qfl",
      "navItems": [
        {
          "type": "link",
          "title": "Developer Docs",
          "url": "https://developers.featurebase.app/install",
          "icon": null
        },
        {
          "type": "link",
          "title": "API",
          "url": "https://docs.featurebase.app/",
          "icon": null
        }
      ],
      "isPublic": false,
      "organizationId": "6595518396205e06b897ad65",
      "defaultLocale": "en",
      "createdAt": "2024-06-26T13:27:21.920Z",
      "updatedAt": "2024-06-26T13:52:19.415Z",
      "__v": 0,
      "displayName": "Your Help Center",
      "locale": "en",
      "availableLocales": [
        "en"
      ]
    }
  ]
}

GET/v2/help_center/help_centers/:helpCenterId

Get a Single Help Center

This endpoint allows you to retrieve a specific help center by its ID.

Request

GET

/v2/help_center/help_centers/:helpCenterId

curl -G https://do.featurebase.app/v2/help_center/help_centers/{helpCenterId} \
  -H "X-API-Key: {token}"

Response

{
  "helpCenterId": "j7c5g8ah3ewxp4lo",
  "navItems": [],
  "isPublic": true,
  "organizationId": "6595518396205e06b897ad65",
  "defaultLocale": "en",
  "createdAt": "2024-06-26T14:06:52.434Z",
  "updatedAt": "2024-10-08T12:41:33.945Z",
  "__v": 0,
  "title": "Your Help Center",
  "description": "",
  "searchPlaceholder": "",
  "locale": "en",
  "availableLocales": [
    "en"
  ],
  "urls": {
    "featurebaseSubpath": "/help"
  }
}

The Collection Model

Collections are sections of your help center that contain articles. Collections are nested and can be used to organize articles into a hierarchy by the parentId property.

Properties

Name
collectionId
Type
string
Description
The collection's unique ID.
Name
name
Type
string
Description
The name of the collection.
Name
description
Type
string
Description
A description of the collection.
Name
icon
Type
object
Description
An object representing the collection's icon.
Name
parentId
Type
string
Description
The ID of the parent collection, if the collection is nested.
Name
helpCenterId
Type
string
Description
The ID of the help center this collection belongs to.
Name
organizationId
Type
string
Description
The ID of the organization that the collection belongs to.
Name
defaultLocale
Type
string
Description
The default locale of the collection.
Name
translations
Type
object
Description
A dictionary of translations for different locales.
Name
order
Type
integer
Description
The order of the collection in listings.
Name
type
Type
string
Description
The type of the document, which is "collection".
Name
path
Type
string
Description
The path to the collection within the help center hierarchy.
Name
slug
Type
string
Description
The URL-friendly slug of the collection.
Name
featurebaseUrl
Type
string
Description
The Featurebase URL for the collection.
Name
externalUrl
Type
string
Description
The custom domain URL for the collection.
Name
locale
Type
string
Description
The locale of the collection.
Name
availableLocales
Type
string[]
Description
An array of available locales for the collection.

GET/v2/help_center/collections

List Collections

This endpoint allows you to retrieve a paginated list of collections within your help centers.

Query Parameters

Name
page
Type
integer
Description
Page number. Default is 1.
Name
limit
Type
integer
Description
Number of results per page. Maximum is 100. Default is 10.

Request

GET

/v2/help_center/collections

curl -G https://do.featurebase.app/v2/help_center/collections \
  -H "X-API-Key: {token}" \
  --data-urlencode "page=1" \
  --data-urlencode "limit=10"

Response

{
  "success": true,
  "results": [
    {
      "collectionId": "6474684",
      "icon": null,
      "authorCount": 0,
      "articleCount": 0,
      "parentId": null,
      "helpCenterId": "j7c5g8ah3ewxp4lo",
      "organizationId": "6595518396205e06b897ad65",
      "defaultLocale": "en",
      "translations": {
        "de": {
          "name": "German Collection Name",
          "description": "Eine Beschreibung auf Deutsch",
          "slug": "6474684-deutsche-version",
          "featurebaseUrl": "https://yourorg.featurebase.app/de/help/collections/6474684-deutsche-version",
          "articleCount": 10,
          "authorCount": 2,
          "externalUrl": "https://help.yourdomain.com/de/collections/6474684-deutsche-version"
        },
        "en": {
          "name": "English Collection Name",
          "description": "A description in English",
          "slug": "6474684-english-version",
          "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/6474684-english-version",
          "articleCount": 15,
          "authorCount": 3,
          "externalUrl": "https://help.yourdomain.com/en/collections/6474684-english-version"
        }
      },
      "order": null,
      "type": "collection",
      "path": "j7c5g8ah3ewxp4lo",
      "docCreatedAt": "2024-10-18T12:33:09.099Z",
      "docUpdatedAt": "2024-10-18T13:03:25.921Z",
      "__v": 0,
      "slug": "6474684-english-version",
      "name": "English Collection Name",
      "description": "A description in English",
      "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/6474684-english-version",
      "externalUrl": "https://help.yourdomain.com/en/collections/6474684-english-version",
      "locale": "en",
      "availableLocales": [
        "de",
        "en"
      ]
    },
    {
      "collectionId": "7013224",
      "icon": null,
      "authorCount": 0,
      "articleCount": 0,
      "parentId": null,
      "helpCenterId": "j7c5g8ah3ewxp4lo",
      "organizationId": "6595518396205e06b897ad65",
      "defaultLocale": "de",
      "translations": {
        "de": {
          "name": "Meine Sammlung",
          "description": "Eine andere Beschreibung",
          "slug": "7013224-meine-sammlung",
          "featurebaseUrl": "https://yourorg.featurebase.app/de/help/collections/7013224-meine-sammlung",
          "articleCount": 5,
          "authorCount": 1,
          "authors": ["Hans Müller"],
          "externalUrl": "https://help.yourdomain.com/de/collections/7013224-meine-sammlung"
        },
        "en": {
          "name": "My Collection",
          "description": "Another description in English",
          "slug": "7013224-my-collection",
          "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/7013224-my-collection",
          "articleCount": 8,
          "authorCount": 1,
          "authors": ["John Doe"],
          "externalUrl": "https://help.yourdomain.com/en/collections/7013224-my-collection"
        }
      },
      "order": 1,
      "type": "collection",
      "path": "j7c5g8ah3ewxp4lo",
      "docCreatedAt": "2024-10-18T12:32:44.143Z",
      "docUpdatedAt": "2024-10-18T12:33:09.208Z",
      "__v": 0,
      "slug": "7013224-my-collection",
      "name": "My Collection",
      "description": "Another description in English",
      "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/7013224-my-collection",
      "externalUrl": "https://help.yourdomain.com/en/collections/7013224-my-collection",
      "locale": "en",
      "availableLocales": [
        "de",
        "en"
      ]
    }
  ],
  "totalResults": 2,
  "page": 1,
  "limit": 10
}

GET/v2/help_center/collections/:collectionId

Get Collection by ID

Retrieve a specific collection by its ID.

Request

GET

/v2/help_center/collections/:collectionId

curl -G https://do.featurebase.app/v2/help_center/collections/{collectionId} \
  -H "X-API-Key: {token}"

Response

{
  "collectionId": "3416135",
  "icon": {
    "type": "emoji",
    "value": "🥾"
  },
  "authorCount": 0,
  "articleCount": 0,
  "parentId": null,
  "helpCenterId": "j7c5g8ah3ewxp4lo",
  "organizationId": "6595518396205e06b897ad65",
  "defaultLocale": "en",
  "translations": {
    "de": {
      "name": "Deutschsprachige Sammlung",
      "description": "Dies ist eine Sammlung von Artikeln auf Deutsch.",
      "slug": "3416135-deutschsprachige-sammlung",
      "featurebaseUrl": "https://yourorg.featurebase.app/de/help/collections/3416135-deutschsprachige-sammlung",
      "externalUrl": "https://feedback.mydomain.com/de/collections/3416135-deutschsprachige-sammlung"
    },
    "en": {
      "name": "English Collection",
      "description": "This is a collection of articles in English.",
      "slug": "3416135-english-collection",
      "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection",
      "externalUrl": "https://feedback.mydomain.com/en/collections/3416135-english-collection"
    }
  },
  "type": "collection",
  "path": "j7c5g8ah3ewxp4lo",
  "docCreatedAt": "2024-09-13T17:51:36.252Z",
  "docUpdatedAt": "2024-10-18T12:24:37.289Z",
  "__v": 0,
  "order": 3,
  "slug": "3416135-english-collection",
  "name": "English Collection",
  "description": "This is a collection of articles in English.",
  "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection",
  "externalUrl": "https://feedback.mydomain.com/en/collections/3416135-english-collection",
  "locale": "en",
  "availableLocales": [
    "de",
    "en"
  ]
}

POST/v2/help_center/collections

Create Collection

This endpoint allows you to create a new collection.

Required Attributes

Name
name
Type
string
Description
The name of the collection.

Optional Attributes

Name
description
Type
string
Description
A description of the collection.
Name
icon
Type
object
Description
An icon object representing the collection icon.
Name
parentId
Type
string
Description
The ID of the parent collection, if any.
Name
translations
Type
object
Description
A dictionary of translations keyed by locale.

Request

POST

/v2/help_center/collections

curl -X 'POST' 'https://do.featurebase.app/v2/help_center/collections' \
  -H 'X-API-Key: {token}' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "English Collection",
        "description": "This is a collection of articles in English.",
        "icon": {
          "type": "emoji",
          "value": "📚"
        }
      }'

Response

{
  "collectionId": "3416135",
  "icon": {
    "type": "emoji",
    "value": "📚"
  },
  "authorCount": 0,
  "articleCount": 0,
  "parentId": null,
  "helpCenterId": "j7c5g8ah3ewxp4lo",
  "organizationId": "6595518396205e06b897ad65",
  "defaultLocale": "en",
  "translations": {
    "de": {
      "name": "Deutschsprachige Sammlung",
      "description": "Dies ist eine Sammlung von Artikeln auf Deutsch.",
      "slug": "3416135-deutschsprachige-sammlung",
      "featurebaseUrl": "https://yourorg.featurebase.app/de/help/collections/3416135-deutschsprachige-sammlung",
      "externalUrl": "https://feedback.mydomain.com/de/collections/3416135-deutschsprachige-sammlung"
    },
    "en": {
      "name": "English Collection",
      "description": "This is a collection of articles in English.",
      "slug": "3416135-english-collection",
      "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection",
      "externalUrl": "https://feedback.mydomain.com/en/collections/3416135-english-collection"
    }
  },
  "type": "collection",
  "path": "j7c5g8ah3ewxp4lo",
  "docCreatedAt": "2024-09-13T17:51:36.252Z",
  "docUpdatedAt": "2024-10-18T12:24:37.289Z",
  "__v": 0,
  "order": 3,
  "slug": "3416135-english-collection",
  "name": "English Collection",
  "description": "This is a collection of articles in English.",
  "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection",
  "externalUrl": "https://feedback.mydomain.com/en/collections/3416135-english-collection",
  "locale": "en",
  "availableLocales": [
    "de",
    "en"
  ]
}

PATCH/v2/help_center/collections/:collectionId

Update Collection

This endpoint allows you to update an existing collection. Only include the fields you wish to update.

Required Parameters

Name
collectionId
Type
string
Description
The ID of the collection to update.

Optional Attributes

Name
name
Type
string
Description
The new name of the collection.
Name
description
Type
string
Description
The new description of the collection.
Name
icon
Type
object
Description
An updated icon object for the collection.
Name
parentId
Type
string
Description
The new parent collection ID, if applicable.
Name
translations
Type
object
Description
A dictionary of updated translations keyed by locale.

Request

PATCH

/v2/help_center/collections/:collectionId

curl -X 'PATCH' 'https://do.featurebase.app/v2/help_center/collections/{collectionId}' \
  -H 'X-API-Key: {token}' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "Updated Collection",
        "description": "Updated description in English."
      }'

Response

{
  "collectionId": "3416135",
  "icon": {
    "type": "emoji",
    "value": "📝"
  },
  "authorCount": 0,
  "articleCount": 0,
  "parentId": null,
  "helpCenterId": "j7c5g8ah3ewxp4lo",
  "organizationId": "6595518396205e06b897ad65",
  "defaultLocale": "en",
  "translations": {
    "de": {
      "name": "Deutschsprachige Sammlung",
      "description": "Dies ist eine Sammlung von Artikeln auf Deutsch.",
      "slug": "3416135-deutschsprachige-sammlung",
      "featurebaseUrl": "https://yourorg.featurebase.app/de/help/collections/3416135-deutschsprachige-sammlung",
      "externalUrl": "https://feedback.mydomain.com/de/collections/3416135-deutschsprachige-sammlung"
    },
    "en": {
      "name": "Updated Collection",
      "description": "Updated description in English.",
      "slug": "3416135-updated-collection",
      "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-updated-collection",
      "externalUrl": "https://feedback.mydomain.com/en/collections/3416135-updated-collection"
    }
  },
  "type": "collection",
  "path": "j7c5g8ah3ewxp4lo",
  "docCreatedAt": "2024-09-13T17:51:36.252Z",
  "docUpdatedAt": "2024-10-18T12:24:37.289Z",
  "__v": 0,
  "order": 3,
  "slug": "3416135-updated-collection",
  "name": "Updated Collection",
  "description": "Updated description in English.",
  "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-updated-collection",
  "externalUrl": "https://feedback.mydomain.com/en/collections/3416135-updated-collection",
  "locale": "en",
  "availableLocales": [
    "de",
    "en"
  ]
}

DELETE/v2/help_center/collections/:collectionId

Delete Collection

This endpoint allows you to delete a collection.

Required Parameters

Name
collectionId
Type
string
Description
The ID of the collection to delete.

Request

DELETE

/v2/help_center/collections/:collectionId

curl -X 'DELETE' 'https://do.featurebase.app/v2/help_center/collections/{collectionId}' \
  -H 'X-API-Key: {token}'

Response

// No content returned; HTTP Status Code: 204 No Content

The Article Model

The Article model contains all the information about an article, such as its title, description, body content, and translations. It has the following properties:

Properties

Name
articleId
Type
string
Description
The article's unique ID.
Name
title
Type
string
Description
The title of the article.
Name
description
Type
string
Description
A brief description of the article.
Name
body
Type
string
Description
The HTML content of the article.
Name
icon
Type
object
Description
An object representing the article's icon.
Name
parentId
Type
string
Description
The ID of the parent collection, if any.
Name
helpCenterId
Type
string
Description
The ID of the help center this article belongs to.
Name
organizationId
Type
string
Description
The ID of the organization that the article belongs to.
Name
state
Type
string
Description
The state of the article, either "live" or "draft".
Name
locale
Type
string
Description
The locale of the article.
Name
translations
Type
object
Description
A dictionary of translations for different locales.
Name
createdAt
Type
Date
Description
The date when the article was created.
Name
updatedAt
Type
Date
Description
The date when the article was last updated.
Name
author
Type
object
Description
An object containing information about the author of the article.
Name
slug
Type
string
Description
The URL-friendly slug of the article.
Name
featurebaseUrl
Type
string
Description
The Featurebase URL for the article.
Name
externalUrl
Type
string
Description
The external URL for the article.
Name
isDraftDiffersFromLive
Type
boolean
Description
Indicates whether the draft version differs from the live published version.
Name
isPublished
Type
boolean
Description
Indicates whether the article is published.
Name
availableLocales
Type
string[]
Description
An array of available locales for the article.
Name
publishedLocales
Type
string[]
Description
An array of locales in which the article is published.

GET/v2/help_center/articles

Get Articles

This endpoint allows you to retrieve a paginated list of articles in your help center.

Query Parameters

Name
state
Type
string
Description
Filter articles by state. Can be "live" or "draft".
Name
page
Type
integer
Description
Page number. Default is 1.
Name
limit
Type
integer
Description
Number of results per page. Maximum is 100. Default is 10.
Name
parentId
Type
string
Description
Get articles from a specific collection.

Request

GET

/v2/help_center/articles

curl -G https://do.featurebase.app/v2/help_center/articles \
  -H "X-API-Key: {token}" \
  --data-urlencode "state=live" \
  --data-urlencode "page=1" \
  --data-urlencode "limit=10"

Response

{
    "results": [
        {
            "organizationId": "6595518396205e06b897ad65",
            "helpCenterId": "j7c5g8ah3ewxp4lo",
            "articleId": "2067523",
            "icon": null,
            "translations": {
                "en": {
                    "title": "Test Article",
                    "description": "This is a placeholder for an English test article.",
                    "body": "<p>This article is currently empty.</p>",
                    "slug": "2067523-test-article",
                    "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/2067523-test-article",
                    "externalUrl": "https://help.yourdomain.com/en/articles/2067523-test-article",
                    "createdAt": "2024-10-16T11:29:11.208Z",
                    "updatedAt": "2024-10-16T11:29:20.318Z",
                    "author": {
                        "name": "Bruno from Featurebase",
                        "authorId": "5febde0bdc56d60012d47db5",
                        "avatarUrl": "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/878ab937-3862-4491-ba5c-4a65113a3765.png"
                    }
                },
                "de": {
                    "title": "Dokument ohne Titel",
                    "description": "Dies ist ein Platzhalter für einen Artikel ohne Inhalt.",
                    "body": "<p>Der Artikel ist derzeit leer.</p>",
                    "slug": "2067523-dokument-ohne-titel",
                    "featurebaseUrl": "https://yourorg.featurebase.app/de/help/articles/2067523-dokument-ohne-titel",
                    "externalUrl": "https://help.yourdomain.com/de/articles/2067523-dokument-ohne-titel",
                    "createdAt": "2024-10-16T11:29:03.852Z",
                    "updatedAt": "2024-10-16T11:29:13.499Z",
                    "author": {
                        "name": "Bruno from Featurebase",
                        "authorId": "5febde0bdc56d60012d47db5",
                        "avatarUrl": "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/878ab937-3862-4491-ba5c-4a65113a3765.png"
                    }
                }
            },
            "parentId": "2037123",
            "type": "article",
            "path": "j7c5g8ah3ewxp4lo/2037123",
            "docCreatedAt": "2024-10-16T11:29:03.914Z",
            "docUpdatedAt": "2024-10-16T11:29:20.318Z",
            "__v": 0,
            "slug": "2067523-test-article",
            "title": "Test Article",
            "description": "This is a placeholder for an English test article.",
            "body": "<p>This article is currently empty.</p>",
            "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/2067523-test-article",
            "externalUrl": "https://help.yourdomain.com/en/articles/2067523-test-article",
            "createdAt": "2024-10-16T11:29:11.208Z",
            "updatedAt": "2024-10-16T11:29:20.318Z",
            "author": {
                "name": "Bruno from Featurebase",
                "authorId": "5febde0bdc56d60012d47db5",
                "avatarUrl": "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/878ab937-3862-4491-ba5c-4a65113a3765.png"
            },
            "state": "live",
            "locale": "en",
            "isDraftDiffersFromLive": false,
            "isPublished": true,
            "availableLocales": [
                "en",
                "de"
            ],
            "publishedLocales": [
                "en",
                "de"
            ]
        },
        {
            "organizationId": "6595518396205e06b897ad65",
            "helpCenterId": "j7c5g8ah3ewxp4lo",
            "articleId": "6056746",
            "icon": null,
            "translations": {
                "en": {
                    "title": "Sample Article",
                    "description": "This is a sample English article.",
                    "body": "<p>Sample content for an English article.</p>",
                    "slug": "6056746-sample-article",
                    "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/6056746-sample-article",
                    "externalUrl": "https://help.yourdomain.com/en/articles/6056746-sample-article",
                    "createdAt": "2024-09-16T13:14:51.841Z",
                    "updatedAt": "2024-09-16T13:15:10.649Z",
                    "author": {
                        "name": "Bruno from Featurebase",
                        "authorId": "5febde0bdc56d60012d47db5",
                        "avatarUrl": "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/878ab937-3862-4491-ba5c-4a65113a3765.png"
                    }
                },
                "de": {
                    "title": "Beispielartikel",
                    "description": "Dies ist ein deutscher Testartikel.",
                    "body": "<p>Beispielinhalt für einen Artikel auf Deutsch.</p>",
                    "slug": "6056746-beispielartikel",
                    "featurebaseUrl": "https://yourorg.featurebase.app/de/help/articles/6056746-beispielartikel",
                    "externalUrl": "https://help.yourdomain.com/de/articles/6056746-beispielartikel",
                    "createdAt": "2024-09-16T13:14:50.755Z",
                    "updatedAt": "2024-09-16T13:15:01.218Z",
                    "author": {
                        "name": "Bruno from Featurebase",
                        "authorId": "5febde0bdc56d60012d47db5",
                        "avatarUrl": "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/878ab937-3862-4491-ba5c-4a65113a3765.png"
                    }
                }
            },
            "parentId": null,
            "type": "article",
            "path": "j7c5g8ah3ewxp4lo",
            "docCreatedAt": "2024-09-16T13:14:50.757Z",
            "docUpdatedAt": "2024-10-10T17:24:22.419Z",
            "__v": 0,
            "surveyId": "67080dc6ed2a5a03d2809365",
            "slug": "6056746-sample-article",
            "title": "Sample Article",
            "description": "This is a sample English article.",
            "body": "<p>Sample content for an English article.</p>",
            "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/6056746-sample-article",
            "externalUrl": "https://help.yourdomain.com/en/articles/6056746-sample-article",
            "createdAt": "2024-09-16T13:14:51.841Z",
            "updatedAt": "2024-09-16T13:15:10.649Z",
            "author": {
                "name": "Bruno from Featurebase",
                "authorId": "5febde0bdc56d60012d47db5",
                "avatarUrl": "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/878ab937-3862-4491-ba5c-4a65113a3765.png"
            },
            "state": "live",
            "locale": "en",
            "isDraftDiffersFromLive": false,
            "isPublished": true,
            "availableLocales": [
                "en",
                "de"
            ],
            "publishedLocales": [
                "en",
                "de"
            ]
        }
    ],
    "totalResults": 2,
    "page": 1,
    "limit": 10
}

GET/v2/help_center/articles/:articleId

Get Article by ID

Retrieve a specific article by its ID.

Request

GET

/v2/help_center/articles/:articleId

curl -G https://do.featurebase.app/v2/help_center/articles/{articleId} \
  -H "X-API-Key: {token}"

Response

{
    "_id": "670fa37f367156b9a5b01bbb",
    "organizationId": "6595518396205e06b897ad65",
    "helpCenterId": "j7c5g8ah3ewxp4lo",
    "articleId": "2067523",
    "icon": null,
    "translations": {
        "en": {
            "title": "Test Article",
            "description": "This is a placeholder for an English test article.",
            "body": "<p>This article is currently empty.</p>",
            "slug": "2067523-test-article",
            "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/2067523-test-article",
            "externalUrl": "https://help.yourdomain.com/en/articles/2067523-test-article",
            "createdAt": "2024-10-16T11:29:11.208Z",
            "updatedAt": "2024-10-16T11:29:20.318Z",
            "author": {
                "name": "Bruno from Featurebase",
                "authorId": "5febde0bdc56d60012d47db5",
                "avatarUrl": "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/878ab937-3862-4491-ba5c-4a65113a3765.png"
            }
        },
        "de": {
            "title": "Dokument ohne Titel",
            "description": "Dies ist ein Platzhalter für einen Artikel ohne Inhalt.",
            "body": "<p>Der Artikel ist derzeit leer.</p>",
            "slug": "2067523-dokument-ohne-titel",
            "featurebaseUrl": "https://yourorg.featurebase.app/de/help/articles/2067523-dokument-ohne-titel",
            "externalUrl": "https://help.yourdomain.com/de/articles/2067523-dokument-ohne-titel",
            "createdAt": "2024-10-16T11:29:03.852Z",
            "updatedAt": "2024-10-16T11:29:13.499Z",
            "author": {
                "name": "Bruno from Featurebase",
                "authorId": "5febde0bdc56d60012d47db5",
                "avatarUrl": "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/878ab937-3862-4491-ba5c-4a65113a3765.png"
            }
        }
    },
    "parentId": "2037123",
    "type": "article",
    "path": "j7c5g8ah3ewxp4lo/2037123",
    "docCreatedAt": "2024-10-16T11:29:03.914Z",
    "docUpdatedAt": "2024-10-16T11:29:20.318Z",
    "__v": 0,
    "slug": "2067523-test-article",
    "title": "Test Article",
    "description": "This is a placeholder for an English test article.",
    "body": "<p>This article is currently empty.</p>",
    "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/2067523-test-article",
    "externalUrl": "https://help.yourdomain.com/en/articles/2067523-test-article",
    "createdAt": "2024-10-16T11:29:11.208Z",
    "updatedAt": "2024-10-16T11:29:20.318Z",
    "author": {
        "name": "Bruno from Featurebase",
        "authorId": "5febde0bdc56d60012d47db5",
        "avatarUrl": "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/878ab937-3862-4491-ba5c-4a65113a3765.png"
    },
    "state": "live",
    "locale": "en",
    "isDraftDiffersFromLive": false,
    "isPublished": true,
    "availableLocales": [
        "en",
        "de"
    ],
    "publishedLocales": [
        "en",
        "de"
    ]
}

POST/v2/help_center/articles

Create Article

This endpoint allows you to create a new article.

Required Attributes

Name
title
Type
string
Description
The title of the article.

Optional Attributes

Name
description
Type
string
Description
A brief description of the article.
Name
body
Type
string
Description
The HTML content of the article.
Name
formatter
Type
string
Description
The formatter of the article. Can be "default" or "ai". The AI formatter is currently in beta and will convert any markdown/html content to the Featurebase format. The response times may be slow and the output is not guaranteed to be perfect. Learn more about importing help center articles here.
Name
parentId
Type
string
Description
The ID of the parent collection, if any.
Name
icon
Type
object
Description
An icon object representing the article icon.
Name
state
Type
string
Description
The state of the article, either "live" or "draft". Defaults to "draft".
Name
translations
Type
object
Description
A dictionary of translations keyed by locale.

Request

POST

/v2/help_center/articles

curl -X 'POST' 'https://do.featurebase.app/v2/help_center/articles' \
  -H 'X-API-Key: {token}' \
  -H 'Content-Type: application/json' \
  -d '{
        "title": "New Article",
        "description": "An article about new features.",
        "body": "<p>Content of the article.</p>",
        "state": "draft"
      }'

Response

{
    "organizationId": "6595518396205e06b897ad65",
    "helpCenterId": "j7c5g8ah3ewxp4lo",
    "articleId": "7890123",
    "icon": null,
    "translations": {
        "en": {
            "title": "New Article",
            "description": "An article about new features.",
            "body": "<p>Content of the article.</p>",
            "slug": "7890123-new-article",
            "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/7890123-new-article",
            "externalUrl": "https://help.yourdomain.com/en/articles/7890123-new-article",
            "createdAt": "2024-10-18T12:00:00.000Z",
            "updatedAt": "2024-10-18T12:00:00.000Z",
            "author": {
                "name": "Your Name",
                "authorId": "5febde0bdc56d60012d47db5",
                "avatarUrl": "https://your-avatar-url.com/avatar.png"
            }
        },
        "de": {
            "title": "Neuer Artikel",
            "description": "Ein Artikel über neue Funktionen.",
            "body": "<p>Inhalt des Artikels.</p>",
            "slug": "7890123-neuer-artikel",
            "featurebaseUrl": "https://yourorg.featurebase.app/de/help/articles/7890123-neuer-artikel",
            "externalUrl": "https://help.yourdomain.com/de/articles/7890123-neuer-artikel",
            "createdAt": "2024-10-18T12:00:00.000Z",
            "updatedAt": "2024-10-18T12:00:00.000Z",
            "author": {
                "name": "Your Name",
                "authorId": "5febde0bdc56d60012d47db5",
                "avatarUrl": "https://your-avatar-url.com/avatar.png"
            }
        }
    },
    "parentId": null,
    "type": "article",
    "path": "j7c5g8ah3ewxp4lo",
    "docCreatedAt": "2024-10-18T12:00:00.000Z",
    "docUpdatedAt": "2024-10-18T12:00:00.000Z",
    "__v": 0,
    "slug": "7890123-new-article",
    "title": "New Article",
    "description": "An article about new features.",
    "body": "<p>Content of the article.</p>",
    "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/7890123-new-article",
    "externalUrl": "https://help.yourdomain.com/en/articles/7890123-new-article",
    "createdAt": "2024-10-18T12:00:00.000Z",
    "updatedAt": "2024-10-18T12:00:00.000Z",
    "author": {
        "name": "Your Name",
        "authorId": "5febde0bdc56d60012d47db5",
        "avatarUrl": "https://your-avatar-url.com/avatar.png"
    },
    "state": "draft",
    "locale": "en",
    "isDraftDiffersFromLive": false,
    "isPublished": false,
    "availableLocales": [
        "en",
        "de"
    ],
    "publishedLocales": []
}

PATCH/v2/help_center/articles/:articleId

Update Article

This endpoint allows you to update an existing article. Only include the fields you wish to update.

Required Parameters

Name
articleId
Type
string
Description
The ID of the article to update.

Optional Attributes

Name
title
Type
string
Description
The new title of the article.
Name
description
Type
string
Description
The new description of the article.
Name
body
Type
string
Description
The new HTML content of the article.
Name
icon
Type
object
Description
An updated icon object for the article.
Name
parentId
Type
string
Description
The new parent collection ID, if applicable.
Name
authorId
Type
string
Description
The ID of the new author.
Name
state
Type
string
Description
The new state of the article, either "live" or "draft". If set to "live", the article will be published immediately in the default locale & translations you provide.
Name
translations
Type
object
Description
A dictionary of updated translations keyed by locale.

Request

PATCH

/v2/help_center/articles/:articleId

curl -X 'PATCH' 'https://do.featurebase.app/v2/help_center/articles/{articleId}' \
  -H 'X-API-Key: {token}' \
  -H 'Content-Type: application/json' \
  -d '{
        "title": "Updated Article",
        "state": "live"
      }'

Response

{
    "organizationId": "6595518396205e06b897ad65",
    "helpCenterId": "j7c5g8ah3ewxp4lo",
    "articleId": "7890123",
    "icon": null,
    "translations": {
        "en": {
            "title": "Updated Article",
            "description": "Updated description.",
            "body": "<p>Updated content of the article.</p>",
            "slug": "7890123-updated-article",
            "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/7890123-updated-article",
            "externalUrl": "https://help.yourdomain.com/en/articles/7890123-updated-article",
            "createdAt": "2024-10-18T12:00:00.000Z",
            "updatedAt": "2024-10-18T13:00:00.000Z",
            "author": {
                "name": "Your Name",
                "authorId": "5febde0bdc56d60012d47db5",
                "avatarUrl": "https://your-avatar-url.com/avatar.png"
            }
        }
    },
    "parentId": null,
    "type": "article",
    "path": "j7c5g8ah3ewxp4lo",
    "docCreatedAt": "2024-10-18T12:00:00.000Z",
    "docUpdatedAt": "2024-10-18T13:00:00.000Z",
    "__v": 0,
    "slug": "7890123-updated-article",
    "title": "Updated Article",
    "description": "Updated description.",
    "body": "<p>Updated content of the article.</p>",
    "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/7890123-updated-article",
    "externalUrl": "https://help.yourdomain.com/en/articles/7890123-updated-article",
    "createdAt": "2024-10-18T12:00:00.000Z",
    "updatedAt": "2024-10-18T13:00:00.000Z",
    "author": {
        "name": "Your Name",
        "authorId": "5febde0bdc56d60012d47db5",
        "avatarUrl": "https://your-avatar-url.com/avatar.png"
    },
    "state": "live",
    "locale": "en",
    "isDraftDiffersFromLive": false,
    "isPublished": true,
    "availableLocales": [
        "en"
    ],
    "publishedLocales": [
        "en"
    ]
}

DELETE/v2/help_center/articles/:articleId

Delete Article

This endpoint allows you to delete an article.

Required Parameters

Name
articleId
Type
string
Description
The ID of the article to delete.

Request

DELETE

/v2/help_center/articles/:articleId

curl -X 'DELETE' 'https://do.featurebase.app/v2/help_center/articles/{articleId}' \
  -H 'X-API-Key: {token}'

Response

// No content returned; HTTP Status Code: 204 No Content