Help Center API Reference

List API reference versions

Lists the API reference versions of your help centers. One version is one OpenAPI spec: its source, the live revision, whether a draft waits for review, and the last sync.

GET

/v2/help_center/api_specs

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

{
  "data": [
    {
      "apiSlug": "default",
      "createdAt": "2026-10-01T12:00:00.000Z",
      "draftRevision": 8,
      "hasDraft": true,
      "helpCenterId": "ox6qrqprmsuqaunj",
      "id": "66f7d0c1a2b3c4d5e6f70812",
      "isDefault": true,
      "lastSync": {
        "code": "<string>",
        "createdAt": "2026-10-01T12:00:00.000Z",
        "error": "<string>",
        "finishedAt": "2026-10-01T12:00:00.000Z",
        "revision": 8,
        "status": "draft",
        "syncId": "0f7c3a1e-8d1b-4a53-9a51-3f7a1c9e2b4d"
      },
      "liveOperationCount": 42,
      "liveRevision": 7,
      "name": "Acme API",
      "object": "help_center_api_spec",
      "source": {
        "autoSync": false,
        "lastError": "<string>",
        "lastFetchedAt": "2026-10-01T12:00:00.000Z",
        "type": "api",
        "url": "https://api.acme.com/openapi.json"
      },
      "status": "active",
      "updatedAt": "2026-10-01T12:00:00.000Z",
      "versionLabel": "v2",
      "versionSlug": "v2",
      "visibleBy": [
        "everyone"
      ]
    }
  ],
  "nextCursor": null,
  "object": "list"
}

Filter with helpCenterId to get the versions of one help center. A help center has at most 50 versions, so every version comes back in one page.

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

helpCenterIdstringquery

Only the versions of this help center. Without it, the versions of every help center are listed.

Required string length: 1 - 16

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

Example: ox6qrqprmsuqaunj

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

dataobject[]required

API reference versions.

Show child attributes

nextCursorstring | nullrequired

Always null: every version is returned in one page.

objectenum<string>required

Object type identifier

Available options: list

Example: list

Still need help? Ask the team