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

# List playlists

> Lists every video in this workspace that has a playlist or course enabled, paginated 50 per page. A playlist is not a separate resource: it is settings stored on the video that anchors it, so each entry here is that anchor video, described from the playlist's point of view.

Requires a token with the `videos:read` scope.



## OpenAPI

````yaml /api-reference/openapi.json get /playlists
openapi: 3.1.0
info:
  title: TrackPlay API
  description: >-
    Send conversions and events to TrackPlay, and read them back. Authenticated
    with scoped tokens you mint in the dashboard.
  version: 1.0.0
servers:
  - url: https://app.trackplay.io/api/v1
    description: App API. Conversions, videos, webhooks.
  - url: https://e.trackplay.io
    description: Events API. High-volume event ingest.
security:
  - bearerAuth: []
tags:
  - name: Videos
    description: Create, read, update, and delete videos, and read workspace metadata.
  - name: Video settings
    description: Save a settings draft, publish it live, and read or restore past deploys.
  - name: Uploads
    description: >-
      Upload a source video file in one request or in resumable chunks, and poll
      its processing status.
  - name: Captions and chapters
    description: >-
      Manage caption tracks, chapter markers, AI-generated segments, and CTA
      cards on a video.
  - name: Playlists
    description: Group videos into a playlist or course, and manage the videos inside it.
  - name: Webhooks
    description: Subscribe a URL to TrackPlay lifecycle events and test deliveries.
  - name: Zapier
    description: >-
      The REST-hook endpoints Zapier calls to connect a workspace and manage
      triggers.
  - name: Analytics
    description: Read play, retention, event, and conversion analytics for a video.
  - name: Exports
    description: Queue and download bulk analytics exports.
  - name: Conversions
    description: Report a sale or a lead, from your own server or from a browser fallback.
  - name: Events
    description: Send a custom event tied to a viewer's session.
  - name: Identity
    description: Resolve a viewer's identity from the page, with no token required.
paths:
  /playlists:
    get:
      tags:
        - Playlists
      summary: List playlists
      description: >-
        Lists every video in this workspace that has a playlist or course
        enabled, paginated 50 per page. A playlist is not a separate resource:
        it is settings stored on the video that anchors it, so each entry here
        is that anchor video, described from the playlist's point of view.


        Requires a token with the `videos:read` scope.
      operationId: listPlaylists
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
      responses:
        '200':
          description: A page of playlists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaylistListResponse'
        '401':
          description: >-
            `AUTH_REQUIRED`: no token sent. `INVALID_TOKEN`: the token is
            invalid, expired, or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: '`INSUFFICIENT_SCOPE`: the token does not carry `videos:read`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: Rate limited. 600 requests per minute per token.
components:
  schemas:
    PlaylistListResponse:
      allOf:
        - $ref: '#/components/schemas/PaginationMeta'
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/PlaylistObject'
    ApiError:
      type: object
      description: The error shape the app API returns on a failed read or export.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                A stable error code, e.g. `INSUFFICIENT_SCOPE`,
                `VIDEO_NOT_FOUND`, `EXPORT_NOT_FOUND`.
            message:
              type: string
              description: What went wrong, in plain English.
    PaginationMeta:
      type: object
      description: Laravel's standard paginator envelope.
      properties:
        current_page:
          type: integer
        first_page_url:
          type: string
        from:
          type:
            - integer
            - 'null'
        last_page:
          type: integer
        last_page_url:
          type: string
        links:
          type: array
          items:
            type: object
            properties:
              url:
                type:
                  - string
                  - 'null'
              label:
                type: string
              active:
                type: boolean
        next_page_url:
          type:
            - string
            - 'null'
        path:
          type: string
        per_page:
          type: integer
        prev_page_url:
          type:
            - string
            - 'null'
        to:
          type:
            - integer
            - 'null'
        total:
          type: integer
    PlaylistObject:
      type: object
      properties:
        video_id:
          type: integer
          description: >-
            The numeric ID of the video the playlist lives on. A playlist has no
            ID of its own.
        video_code:
          type: string
        title:
          type: string
          description: The underlying video's title.
        playback_mode:
          type: string
          enum:
            - linear
            - course
        playlist_code:
          type:
            - string
            - 'null'
        item_count:
          type: integer
        auto_advance:
          type: boolean
        loop:
          type: boolean
        lesson_navigation:
          type: string
          enum:
            - sidebar
            - next-button
            - both
            - none
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A scoped token minted in **Settings → API tokens**. Send it as
        `Authorization: Bearer tplt_…` or `X-API-Key: tplt_…`.

````

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