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

# List media in folder

> Returns a paginated list of media items in the specified folder.

<Info>
  **Required scope**

  * `read:media` — Access media files, images, videos, and other content assets.
</Info>


## OpenAPI

````yaml /openapi.json get /vault/folders/{folderName}/media
openapi: 3.1.0
info:
  title: Fanvue API
  version: '0.1'
servers: []
security: []
paths:
  /vault/folders/{folderName}/media:
    get:
      summary: List media in folder
      description: Returns a paginated list of media items in the specified folder.
      operationId: listVaultFolderMedia
      parameters:
        - $ref: '#/components/parameters/ApiVersionHeader'
        - schema:
            type: string
            minLength: 1
            maxLength: 255
            description: Folder name (URL-encoded in path)
          required: true
          description: Folder name (URL-encoded in path)
          name: folderName
          in: path
        - schema:
            type: number
            minimum: 1
            default: 1
            description: Page number to retrieve (starts from 1)
          required: false
          description: Page number to retrieve (starts from 1)
          name: page
          in: query
        - schema:
            type: number
            minimum: 1
            maximum: 50
            default: 15
            description: 'Number of items to return per page (1-50, default: 15)'
          required: false
          description: 'Number of items to return per page (1-50, default: 15)'
          name: size
          in: query
        - schema:
            type: string
            enum:
              - image
              - video
              - audio
              - document
          required: false
          name: mediaType
          in: query
        - schema:
            type: string
            description: Case-insensitive substring match on the media name.
          required: false
          description: Case-insensitive substring match on the media name.
          name: name
          in: query
        - schema:
            type: string
            format: date-time
            description: >-
              Filter to media created on or after this ISO 8601 datetime (with
              optional timezone offset, e.g. 2024-10-20T00:00:00Z).
          required: false
          description: >-
            Filter to media created on or after this ISO 8601 datetime (with
            optional timezone offset, e.g. 2024-10-20T00:00:00Z).
          name: startDate
          in: query
        - schema:
            type: string
            format: date-time
            description: >-
              Filter to media created before this ISO 8601 datetime
              (non-inclusive, with optional timezone offset).
          required: false
          description: >-
            Filter to media created before this ISO 8601 datetime
            (non-inclusive, with optional timezone offset).
          name: endDate
          in: query
        - schema:
            type: array
            items:
              $ref: '#/components/schemas/MediaVariantType'
            description: Comma-separated list of media variant types
          required: false
          name: variants
          in: query
          style: form
          explode: false
        - schema:
            type: string
            enum:
              - createdAt
              - addedAt
            default: createdAt
            description: >-
              Field to sort media by. Defaults to createdAt (media creation
              time).
          required: false
          description: Field to sort media by. Defaults to createdAt (media creation time).
          name: sort
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
            description: Sort direction. Defaults to desc.
          required: false
          description: Sort direction. Defaults to desc.
          name: order
          in: query
      responses:
        '200':
          description: List of media in folder
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      anyOf:
                        - type: object
                          properties:
                            uuid:
                              type: string
                              format: uuid
                            status:
                              type: string
                              enum:
                                - created
                                - processing
                                - ready
                                - error
                          required:
                            - uuid
                            - status
                        - type: object
                          properties:
                            uuid:
                              type: string
                              format: uuid
                            status:
                              type: string
                              enum:
                                - created
                                - processing
                                - ready
                                - error
                            createdAt:
                              type:
                                - string
                                - 'null'
                              format: date
                            url:
                              type: string
                            caption:
                              type:
                                - string
                                - 'null'
                            description:
                              type:
                                - string
                                - 'null'
                            name:
                              type:
                                - string
                                - 'null'
                            mediaType:
                              type: string
                              enum:
                                - image
                                - video
                                - audio
                                - document
                            recommendedPrice:
                              type:
                                - number
                                - 'null'
                            variants:
                              type: array
                              items:
                                type: object
                                properties:
                                  uuid:
                                    type: string
                                    format: uuid
                                  variantType:
                                    type: string
                                    enum:
                                      - blurred
                                      - main
                                      - thumbnail
                                      - thumbnail_gallery
                                  displayPosition:
                                    type: number
                                  url:
                                    type: string
                                  width:
                                    type:
                                      - number
                                      - 'null'
                                  height:
                                    type:
                                      - number
                                      - 'null'
                                  lengthMs:
                                    type:
                                      - number
                                      - 'null'
                                required:
                                  - uuid
                                  - variantType
                                  - displayPosition
                                  - width
                                  - height
                                  - lengthMs
                            purchasedByFan:
                              type: boolean
                            tags:
                              type:
                                - object
                                - 'null'
                              properties:
                                description:
                                  type:
                                    - string
                                    - 'null'
                                  description: AI-generated natural language description
                                tags:
                                  type: array
                                  items:
                                    type: string
                                  description: General content tags
                                nsfwCategory:
                                  type: array
                                  items:
                                    type: string
                                  description: NSFW classification labels
                                sexActs:
                                  type: array
                                  items:
                                    type: string
                                bodyParts:
                                  type: array
                                  items:
                                    type: string
                                people:
                                  type: array
                                  items:
                                    type: string
                                sexObjects:
                                  type: array
                                  items:
                                    type: string
                                setting:
                                  type: array
                                  items:
                                    type: string
                                  description: Scene / environment tags
                                position:
                                  type: array
                                  items:
                                    type: string
                                skinColor:
                                  type: array
                                  items:
                                    type: string
                                bodyType:
                                  type: array
                                  items:
                                    type: string
                                hairColor:
                                  type: array
                                  items:
                                    type: string
                                otherTags:
                                  type: array
                                  items:
                                    type: string
                                importantTags:
                                  type: array
                                  items:
                                    type: string
                                  description: Tags the model marked as salient
                                isNsfw:
                                  type: boolean
                                mediaType:
                                  type: string
                                  enum:
                                    - image
                                    - video
                              required:
                                - description
                                - tags
                                - nsfwCategory
                                - sexActs
                                - bodyParts
                                - people
                                - sexObjects
                                - setting
                                - position
                                - skinColor
                                - bodyType
                                - hairColor
                                - otherTags
                                - importantTags
                                - isNsfw
                                - mediaType
                              description: >-
                                Structured AI content tags. Only populated when
                                the owning creator has AI content tagging
                                enabled and the media has been processed; null
                                otherwise.
                          required:
                            - uuid
                            - status
                            - createdAt
                            - caption
                            - description
                            - name
                            - mediaType
                            - recommendedPrice
                    description: Array of media items
                  pagination:
                    type: object
                    properties:
                      page:
                        type: number
                        description: Current page number
                      size:
                        type: number
                        description: Number of records returned in this response
                      hasMore:
                        type: boolean
                        description: >-
                          Whether there are more items available on subsequent
                          pages
                    required:
                      - page
                      - size
                      - hasMore
                    description: Pagination information
                required:
                  - data
                  - pagination
              example:
                data:
                  - uuid: 550e8400-e29b-41d4-a716-446655440000
                    status: ready
                    createdAt: '2025-01-15T10:30:00.000Z'
                    caption: null
                    description: null
                    name: photo1.jpg
                    mediaType: image
                    recommendedPrice: null
                    variants:
                      - uuid: 550e8400-e29b-41d4-a716-4466554400aa
                        variantType: main
                        displayPosition: 0
                        url: >-
                          https://media.fanvue.com/main/550e8400-e29b-41d4-a716-446655440000.jpg
                        width: 1920
                        height: 1440
                        lengthMs: null
                  - uuid: 550e8400-e29b-41d4-a716-446655440001
                    status: processing
                pagination:
                  page: 1
                  size: 20
                  hasMore: true
        '400':
          description: Bad Request - API version not supported OR validation failed
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/UnsupportedVersionError'
                  - $ref: '#/components/schemas/ValidationError'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '403':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '410':
          $ref: '#/components/responses/SunsetVersionResponse'
        '429':
          $ref: '#/components/responses/RateLimitResponse'
      security:
        - BearerAuth:
            - read:media
components:
  parameters:
    ApiVersionHeader:
      name: X-Fanvue-API-Version
      in: header
      required: true
      schema:
        type: string
        default: '2025-06-26'
        example: '2025-06-26'
      description: API version to use for the request
  schemas:
    MediaVariantType:
      type: string
      enum:
        - blurred
        - main
        - thumbnail
        - thumbnail_gallery
      description: The type of media variant
    UnsupportedVersionError:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
      description: API version not supported
    ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            type: string
      required:
        - errors
      description: Request validation failed
  responses:
    UnauthorizedResponse:
      description: Unauthorized Response
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
    NotFoundResponse:
      description: Not Found Response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
            required:
              - message
    SunsetVersionResponse:
      description: API version no longer supported (sunset)
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              message:
                type: string
              nextVersion:
                type: string
            required:
              - error
              - message
    RateLimitResponse:
      description: Too many requests - rate limit exceeded
      headers:
        Retry-After:
          description: Number of seconds to wait before retrying the request
          schema:
            type: integer
        X-RateLimit-Limit:
          description: The maximum number of requests allowed in the current window
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: The number of requests remaining in the current window
          schema:
            type: integer
        X-RateLimit-Reset:
          description: The Unix timestamp (seconds) when the rate limit window resets
          schema:
            type: integer
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
  securitySchemes:
    BearerAuth:
      type: oauth2
      description: >-
        OAuth 2.0 access token, presented as a JWT bearer token in the
        `Authorization` header. Obtain a token via the authorization-code flow;
        the scopes granted to the token determine which operations it may call.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.fanvue.com/oauth2/auth
          tokenUrl: https://auth.fanvue.com/oauth2/token
          refreshUrl: https://auth.fanvue.com/oauth2/token
          scopes:
            read:self: >-
              Access your own user profile information, including basic account
              details and settings.
            read:chat: >-
              Read chat conversations, messages, and chat-related data. This
              includes viewing chat lists and message history.
            write:chat: >-
              Create new chats and send messages. This scope is required for any
              chat-related actions that modify data.
            read:experience: >-
              Exchange a fan's experience token for the resolved experience and
              the fan's identity, so an embedded fan-facing experience can
              render the right content.
            write:experience: >-
              Request that the creator publish or unpublish a fan-facing
              experience. The app mints a request token; the creator confirms
              and Fanvue performs the change.
            read:fan: Access fan-related data and information within the platform.
            read:post: Read posts, including post details, comments, likes, and tips.
            write:post: Create, edit, and manage posts and content on behalf of users.
            read:media: Access media files, images, videos, and other content assets.
            write:media: >-
              Upload, modify, and manage media files and content assets. Also
              required for vault folder management.
            read:creator: >-
              Access creator profiles, content, and creator-specific
              information.
            write:creator: Modify creator profiles, settings, and creator-specific data.
            read:insights: >-
              Access analytics, metrics, and insights data for performance
              tracking.
            read:tracking_links: >-
              Read tracking links and the users associated with them, including
              per-user tracking metadata.
            write:tracking_links: Create and delete tracking links.
            read:agency: Read agency information, including the agency's team members.
            write:agency: >-
              Manage agency team members and invites, including inviting new
              team members and creators.

````