List media in folder

Changed on

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

get/vault/folders/{folderName}/media

Request

  • Base URL
    https://api.fanvue.com
  • URL
    https://api.fanvue.com/vault/folders/{folderName}/media
  • Auth
    OAuth 2
    Authorization code: https://auth.fanvue.com/oauth2/auth
    Token URL: https://auth.fanvue.com/oauth2/token scopes: read:media

Path parameters

folderNamestring required

Folder name (URL-encoded in path)

Query parameters

pageinteger

Page number to retrieve (starts from 1)

sizeinteger

Number of items to return per page (1-50, default: 15)

mediaType'image' | 'video' | 'audio' | 'document'
namestring

Case-insensitive substring match on the media name.

startDatestring date-time

Filter to media created on or after this ISO 8601 datetime (with optional timezone offset, e.g. 2024-10-20T00:00:00Z).

endDatestring date-time

Filter to media created before this ISO 8601 datetime (non-inclusive, with optional timezone offset).

variantsMediaVariantType[]

Comma-separated list of media variant types

sort'createdAt' | 'addedAt'

Field to sort media by. Defaults to createdAt (media creation time).

order'asc' | 'desc'

Sort direction. Defaults to desc.

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Response

List of media in folder

Changes

    • breaking

      the ///// response's property format changed from uuid to no format for status