Skip to main content
client.gamma.series.listSeries returns series metadata, including nested events, categories, tags, and optional chat data.

​
Request

const series = await client.gamma.series.listSeries(params);

​
Parameters

NameTypeRequiredDefaultNotes
limitnumber (≥ 0)–Page size.
offsetnumber (≥ 0)–Page offset.
orderstring–Sort expression.
ascendingboolean–Sort direction.
slugstring[]–Filter by series slug(s).
categories_idsnumber[]–Filter by category IDs.
categories_labelsstring[]–Filter by category labels.
closedboolean–Filter by closed status.
include_chatboolean–Include chat metadata.
recurrencestring–Filter by recurrence (e.g., daily).

​
Response

Each entry matches the Series type exported by the SDK, containing fields such as title, seriesType, tags, chats, and nested events arrays.

​
Usage example

const dailySeries = await client.gamma.series.listSeries({ recurrence: "daily", limit: 5 });

console.log(dailySeries.map((entry) => entry.title));

​
Failure modes

  • Empty array filters (e.g., slug: []) trigger validation errors.