List published changelog entries

3 parameters

limitintegeroptional

Maximum number of changelog entries to return, from 1 to 100. Defaults to 20 when omitted.

Default:20

offsetintegeroptional

Number of changelog entries to skip. Must be zero or greater. Defaults to 0 when omitted.

Default:0

localestringoptional

Locale to use for translated changelog content.

2 status codes

200Returns a paginated response containing a `data` array of changelog entry objects and pagination metadata, including the limit, offset, and whether more results are available.

dataarray<object>optional

paginationobjectoptional

401Returned when the request is unauthenticated.

errorobjectoptional

Error handling

A 401 is returned when the request is unauthenticated. limit must be between 1 and 100, and offset must be zero or greater.

import { Client } from "supdesk-api-sdk";

const client = new Client({
  baseUrl: "https://api.supdesk.app",
});

const result = await client.changelog.list({
  limit: 20,
  offset: 0,
  locale: "example",
});

{
  "data": [
    {}
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "has_more": true
  }
}

Request

Response

Errors