Help Center API Reference

Get the status of a CI sync or import

Returns the status of one sync of an API reference version. Poll it from your CI after a sync call. The last 20 syncs of each version are kept.

GET

/v2/help_center/api_specs/{specId}/syncs/{syncId}

curl --request GET \
  --url https://do.featurebase.app/v2/help_center/api_specs/{specId}/syncs/{syncId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit'

{
  "autoPublishBlocked": [
    "<string>"
  ],
  "code": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "finishedAt": "2023-11-07T05:31:56Z",
  "revision": 123,
  "sha256": "<string>",
  "status": "queued",
  "success": true,
  "syncId": "<string>"
}

Send an Idempotency-Key header with the sync call to make retries safe: a retry with the same key (within 24 hours) returns the first syncId and creates no second draft.

It also returns the status of an import (POST /v2/help_center/api_specs/{specId}/import). OAuth and MCP tokens can call it.

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

specIdstringrequired

The API reference version.

Example: 66f7d0c1a2b3c4d5e6f70812

syncIdstringrequired

The syncId the sync call returned.

Example: 0f7c3a1e-8d1b-4a53-9a51-3f7a1c9e2b4d

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

autoPublishBlockedstring[]

Why an auto-publish stayed a draft.

codestring

The no-op reason or the error code.

createdAtstringrequired

errorstring

Why the sync failed (admin-facing).

finishedAtstring | nullrequired

revisionnumber | nullrequired

The revision the sync created or matched.

sha256string

statusenum<string>required

queued / retrying: still running. noop: nothing changed. draft: a draft is ready for review. published: auto-published. failed: see error (code stale: the sync did not finish within 2 hours; push again).

Available options: queued, retrying, noop, draft, published, failed

successenum<boolean>required

Available options: true

syncIdstringrequired

Still need help? Ask the team