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

# Get video library dashboard

> Coach-only. Returns video-library statistics, category summaries, a paginated video list, and available filter values for the dashboard.

Requires the workout_library:read scope. This operation maps to /app/v1/workout/video-library/dashboard and retains its Workout V2 permission, feature-flag, and resource-scope checks.

The clientId path parameter is resolved inside the company bound to the Public API token when present.



## OpenAPI

````yaml /openapi/public-v1.json get /public/v1/workout/video-library/dashboard
openapi: 3.1.0
info:
  title: FITsociety Public API v1
  version: 1.0.0
  description: >-
    Developer Public API endpoints under `/public/v1`. This reference is
    filtered to OAuth/Bearer Public API resources and excludes provider callback
    receivers, storefront routes, public widgets, wishlist routes, and
    access-device validation endpoints.
  contact:
    name: FITsociety Engineering
servers:
  - url: https://api.fitsociety.io
    description: Production
security: []
tags:
  - name: Workout
    description: >-
      Workout V2 libraries, programmes, client plans, calendars, sessions,
      groups, settings and progress. AI operations are excluded.
  - name: OAuth
    description: Public API OAuth endpoints for server-to-server client credentials.
  - name: Health
    description: Public API token health checks.
  - name: Platform
    description: >-
      Inspect Public API client context, capabilities, scopes, and redacted
      audit logs.
  - name: Company Catalog
    description: Read and manage company profile metadata and locations.
  - name: Clients
    description: >-
      Create and manage clients through the Public API using Bearer access
      tokens.
  - name: Coaches
    description: Retrieve coaches for the authenticated company via integrations.
  - name: Calendar Events
    description: Read Public API calendar events.
  - name: Calendar Templates
    description: >-
      Read and manage event types and event templates used by calendar
      availability and bookings.
  - name: Calendar Extensions
    description: >-
      Read recurring bookings, booking requests, calendar tasks, and
      availability closure metadata.
  - name: Availability
    description: Read bookable availability slots and signed availability tokens.
  - name: Availability Management
    description: >-
      Manage coach and location availability templates used to derive bookable
      slots.
  - name: Bookings
    description: Read and manage Public API bookings.
  - name: Finance
    description: >-
      Read invoices, transactions, products, subscriptions, and memberships with
      guarded finance writes.
  - name: Credits
    description: >-
      Read company-wide and client-scoped credit allocations, mutations, and
      guarded credit adjustments.
  - name: Exports
    description: >-
      Create and monitor asynchronous company exports through Public API Bearer
      endpoints.
  - name: Webhooks
    description: >-
      Manage outbound webhook subscriptions and inspect delivery attempts
      through Public API Bearer endpoints.
  - name: Measurements
    description: Read and write client measurement entries.
  - name: Progress Photos
    description: Read client progress photo metadata and short-lived signed media URLs.
  - name: Forms
    description: Read, create, update, and archive company form templates.
  - name: Intakes
    description: Assign intake forms and read client intake assignments and submissions.
  - name: Check-ups
    description: >-
      Schedule and cancel client check-ups and read their status and
      submissions.
  - name: Documents
    description: >-
      Read client document and folder metadata, register external document
      links, update metadata, and archive documents from Public API listings.
      Binary upload, permanent deletion, and company-wide document management
      are not exposed.
  - name: Habits
    description: Read habits and habit entries.
  - name: Goals
    description: Read client goal summaries.
  - name: Conversations
    description: >-
      Read and manage direct and group chat conversations through the Public
      API.
  - name: Reports
    description: Read aggregate attendance, revenue, and retention summaries.
paths:
  /public/v1/workout/video-library/dashboard:
    get:
      tags:
        - Workout
      summary: Get video library dashboard
      description: >-
        Coach-only. Returns video-library statistics, category summaries, a
        paginated video list, and available filter values for the dashboard.


        Requires the workout_library:read scope. This operation maps to
        /app/v1/workout/video-library/dashboard and retains its Workout V2
        permission, feature-flag, and resource-scope checks.


        The clientId path parameter is resolved inside the company bound to the
        Public API token when present.
      operationId: publicWorkoutgetPublicV1WorkoutVideoLibraryDashboard
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            minimum: 1
            example: 1
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            example: 10
        - in: query
          name: search
          schema:
            type: string
            example: core
          description: Case-insensitive title search.
        - in: query
          name: duration
          schema:
            type: string
            enum:
              - 1-10
              - 11-20
              - 21-30
              - 30+
            example: 1-10
          description: >-
            Comma-separated duration ranges in minutes. Supported values are
            `1-10`, `11-20`, `21-30`, and `30+`.
        - in: query
          name: level
          schema:
            type: string
            enum:
              - allLevels
              - beginner
              - intermediate
              - advance
            example: beginner
          description: >-
            Comma-separated level filters. Supported values are `allLevels`,
            `beginner`, `intermediate`, and `advance`.
        - in: query
          name: category
          schema:
            type: string
            example: Strength
          description: >-
            Comma-separated category names. Repeated `category` query parameters
            are also accepted and treated as one combined list.
        - in: query
          name: coaches
          schema:
            type: string
            example: 67f1234567890abcdef1111,67f1234567890abcdef2222
          description: >-
            Comma-separated coach ids. Filters to videos added by these coaches
            (`addedByRole: Coach`).
        - in: query
          name: published
          schema:
            type: string
            enum:
              - all
              - 'yes'
              - 'no'
            example: all
          description: Publish-status filter.
      responses:
        '200':
          description: Video library dashboard data fetched successfully.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PublicApiSuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: >-
                          #/components/schemas/PublicWorkoutSourceGETAppV1WorkoutVideoLibraryDashboardResponse200
              examples:
                success:
                  summary: Successful response
                  value:
                    data:
                      statistics:
                        totalVideos: 24
                        totalCategories: 6
                        publishedVideos: 18
                      categories:
                        items:
                          - _id: 67f1234567890abcdef1234
                            name: Strength
                            icon: dumbbell
                            order: 1
                            status: true
                            videoCount: 8
                        totalCount: 6
                      videos:
                        items:
                          - _id: 67f1234567890abcdef1234
                            name: Core Fundamentals
                            title: Core Fundamentals
                            description: Learn the basics of core training.
                            video:
                              lang: en
                              url: >-
                                https://cdn.example.com/video-library/company123/video-en.mp4
                              thumbnail: >-
                                https://cdn.example.com/video-library/company123/thumb-en.jpg
                              duration: 300
                              width: 1920
                              height: 1080
                              size: 104857600
                              platform: s3
                            url: >-
                              https://cdn.example.com/video-library/company123/video-en.mp4
                            thumbnail: >-
                              https://cdn.example.com/video-library/company123/thumb-en.jpg
                            duration: 300
                            platform: s3
                            language: en
                            category: Strength
                            level: Intermediate
                            isPublished: true
                            published: true
                            publishedAt: '2026-04-12T10:00:00.000Z'
                            viewCount: 42
                            views: 42
                            createdAt: '2026-04-12T10:00:00.000Z'
                            updatedAt: '2026-04-12T10:00:00.000Z'
                            availableLanguages:
                              - en
                              - nl
                            allTitles:
                              - lang: en
                                value: Core Fundamentals
                              - lang: nl
                                value: Kern Fundamenten
                            allDescriptions:
                              - lang: en
                                value: Core Fundamentals
                              - lang: nl
                                value: Kern Fundamenten
                            allVideos:
                              - lang: en
                                url: >-
                                  https://cdn.example.com/video-library/company123/video-en.mp4
                                thumbnail: >-
                                  https://cdn.example.com/video-library/company123/thumb-en.jpg
                                duration: 300
                                width: 1920
                                height: 1080
                                size: 104857600
                                platform: s3
                        pagination:
                          page: 1
                          limit: 10
                          totalItems: 25
                          totalPages: 3
                      filterOptions:
                        availableFilters:
                          duration:
                            - 1-10
                            - 11-20
                            - 21-30
                            - 30+
                          level:
                            - allLevels
                            - beginner
                            - intermediate
                            - advance
                          category:
                            - Strength
                            - Mobility
                          coaches:
                            - id: 67f1234567890abcdef1234
                              name: Jane Smith
                              image: https://cdn.example.com/coaches/jane.jpg
                          published:
                            - all
                            - 'yes'
                            - 'no'
                        selectedFilters: {}
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '400':
          description: Company context is missing or pagination is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                invalidRequest:
                  summary: Invalid request
                  value:
                    error:
                      code: 400
                      key: request.invalid
                      message: The request is invalid.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '401':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                missingBearer:
                  summary: Missing Bearer token
                  value:
                    error:
                      code: 401
                      key: auth.missing_bearer
                      message: Authorization Bearer token is required.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                invalidToken:
                  summary: Invalid or expired token
                  value:
                    error:
                      code: 401
                      key: auth.invalid_token
                      message: The access token is invalid or expired.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                invalidClient:
                  summary: Inactive or revoked client
                  value:
                    error:
                      code: 401
                      key: auth.invalid_client
                      message: The Public API client is inactive or revoked.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '403':
          description: Caller is not a coach (`AUTH_NOT_COACH`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                insufficientScopes:
                  summary: Missing required scope
                  value:
                    error:
                      code: 403
                      key: scopes.insufficient
                      message: The access token does not include the required scope.
                      details:
                        requiredScopes:
                          - required:scope
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '404':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                notFound:
                  summary: Resource not found
                  value:
                    error:
                      code: 404
                      key: resource.not_found
                      message: The requested Public API resource was not found.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '409':
          $ref: '#/components/schemas/ErrorResponse'
        '422':
          $ref: '#/components/schemas/ErrorResponse'
        '429':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                rateLimitExceeded:
                  summary: Rate limit exceeded
                  value:
                    error:
                      code: 429
                      key: rate_limit.exceeded
                      message: Too many Public API requests. Retry later.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 0
                        resetSeconds: 1
                        retryAfterSeconds: 1
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                serverInternalError:
                  summary: Unexpected server error
                  value:
                    error:
                      code: 500
                      key: server.internal_error
                      message: An unexpected Public API server error occurred.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
      security:
        - PublicBearerAuth: []
      x-codeSamples:
        - lang: cURL
          label: cURL
          source: >-
            curl -X GET
            "https://api.fitsociety.io/public/v1/workout/video-library/dashboard"
            \
              -H "Authorization: Bearer <access_token>"
components:
  schemas:
    PublicApiSuccessResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          type: object
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    PublicWorkoutSourceGETAppV1WorkoutVideoLibraryDashboardResponse200:
      type: object
      properties:
        statistics:
          type: object
          properties:
            totalVideos:
              type: integer
              example: 24
            totalCategories:
              type: integer
              example: 6
            publishedVideos:
              type: integer
              example: 18
        categories:
          type: object
          properties:
            items:
              type: array
              items:
                type: object
                properties:
                  _id:
                    type: string
                    example: 67f1234567890abcdef1234
                  name:
                    type: string
                    example: Strength
                  icon:
                    type: string
                    example: dumbbell
                  order:
                    type: integer
                    example: 1
                  status:
                    type: boolean
                    example: true
                  videoCount:
                    type: integer
                    example: 8
                additionalProperties: true
            totalCount:
              type: integer
              example: 6
        videos:
          type: object
          properties:
            items:
              type: array
              items:
                type: object
                properties:
                  _id:
                    type: string
                    example: 67f1234567890abcdef1234
                  name:
                    type: string
                    example: Core Fundamentals
                    description: Localized title alias used by dashboard/table views.
                  title:
                    type: string
                    example: Core Fundamentals
                  description:
                    type: string
                    example: Learn the basics of core training.
                  video:
                    type: object
                    nullable: true
                    properties:
                      lang:
                        type: string
                        example: en
                      url:
                        type: string
                        example: >-
                          https://cdn.example.com/video-library/company123/video-en.mp4
                      thumbnail:
                        type: string
                        example: >-
                          https://cdn.example.com/video-library/company123/thumb-en.jpg
                      duration:
                        type: number
                        nullable: true
                        example: 300
                      width:
                        type: integer
                        nullable: true
                        example: 1920
                      height:
                        type: integer
                        nullable: true
                        example: 1080
                      size:
                        type: integer
                        nullable: true
                        example: 104857600
                      platform:
                        type: string
                        enum:
                          - s3
                          - youtube
                          - tiktok
                          - vimeo
                          - facebook
                          - instagram
                          - other
                        example: s3
                  url:
                    type: string
                    example: >-
                      https://cdn.example.com/video-library/company123/video-en.mp4
                  thumbnail:
                    type: string
                    example: >-
                      https://cdn.example.com/video-library/company123/thumb-en.jpg
                  duration:
                    type: number
                    nullable: true
                    example: 300
                  platform:
                    type: string
                    enum:
                      - s3
                      - youtube
                      - tiktok
                      - vimeo
                      - facebook
                      - instagram
                      - other
                    example: s3
                  language:
                    type: string
                    example: en
                  category:
                    type: string
                    example: Strength
                  level:
                    type: string
                    enum:
                      - Beginner
                      - Intermediate
                      - Advanced
                    example: Intermediate
                  isPublished:
                    type: boolean
                    example: true
                  published:
                    type: boolean
                    example: true
                    description: Alias of `isPublished` used by dashboard/table views.
                  publishedAt:
                    type: string
                    format: date-time
                    example: '2026-04-12T10:00:00.000Z'
                    nullable: true
                  viewCount:
                    type: integer
                    example: 42
                  views:
                    type: integer
                    example: 42
                    description: Alias of `viewCount` used by dashboard/table views.
                  createdAt:
                    type: string
                    format: date-time
                    example: '2026-04-12T10:00:00.000Z'
                  updatedAt:
                    type: string
                    format: date-time
                    example: '2026-04-12T10:00:00.000Z'
                  availableLanguages:
                    type: array
                    items:
                      type: string
                    example:
                      - en
                      - nl
                  allTitles:
                    type: array
                    items:
                      type: object
                      required:
                        - lang
                        - value
                      properties:
                        lang:
                          type: string
                          example: en
                        value:
                          type: string
                          example: Core Fundamentals
                    example:
                      - lang: en
                        value: Core Fundamentals
                      - lang: nl
                        value: Kern Fundamenten
                  allDescriptions:
                    type: array
                    items:
                      type: object
                      required:
                        - lang
                        - value
                      properties:
                        lang:
                          type: string
                          example: en
                        value:
                          type: string
                          example: Core Fundamentals
                    example:
                      - lang: en
                        value: Core Fundamentals
                      - lang: nl
                        value: Kern Fundamenten
                  allVideos:
                    type: array
                    items:
                      type: object
                      required:
                        - lang
                        - url
                      properties:
                        lang:
                          type: string
                          example: en
                        url:
                          type: string
                          example: >-
                            https://cdn.example.com/video-library/company123/video-en.mp4
                        thumbnail:
                          type: string
                          example: >-
                            https://cdn.example.com/video-library/company123/thumb-en.jpg
                        duration:
                          type: number
                          nullable: true
                          example: 300
                        width:
                          type: integer
                          nullable: true
                          example: 1920
                        height:
                          type: integer
                          nullable: true
                          example: 1080
                        size:
                          type: integer
                          nullable: true
                          example: 104857600
                        platform:
                          type: string
                          enum:
                            - s3
                            - youtube
                            - tiktok
                            - vimeo
                            - facebook
                            - instagram
                            - other
                          example: s3
            pagination:
              type: object
              properties:
                page:
                  type: integer
                  example: 1
                limit:
                  type: integer
                  example: 10
                totalItems:
                  type: integer
                  example: 25
                totalPages:
                  type: integer
                  example: 3
        filterOptions:
          type: object
          properties:
            availableFilters:
              type: object
              properties:
                duration:
                  type: array
                  items:
                    type: string
                    enum:
                      - 1-10
                      - 11-20
                      - 21-30
                      - 30+
                  example:
                    - 1-10
                    - 11-20
                    - 21-30
                    - 30+
                level:
                  type: array
                  items:
                    type: string
                    enum:
                      - allLevels
                      - beginner
                      - intermediate
                      - advance
                  example:
                    - allLevels
                    - beginner
                    - intermediate
                    - advance
                category:
                  type: array
                  items:
                    type: string
                  example:
                    - Strength
                    - Mobility
                coaches:
                  type: array
                  description: Coaches who have added videos for this company.
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 67f1234567890abcdef1234
                      name:
                        type: string
                        example: Jane Smith
                        description: Coach full name (`firstName lastName`, trimmed).
                      image:
                        type: string
                        example: https://cdn.example.com/coaches/jane.jpg
                published:
                  type: array
                  items:
                    type: string
                    enum:
                      - all
                      - 'yes'
                      - 'no'
                  example:
                    - all
                    - 'yes'
                    - 'no'
            selectedFilters:
              type: object
              additionalProperties: true
    PublicApiError:
      type: object
      additionalProperties: false
      required:
        - error
        - meta
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - key
            - message
          properties:
            code:
              type: integer
              example: 401
            key:
              type: string
              example: auth.invalid_token
            message:
              type: string
              example: The access token is invalid.
            details:
              type: object
              additionalProperties: true
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    ErrorResponse:
      allOf:
        - $ref: '#/components/schemas/StandardResponse'
        - example:
            status: 401
            error: true
            message: MISSING_AUTH
    PublicApiMeta:
      type: object
      additionalProperties: false
      required:
        - requestId
      properties:
        requestId:
          type: string
          description: Stable request correlation id. Mirrors `X-Request-Id` when supplied.
          example: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
        rateLimit:
          $ref: '#/components/schemas/PublicApiRateLimitMeta'
    StandardResponse:
      type: object
      properties:
        status:
          type: integer
          example: 200
        error:
          type: boolean
          example: false
        message:
          type: string
          example: SUCCESS
      required:
        - status
        - error
        - message
    PublicApiRateLimitMeta:
      type: object
      additionalProperties: false
      properties:
        limit:
          type: integer
          example: 10
        remaining:
          type: integer
          example: 9
        resetSeconds:
          type: integer
          description: Seconds until the current rate limit window resets.
          example: 1
        retryAfterSeconds:
          type: integer
          description: Present when the request was rate limited.
          example: 1
  securitySchemes:
    PublicBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: >-
        Public API access token issued by `/public/v1/oauth/token`. Example:
        `Authorization: Bearer fspt_...`. Each resource request rechecks the
        token company's current provider access. Disabling access blocks
        existing tokens with `403 auth.provider_unavailable`.

````

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