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

# Get a playlist

> Returns the playlist with its manually added videos in order. For dynamic playlists use `GET /v1/api/playlist/{id}/resolve` to get the rule matches. Requires the `READ_MEDIA` scope.



## OpenAPI

````yaml GET /v1/api/playlist/{id}
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/playlist/{id}:
    parameters:
      - $ref: '#/components/parameters/playlistId'
    get:
      tags:
        - Playlists
      summary: Get a playlist
      description: >-
        Returns the playlist with its manually added videos in order. For
        dynamic playlists use `GET /v1/api/playlist/{id}/resolve` to get the
        rule matches. Requires the `READ_MEDIA` scope.
      responses:
        '200':
          description: Playlist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Playlist'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    playlistId:
      name: id
      in: path
      required: true
      description: Playlist ID
      schema:
        type: string
        format: uuid
  schemas:
    Playlist:
      allOf:
        - $ref: '#/components/schemas/PlaylistSummary'
        - type: object
          properties:
            videos:
              type: array
              items:
                $ref: '#/components/schemas/PlaylistVideo'
    PlaylistSummary:
      type: object
      properties:
        playlistId:
          type: string
          format: uuid
        title:
          type: string
        description:
          type: string
        type:
          type: string
          enum:
            - manual
            - dynamic
        thumbnailUrl:
          type: string
          format: uri
        videoCount:
          type: integer
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        rules:
          type: array
          items:
            $ref: '#/components/schemas/DynamicRule'
    PlaylistVideo:
      type: object
      properties:
        videoId:
          type: string
        title:
          type: string
        preview:
          type: string
          format: uri
        length:
          type: number
          description: Duration in seconds
        order:
          type: integer
          description: Zero-based position
    Error:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    DynamicRule:
      type: object
      required:
        - field
        - operator
        - value
        - logic
      description: >-
        Rules are evaluated in order. The first rule seeds the result; each
        following rule is combined with the running result using its own
        `logic`.
      properties:
        field:
          type: string
          enum:
            - tag
            - title
            - dateUploaded
            - status
        operator:
          type: string
          enum:
            - contains
            - equals
            - before
            - after
          description: >-
            `before`/`after` apply to `dateUploaded`; `contains`/`equals` to the
            other fields
        value:
          type: string
        logic:
          type: string
          enum:
            - AND
            - OR
  responses:
    Forbidden:
      description: The caller lacks the required scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Forbidden
    NotFound:
      description: Resource not found in this account
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Not found
  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.

````