Help Center API Reference

Retrieve the API tab pages

Returns the guide pages of the API tab: the landing article (introArticleId) and the sidebar sections above the endpoint groups. A section lists the articles of a collection (collection) or a titled group of articles (articles).

GET

/v2/help_center/api_pages

curl --request GET \
  --url 'https://do.featurebase.app/v2/help_center/api_pages?helpCenterId=ox6qrqprmsuqaunj&apiSlug=default' \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit'

{
  "apiSlug": "default",
  "articles": {},
  "collectionIds": [
    "5928310"
  ],
  "collections": {},
  "helpCenterId": "ox6qrqprmsuqaunj",
  "introArticleId": "7765420",
  "object": "help_center_api_pages",
  "sections": [
    {
      "articleIds": [
        "<string>"
      ],
      "collectionId": "<string>",
      "id": "<string>",
      "kind": "collection",
      "title": "<string>"
    }
  ],
  "updatedAt": "2026-10-01T12:00:00.000Z"
}

A collection in a collection section shows in the API tab instead of the Documentation tab (collectionIds). The articles stay normal help center articles: edit them with the article endpoints.

One set of pages per help center and API (apiSlug, today always default), shared by every version.

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Query Parameters

helpCenterIdstringquery

The help center. Defaults to the active help center of your organization.

Required string length: 1 - 16

Pattern: ^[a-zA-Z0-9]+$

Example: ox6qrqprmsuqaunj

apiSlugstringquery

The API of the help center. Today every help center has one API: default.

Required string length: 1 - 32

Pattern: ^[a-z0-9][a-z0-9-]*$

Example: default

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Example: 2026-08-19.orbit

Response

Success

apiSlugstringrequired

Example: default

articlesobjectrequired

Labels of the referenced articles (default locale), by article id.

collectionIdsstring[]required

The collections shown in the API tab (from the collection sections), in order.

collectionsobjectrequired

Names of the referenced collections, by collection id.

helpCenterIdstringrequired

Example: ox6qrqprmsuqaunj

introArticleIdstring | nullrequired

The landing page article of the API tab. Null = the generated overview.

Example: 7765420

objectenum<string>required

Available options: help_center_api_pages

Example: help_center_api_pages

sectionsobject[]required

Sidebar sections above the endpoint groups, in order. A collection section moves that collection from the Documentation tab to the API tab.

Show child attributes

updatedAtstring | nullrequired

When the pages were last saved.

Example: 2026-10-01T12:00:00.000Z

Still need help? Ask the team