> ## Documentation Index
> Fetch the complete documentation index at: https://docs.punchplay.tv/llms.txt
> Use this file to discover all available pages before exploring further.

# List comments on a title, season or episode

> Readable without a token; isOwn and the currentUser fields are populated when one is sent.



## OpenAPI

````yaml /openapi.yaml get /api/platform/v1/title/{type}/{id}/comments
openapi: 3.1.0
info:
  title: PunchPlay Platform API
  version: 1.0.0-beta.5
  description: >-
    Beta contract for the Platform API and stable v1 contract for the read-only
    Public API. OAuth access tokens use explicit per-operation scopes.
servers:
  - url: https://punchplay.tv
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: Authentication
  - name: Profile
  - name: Titles
  - name: History
  - name: Ratings
  - name: Lists
  - name: Collection
  - name: Playback
  - name: Calendar
  - name: Community
  - name: Notifications
  - name: Trophies
  - name: Sync
  - name: Public Catalog
  - name: Public Users
  - name: Public API
paths:
  /api/platform/v1/title/{type}/{id}/comments:
    parameters:
      - $ref: '#/components/parameters/TitleType'
      - $ref: '#/components/parameters/SourceId'
    get:
      tags:
        - Titles
      summary: List comments on a title, season or episode
      description: >-
        Readable without a token; isOwn and the currentUser fields are populated
        when one is sent.
      operationId: listTitleComments
      parameters:
        - in: query
          name: season
          schema:
            type: integer
            minimum: 0
        - in: query
          name: episode
          schema:
            type: integer
            minimum: 0
      responses:
        '200':
          $ref: '#/components/responses/TitleCommentsSuccess'
        '400':
          $ref: '#/components/responses/ApiError'
        '401':
          $ref: '#/components/responses/ApiError'
        '403':
          $ref: '#/components/responses/ApiError'
        '404':
          $ref: '#/components/responses/ApiError'
        '429':
          $ref: '#/components/responses/ApiError'
        '503':
          $ref: '#/components/responses/ApiError'
      security:
        - oauth2:
            - profile:read
components:
  parameters:
    TitleType:
      in: path
      name: type
      required: true
      schema:
        type: string
        enum:
          - movie
          - show
    SourceId:
      in: path
      name: id
      required: true
      schema:
        type: string
        pattern: ^(\d+|tt\d+|tvdb:\d+|mal:\d+)$
  responses:
    TitleCommentsSuccess:
      description: Comments on a title, season or episode
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TitleCommentsResponse'
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Ceiling of the most constraining bucket for this request.
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requests remaining in the current window.
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Unix time in seconds when the current window resets.
    ApiError:
      description: API error
      headers:
        X-PunchPlay-Request-Id:
          schema:
            type: string
        Retry-After:
          schema:
            type: integer
            minimum: 0
          description: Seconds until the client should retry a rate-limited request.
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Ceiling of the most constraining bucket for this request.
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requests remaining in the current window.
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Unix time in seconds when the current window resets.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    TitleCommentsResponse:
      type: object
      required:
        - currentUserId
        - currentUserName
        - currentUserAvatar
        - reviews
      properties:
        currentUserId:
          type:
            - string
            - 'null'
        currentUserName:
          type:
            - string
            - 'null'
        currentUserAvatar:
          type:
            - string
            - 'null'
        reviews:
          type: array
          items:
            $ref: '#/components/schemas/TitleComment'
    ApiError:
      type: object
      required:
        - error
        - message
        - request_id
      properties:
        error:
          type: string
        message:
          type: string
        request_id:
          type:
            - string
            - 'null'
        required_scope:
          type: string
      additionalProperties: true
    TitleComment:
      type: object
      required:
        - id
        - displayName
        - avatarUrl
        - body
        - bodyHtml
        - containsSpoilers
        - rating
        - createdAt
        - updatedAt
        - isOwn
        - replies
      properties:
        id:
          type: integer
        displayName:
          type: string
        avatarUrl:
          type:
            - string
            - 'null'
        body:
          type: string
        bodyHtml:
          type: string
        containsSpoilers:
          type: boolean
        rating:
          type:
            - integer
            - 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        isOwn:
          type: boolean
        replies:
          type: array
          items:
            $ref: '#/components/schemas/TitleCommentReply'
    TitleCommentReply:
      type: object
      required:
        - id
        - displayName
        - avatarUrl
        - body
        - bodyHtml
        - createdAt
        - isOwn
      properties:
        id:
          type: integer
        displayName:
          type: string
        avatarUrl:
          type:
            - string
            - 'null'
        body:
          type: string
        bodyHtml:
          type: string
        createdAt:
          type: string
          format: date-time
        isOwn:
          type: boolean
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /api/platform/v1/oauth/authorize
          tokenUrl: /api/platform/v1/oauth/token
          scopes:
            profile:read: Read basic profile and title metadata
            history:read: Read watch history
            history:write: Log, edit, and delete watches
            lists:read: Read lists
            lists:write: Create and edit lists
            ratings:read: Read ratings, favourites, and statuses
            ratings:write: Rate, favourite, and change statuses
            collection:read: Read collection items
            collection:write: Add and remove collection items
            notifications:read: Read notifications and notification preferences
            notifications:write: Manage notification read state and preferences
            trophies:read: Read trophy progress
            profile:write: Update profile details and preferences
            playback:read: Read playback and continue-watching state
            playback:write: Update playback state
            events:read: Subscribe to playback events

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.