ChangelogService

List Changelog Changes

List changes across published posts, for example every breaking change since a given time.

Method

GET

Path

/v1/changelog/changes

Visibility

Public endpoint

GET

/v1/changelog/changes

Request

Testnet

curl --request GET \ \
  --url 'https://api.testnet.polyester.com/v1/changelog/changes?actionRequired=false&audiences=ALL_USERS&categories=BREAKING_CHANGE&limit=100&postSlug=value&sort=ASC&surfaces=TRADING' \
  --header 'Accept: */*'

Responses

{
  "changes": [
    {
      "change": {
        "actionRequired": false,
        "audiences": [
          "ALL_USERS"
        ],
        "category": "BREAKING_CHANGE",
        "details": "value",
        "id": "2",
        "migrationGuidance": "value",
        "summary": "value",
        "surfaces": [
          "TRADING"
        ],
        "title": "My Trading Board"
      },
      "postSlug": "value",
      "publishedAt": "2025-01-01T00:00:00Z",
      "sectionHeading": "value"
    }
  ],
  "nextPageToken": "eyJvZmZzZXQiOjIwMH0"
}

actionRequired boolean

When set, only changes whose actionRequired equals this value.

audiences array max 4 items, unique

Audiences to include; repeat the parameter for several. Empty means all. Changes addressed to ALL_USERS always match.

categories array max 4 items, unique

Categories to include; repeat the parameter for several. Empty means all.

endTime string (date-time)

Exclusive upper bound on post publication time, RFC 3339; must be after startTime when both are set.

limit integer ≤ 500

Maximum changes to return. 0 or omitted means the default of 100; maximum 500.

pageToken string max 512 chars

Opaque, keyset-backed, exclusive cursor from a previous response. Reuse it only with the same filters, time bounds and sort.

postSlug string max 200 chars

Restrict to one post.

sort enum must be defined value

Order of posts by publication time; changes keep publication order inside each post. Defaults to DESC.

startTime string (date-time)

Inclusive lower bound on post publication time, RFC 3339.

surfaces array max 10 items, unique

Surfaces to include; repeat the parameter for several. Empty means all.

4 fields

nextPageToken string

Cursor for the next page. Empty when no more results exist.

Example eyJvZmZzZXQiOjIwMH0

Possible errors: 5

Key	HTTP status	Connect code	Error	When
unauthenticated	401	unauthenticated	Unauthenticated	Authentication required.
permission-denied	403	permission_denied	Permission Denied	Permission denied.
invalid-argument	400	invalid_argument	Invalid Argument	Invalid argument.
not-found	404	not_found	Not Found	Not found.
unavailable	503	unavailable	Unavailable	Service unavailable.

GET

/v1/changelog/changes

Request

Testnet

curl --request GET \ \
  --url 'https://api.testnet.polyester.com/v1/changelog/changes?actionRequired=false&audiences=ALL_USERS&categories=BREAKING_CHANGE&limit=100&postSlug=value&sort=ASC&surfaces=TRADING' \
  --header 'Accept: */*'

Responses

{
  "changes": [
    {
      "change": {
        "actionRequired": false,
        "audiences": [
          "ALL_USERS"
        ],
        "category": "BREAKING_CHANGE",
        "details": "value",
        "id": "2",
        "migrationGuidance": "value",
        "summary": "value",
        "surfaces": [
          "TRADING"
        ],
        "title": "My Trading Board"
      },
      "postSlug": "value",
      "publishedAt": "2025-01-01T00:00:00Z",
      "sectionHeading": "value"
    }
  ],
  "nextPageToken": "eyJvZmZzZXQiOjIwMH0"
}