> ## 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.

# Create a list



## OpenAPI

````yaml /openapi.yaml post /api/platform/v1/lists
openapi: 3.1.0
info:
  title: PunchPlay API
  version: 1.0.0-beta.3
  description: >-
    Complete beta contract for native and third-party clients, plus the stable
    read-only public profile API. OAuth access tokens use explicit per-operation
    scopes.
  summary: Platform and public API surface for PunchPlay developers.
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: Public Catalog
  - name: Public Users
paths:
  /api/platform/v1/lists:
    post:
      tags:
        - Lists
      summary: Create a list
      operationId: createList
      requestBody:
        $ref: '#/components/requestBodies/ListCreate'
      responses:
        '201':
          $ref: '#/components/responses/ListCreatedSuccess'
        '400':
          $ref: '#/components/responses/ApiError'
        '401':
          $ref: '#/components/responses/ApiError'
        '403':
          $ref: '#/components/responses/ApiError'
        '408':
          $ref: '#/components/responses/ApiError'
        '413':
          $ref: '#/components/responses/ApiError'
        '429':
          $ref: '#/components/responses/ApiError'
      security:
        - oauth2:
            - lists:write
components:
  requestBodies:
    ListCreate:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListCreateInput'
  responses:
    ListCreatedSuccess:
      description: Created list
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListCreated'
      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
        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:
    ListCreateInput:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 100
        description:
          type:
            - string
            - 'null'
          maxLength: 500
        isPublic:
          type: boolean
          default: true
    ListCreated:
      type: object
      required:
        - id
        - name
        - description
        - isPublic
        - isWatchlist
        - isDynamicList
        - lastSyncedAt
        - isCollaborative
        - isFeatured
        - ownerUsername
        - itemCount
        - itemBreakdown
        - createdAt
        - previewPosters
      properties:
        id:
          type: integer
          minimum: 1
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        isPublic:
          type: boolean
        isWatchlist:
          type: boolean
        isDynamicList:
          type: boolean
        lastSyncedAt:
          type: 'null'
        isCollaborative:
          type: boolean
        isFeatured:
          type: boolean
        ownerUsername:
          type:
            - string
            - 'null'
        itemCount:
          type: integer
          minimum: 0
        itemBreakdown:
          type: object
          required:
            - movies
            - shows
            - anime
          properties:
            movies:
              type: integer
            shows:
              type: integer
            anime:
              type: integer
          additionalProperties: false
        createdAt:
          type: string
          format: date-time
        previewPosters:
          type: array
          items:
            $ref: '#/components/schemas/ListPreviewPoster'
      additionalProperties: false
    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
    ListPreviewPoster:
      type: object
      required:
        - posterPath
        - tmdbId
        - type
      properties:
        posterPath:
          type: string
        tmdbId:
          type: integer
          minimum: 1
        type:
          type: string
          enum:
            - movie
            - show
  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

````