List all changelogs

List all changelog entries with pagination.

Introduction

The FeatureOS list all changelog API allows you to retrieve information about your changelogs.

GET https://api.featureos.app/api/v3/changelogs

curl -X GET 'https://api.featureos.app/api/v3/changelogs' \
  -H 'API-KEY: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const response = await fetch('https://api.featureos.app/api/v3/changelogs', {
  method: 'GET',
  headers: {
    'API-KEY': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.get(
    'https://api.featureos.app/api/v3/changelogs',
    headers={
        'API-KEY': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    }
)
data = response.json()

Headers

Parameter	Default	Description
API-KEY	-	Generate from organization settings on the admin dashboard.

Query Parameters

Parameter	Default	Description
page	1	Used to paginate responses.
status	-	Filter based on status. Can be set to `published`/`unpublished`/`scheduled`.
locale	-	The changelogs's language code: `en` (English), `es` (Spanish), `pt` (Portuguese), `de` (German), `fr` (French), `ja` (Japanese), `ru` (Russian), `ko` (Korean), `zh` (Chinese Simplified), `zh-TW` (Chinese Traditional), `pt-BR` (Brazilian Portuguese), `it` (Italian), `nl` (Dutch), `tr` (Turkish), `id` (Indonesian), `vi` (Vietnamese), `th` (Thai), `pl` (Polish), `sv` (Swedish), `ms` (Malay), `tl` (Tagalog), `da` (Danish), `ar` (Arabic).

Sample response

{
  "changelogs": [
    {
      "id": 1,
      "title": "API V1 is now live!",
      "preview": "Go use our new API now!",
      "description": "<p>Go use our new API now! Go on, you can do it!</p>",
      "description_markdown": "Go use our new API now! Go on, you can do it!",
      "locale": "en",
      "url": "https://feeback.featureos.app/changelogs/api-v1-is-now-live",
      "published": true,
      "published_on": "October 12th, 2021",
      "scheduled_published_at": null,
      "author": {
        "name": "S Jobs",
        "email": "[email protected]"
      },
      "labels": [
        {
          "id": 3,
          "name": "New Feature",
          "color": "green"
        }
      ]
    }
  ]
}