v1

latestOpenAPI 3.1.0MIT2026-07-173438118.7 KB

Series

List user's series with cursor-based pagination

Errors

Returns error if series database query fails or connection issues occur

get/api/series

Query parameters

offsetstring uuid nullable

UUID offset for cursor-based series pagination

limitinteger nullable

Maximum number of series to return (default: 50, max: 100)

Response

Series list retrieved

categorystring nullable

Category or genre of the series

coverImageUrlstring nullable

URL to the series cover image

createdAtstring date-time nullable

Series creation timestamp

descriptionstring nullable

Description of the series content and purpose

idstring uuid required

Series unique identifier

lengthinteger nullable

Total number of posts in the series

slugstring required

SEO-friendly URL identifier for the series

titlestring required

Display name of the series

updatedAtstring date-time nullable

Series last update timestamp

userIdstring uuid required

ID of the user who owns this series

Example response

[
  {
    "category": "Technology",
    "coverImageUrl": "https://example.com/cover.jpg",
    "createdAt": "2023-01-01T00:00:00Z",
    "description": "A weekly podcast about technology and innovation",
    "id": "e5f6a7b8-9012-3456-ef01-345678901234",
    "length": 42,
    "slug": "my-awesome-podcast",
    "title": "My Awesome Podcast",
    "updatedAt": "2023-01-01T12:00:00Z",
    "userId": "f6a7b8c9-0123-4567-f012-456789012345"
  }
]