Skip to main content
GET
List media in folder (cursor-paginated)
Required scope
  • read:media — Access media files, images, videos, and other content assets.

Authorizations

Authorization
string
header
required

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.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Path Parameters

folderName
string
required

Folder name (URL-encoded in path)

Required string length: 1 - 255

Query Parameters

cursor
string

Opaque pagination cursor from a previous response's nextCursor

size
integer
default:15

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

Required range: 1 <= x <= 50
mediaType
enum<string>
Available options:
image,
video,
audio,
document
name
string

Case-insensitive substring match on the media name.

startDate
string<date-time>

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

endDate
string<date-time>

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

variants
enum<string>[]

Comma-separated list of media variant types

The type of media variant

Available options:
blurred,
main,
thumbnail,
thumbnail_gallery
sort
enum<string>
default:createdAt

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

Available options:
createdAt,
addedAt
order
enum<string>
default:desc

Sort direction. Defaults to desc.

Available options:
asc,
desc

Response

Cursor-paginated list of media in folder

data
object[]
required

Array of media items in the folder

nextCursor
string | null
required

Opaque cursor for the next page, or null when there are no more results

total
number | null
required

Total number of items, or null when a count is not computed for this list