List changelog entries

Paginated list of changelog entries with optional type and label filters. Uses skip/limit instead of cursor.

Returns a paginated list of changelog entries for the authenticated organization. Filterable by entry type and by one or more label_ids.

This endpoint accepts skip and limit (Canny-compatible offsets) on input but returns the standard cursor-paginated envelope on output. This is the only public API endpoint that uses skip-based input — all others use cursor.

Endpoint

POST https://api.productbridge.io/api/external/v1/changelog/list

Arguments

body

api_keystring

Required

Your organization's public API key. See Authentication.

body

typestring

Filter to entries with this single classification. One of "fixed", "new", "improved".

body

label_idsarray of strings

Filter to entries that have at least one of these labels. All ids must belong to your organization.

body

sortstring

Sort order. One of "newest" (default), "oldest", "published".

body

limitinteger

Number of items per page. Min 1, max 100. Defaults to 25.

body

skipinteger

Number of items to skip from the start of the result set. Defaults to 0. Use this for offset-based pagination.

Returns

The standard cursor-paginated envelope.

{
  "items": [ /* changelog entry objects */ ],
  "has_next_page": true,
  "cursor": "MjU"
}

Example request

curl -X POST https://api.productbridge.io/api/external/v1/changelog/list \
  -H 'Content-Type: application/json' \
  -d '{
    "api_key": "pb_YOUR_PUBLIC_API_KEY",
    "type":    "new",
    "limit":   25
  }'

const res = await fetch(
  "https://api.productbridge.io/api/external/v1/changelog/list",
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      api_key: process.env.PRODUCTBRIDGE_API_KEY,
      type: "new",
      limit: 25,
    }),
  }
);
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const { items, has_next_page, cursor } = await res.json();

import os, httpx

resp = httpx.post(
    "https://api.productbridge.io/api/external/v1/changelog/list",
    json={
        "api_key": os.environ["PRODUCTBRIDGE_API_KEY"],
        "type": "new",
        "limit": 25,
    },
)
resp.raise_for_status()
payload = resp.json()

Example response

{
  "items": [
    {
      "id":    "11ab3ef8-b8cd-cd15-01ba-changelog0001",
      "title": "v1.2 release: dark mode + faster search",
      "content": "We shipped two of the most-requested features...",
      "slug": "v1-2-release",
      "status_code": "published",
      "show_on_portal": true,
      "featured_image_url": null,
      "author_id": "cc3c3ef8-b8cd-cd15-01ba-adminuser001",
      "scheduled_at": null,
      "published_at": "2026-05-01T10:00:00.000Z",
      "created_at":   "2026-04-30T15:30:00.000Z",
      "updated_at":   "2026-05-01T10:00:00.000Z"
    }
  ],
  "has_next_page": false,
  "cursor": null
}

Errors

Status	Body	Cause
`401`	`{"detail":{"error":"invalid api_key"}}`	Missing / unknown / inactive `api_key`.
`422`	Validation error envelope	`type` not in `{"fixed","new","improved"}`, `limit` out of range, malformed UUIDs in `label_ids`.

See Errors and Pagination.

Was this page helpful?

Last updated 1 week ago

Built with Documentation.AI