Changelogs

Get a changelog by ID

Retrieves a single changelog by its unique identifier or slug.

GET

/v2/changelogs/{id}

curl --request GET \
  --url 'https://do.featurebase.app/v2/changelogs/{id}?allTranslations=true&state=live' \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit'

{
  "allowedSegmentIds": [],
  "availableLocales": [
    "en",
    "de",
    "fr"
  ],
  "categories": [
    {
      "id": "6438a1efda3640f8feb72121",
      "name": "New Features",
      "roles": []
    }
  ],
  "commentCount": 2,
  "content": "<p>Your changelog content in HTML format.</p>",
  "createdAt": "2023-12-12T00:00:00.000Z",
  "date": "2023-05-07T12:59:59.000Z",
  "emailSentToSubscribers": true,
  "featuredImage": "https://cdn.example.com/images/feature.png",
  "id": "6457e3ff70afca5d8c27dccc",
  "isDraftDiffersFromLive": false,
  "isPublished": true,
  "locale": "en",
  "markdownContent": "Your changelog content in markdown format.",
  "notifications": {},
  "object": "changelog",
  "organization": "myorg",
  "publishedLocales": [
    "en",
    "de"
  ],
  "slug": "your-awesome-changelog",
  "slugs": {
    "de": "dein-tolles-changelog",
    "en": "your-awesome-changelog"
  },
  "state": "live",
  "title": "Your awesome changelog!",
  "translations": {},
  "updatedAt": "2023-12-13T00:00:00.000Z",
  "url": "https://myorg.featurebase.app/en/changelog/your-awesome-changelog"
}

Returns the full changelog object including:

Title and content (in HTML and markdown formats)
Featured image
Publication date
Categories
Comment count
Email notification status

Localization

The changelog content is returned in the organization's default locale. If the changelog doesn't exist in the default locale, a 404 is returned.

Orbit supports allTranslations=true to include a locale-keyed translations dictionary. With this option, state=live|draft selects the version for both the primary content and translations (default: live). Locales without that version are omitted; stored disabled locales remain readable. Without this option, the response is unchanged and prefers live content, falling back to draft.

State

Both published (live) and draft changelogs can be retrieved. The state field indicates the current publication status.

Autorizaciones

Authorizationstringheaderobligatorio

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

Parámetros de ruta

idstringobligatorio

Changelog unique identifier

Ejemplo: 507f1f77bcf86cd799439011

Parámetros de consulta

allTranslationsenum<string>query

Include a locale-keyed translations dictionary. Omitted or false preserves the existing response.

Opciones disponibles: true, false

stateenum<string>query

Version for allTranslations=true, defaulting to live. Ignored otherwise. Locales without this version are omitted.

Opciones disponibles: live, draft

Encabezados

Featurebase-Versionenum<string>header

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

Opciones disponibles: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Ejemplo: 2026-08-19.orbit

Respuesta

Success

allowedSegmentIdsstring[]obligatorio

Segment IDs that are allowed to view this changelog

availableLocalesstring[]obligatorio

Array of locale codes where the changelog has content

categoriesobject[]obligatorio

Categories the changelog belongs to

Mostrar child attributes

commentCountnumberobligatorio

Number of comments

Ejemplo: 2

contentstringobligatorio

Content in HTML format

Ejemplo: <p>Your changelog content in HTML format.</p>

createdAtstringobligatorio

ISO 8601 timestamp when created

Ejemplo: 2023-12-12T00:00:00.000Z

datestringobligatorio

Publication date as ISO 8601 timestamp

Ejemplo: 2023-05-07T12:59:59.000Z

emailSentToSubscribersbooleanobligatorio

Whether email notification was sent to subscribers

Ejemplo: true

featuredImagestring | nullobligatorio

Featured image URL

Ejemplo: https://cdn.example.com/images/feature.png

idstringobligatorio

Unique identifier

Ejemplo: 6457e3ff70afca5d8c27dccc

isDraftDiffersFromLivebooleanobligatorio

Whether the draft content differs from the published live content

Ejemplo: false

isPublishedbooleanobligatorio

Whether the changelog is published (has a live version) in this locale

Ejemplo: true

localeenum<string>obligatorio

Locale of the changelog

Opciones disponibles: ar, am, fa, ht, lo, my, pa, ps, so, tl, ur, he, ta, te, mr, gu, kn, ml, ha, jv, yo, ig, uz, ne, sd, az, si, km, kk, 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

Ejemplo: en

markdownContentstring | nullobligatorio

Content in markdown format

Ejemplo: Your changelog content in markdown format.

notificationsobjectobligatorio

Notification settings for each locale

objectenum<string>obligatorio

Object type identifier

Opciones disponibles: changelog

Ejemplo: changelog

organizationstringobligatorio

Organization identifier

Ejemplo: myorg

publishedLocalesstring[]obligatorio

Array of locale codes where the changelog is published

slugstringobligatorio

URL-friendly slug

Ejemplo: your-awesome-changelog

slugsobjectobligatorio

URL-friendly slugs for each locale

stateenum<string>obligatorio

State of the changelog

Opciones disponibles: live, draft

Ejemplo: live

titlestringobligatorio

Changelog title

Ejemplo: Your awesome changelog!

translationsobject

updatedAtstringobligatorio

ISO 8601 timestamp when updated

Ejemplo: 2023-12-13T00:00:00.000Z

urlstringobligatorio

Public URL to view the changelog

Ejemplo: https://myorg.featurebase.app/en/changelog/your-awesome-changelog

¿Aún necesitas ayuda? Pregunta al equipo