Skip to main content
Changelogs

List changelogs

Returns the Changelogs (release notes) of your organization.

GET
/v2/outbound/changelogs

Changelogs keep users informed about new features, improvements and fixes. Each Changelog can have:

  • Multiple translations (locales)
  • Categories for organization
  • Featured images
  • Scheduled publishing

Pagination

This endpoint uses cursor-based pagination:

  • limit - Number of Changelogs to return (1-100, default 10)
  • cursor - Opaque cursor from a previous response's nextCursor field

Response Format

Returns a list object with:

  • object - Always "list"
  • data - Array of Changelog objects
  • nextCursor - Cursor for the next page (null if no more results)

Filtering

  • id - Find a specific Changelog by ID
  • q - Search query for title/content
  • categories - Filter by category names
  • locale - Get Changelogs in a specific locale (defaults to the organization default)
  • state - Filter by state: live, draft or all
  • startDate / endDate - Include Changelogs dated inside this range

Sorting

Results are sorted by date (descending by default):

  • sortBy - Field to sort by (currently only date)
  • sortOrder - asc or desc (default: desc)

Compatibility

Changelogs appear as Updates in the dashboard. Keep using /v2/outbound/changelogs, client.outbound.changelogs, and the changelog.published webhook. This reference describes Pulsar. The original /v2/changelogs routes still work; their behavior follows the selected API version. The Outbound paths require Pulsar or later. In Pulsar, the API key owner needs a full seat and the manage_changelogs permission.

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

idstringquery

Find a changelog by its unique identifier

Example: 6457e3ff70afca5d8c27dccc
qstringquery

Search for changelogs by title or content

Maximum string length: 255
Example: new feature
categoriesstring | string[]query

Filter changelogs by category names

localeenum<string>query

The changelog locale. Defaults to the organization default locale.

Available options: 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
Example: en
stateenum<string>querydefault:live

The changelog state. Use "all" to get both draft and live changelogs.

Available options: draft, live, all
Example: live
startDatestring | nullquery

Include changelogs dated on or after this date

Example: 2024-01-01
endDatestring | nullquery

Include changelogs dated on or before this date

Example: 2024-12-31
limitintegerquerydefault:10

Maximum number of changelogs to return

Required range: 1 <= x <= 100
Example: 10
cursorstringquery

Cursor for pagination. Use nextCursor from previous response.

Maximum string length: 512
Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
sortByenum<string>querydefault:date

Field to sort by

Available options: date
Example: date
sortOrderenum<string>querydefault:desc

Sort direction

Available options: asc, desc
Example: desc

Headers

Featurebase-Versionenum<string>header

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

Available options: 2026-09-03.pulsar, 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-09-03.pulsar

Response

application/json

Success

dataobject[]required

Array of changelogs

nextCursorstring | nullrequired

Cursor for fetching the next page (cursor-based pagination)

Maximum string length: 512
Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
objectenum<string>required

Object type identifier

Available options: list
Example: list
paginationobject

Pagination metadata for page-based requests

Still need help? Ask the team