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

# List videos

> Returns a paginated list of the account's videos, ten per page. All filters are optional and combine with AND. Requires the `READ_MEDIA` scope.



## OpenAPI

````yaml GET /v1/api/video
openapi: 3.1.0
info:
  title: PN Player API
  description: >-
    Manage videos, captions, playlists, tags, analytics, team members and
    account settings for your PN Player account.


    All `/v1/api` endpoints accept either an API key in the `X-Auth-Token`
    header or a JWT in the `Authorization: Bearer` header. Most endpoints also
    require the calling user to hold a specific role (scope): `READ_MEDIA`,
    `UPDATE_MEDIA`, `READ_ANALYTICS`, `READ_BILLING`, `READ_SETTINGS`,
    `UPDATE_SETTINGS` or `UPDATE_USERS`. The required scope is noted on each
    endpoint.
  version: 2.0.0
servers:
  - url: https://api.pnplayer.com
security:
  - apiKeyAuth: []
  - bearerAuth: []
tags:
  - name: Authentication
    description: >-
      Obtain a session token or reset a password. These endpoints do not require
      authentication.
  - name: Videos
    description: Create, list, update and delete videos.
  - name: Captions
    description: Upload, download, transcribe and manage caption tracks for a video.
  - name: Playlists
    description: Manual and rule-based (dynamic) playlists.
  - name: Tags
    description: Account-level tags that can be attached to videos.
  - name: Analytics
    description: Playback, engagement and usage metrics.
  - name: Reports
    description: Saved analytics report links.
  - name: Account
    description: Team members and account-wide streaming and security settings.
  - name: Profile
    description: The authenticated user's own profile.
  - name: API keys
    description: Long-lived keys for programmatic access.
  - name: Webhooks
    description: Configure the HTTPS endpoint that receives signed event notifications.
  - name: Billing
    description: Plan, usage, invoices, expansion packs and billing address.
  - name: Transcription settings
    description: Per-account key/value settings for automatic transcription.
  - name: Feature requests
    description: Submit, upvote and discuss feature requests.
  - name: Agreements
    description: Data processing agreement (DPA) and enterprise order form signing.
paths:
  /v1/api/video:
    get:
      tags:
        - Videos
      summary: List videos
      description: >-
        Returns a paginated list of the account's videos, ten per page. All
        filters are optional and combine with AND. Requires the `READ_MEDIA`
        scope.
      parameters:
        - name: page
          in: query
          description: Page number, starting at 1
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: search
          in: query
          description: Case-insensitive match against the title or the video ID
          schema:
            type: string
        - name: startDate
          in: query
          description: Only videos uploaded on or after this date (`YYYY-MM-DD`)
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          description: Only videos uploaded on or before this date (`YYYY-MM-DD`)
          schema:
            type: string
            format: date
        - name: status
          in: query
          description: >-
            Comma-separated status codes. A video matches if it has any of them.
            See `VideoSummary.status` for the codes.
          schema:
            type: string
            example: 3,4
        - name: minDuration
          in: query
          description: Minimum duration in whole seconds
          schema:
            type: integer
            minimum: 0
        - name: maxDuration
          in: query
          description: Maximum duration in whole seconds
          schema:
            type: integer
            minimum: 0
        - name: hasCaptions
          in: query
          description: >-
            `true` returns only videos with at least one caption track, `false`
            only videos with none
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
        - name: audioStatus
          in: query
          description: >-
            Filter by audio extraction state. `none` means extraction has not
            been recorded.
          schema:
            type: string
            enum:
              - ready
              - pending
              - failed
              - none
        - name: sort
          in: query
          description: Sort order. Unknown values fall back to `newest`.
          schema:
            type: string
            enum:
              - newest
              - oldest
              - title
              - title_desc
              - longest
              - shortest
              - largest
              - smallest
            default: newest
        - name: tag
          in: query
          description: Comma-separated tag IDs. A video matches if it has any of them.
          schema:
            type: string
            example: 3,7,12
      responses:
        '200':
          description: A page of videos
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoList'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    VideoList:
      type: object
      properties:
        totalItems:
          type: integer
          description: Total videos matching the filters
        currentPage:
          type: integer
        itemsPerPage:
          type: integer
          example: 10
        items:
          type: array
          items:
            $ref: '#/components/schemas/VideoSummary'
        totalVideos:
          type: integer
          description: Same as `totalItems`
    VideoSummary:
      type: object
      properties:
        videoId:
          type: string
          example: 657bb740-a71b-4529-a012-528021c31a92
        title:
          type: string
        dateUploaded:
          type: string
          format: date-time
        encodeProgress:
          type: number
          description: 0–100. Always 100 once the video is ready.
        status:
          type: integer
          description: >-
            Processing status: `0` created, `1` uploaded, `2` processing, `3`
            transcoding, `4` ready, `5` failed
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
        length:
          type: number
          description: Duration in seconds
        storageSize:
          type: integer
          description: Size in bytes
        hlsUrl:
          type: string
          format: uri
          description: HLS playlist URL
        preview:
          type: string
          format: uri
          description: Animated preview (WebP) URL
    Error:
      type: object
      required:
        - message
      properties:
        message:
          type: string
  responses:
    Forbidden:
      description: The caller lacks the required scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Forbidden
    ServerError:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        API key created in the dashboard or via `POST /v1/api/api-keys`. Keys
        are prefixed `pn_` and do not expire until revoked.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Session token from `POST /auth/token`, valid for 24 hours.

````