PWpwapps
Media Library

List media assets

Changed on

Filter, search and paginate the library. Section is a soft filter (omit = All).

get/api/v1/media

Request

  • Base URL
    https://api.pwapps.com (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URLhttps://api.pwapps.com/api/v1/user/login
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

kind'image' | 'video'
sectionstring nullable
folderIdstring nullable

uuid or 'root'

tagstring nullable
usedIn'pwa' | 'pwa_template' | 'landing' | 'push_template' | 'push_notification' | 'push_rule'

Consumers that can attach a media asset (usage reverse-links).

The push_* members come from pwapps-push-service via the media.usage topic — see docs/gallery/push-usage-kafka-plan.md.

searchstring nullable

Matches the filename or any of the asset's tags.

minWidthinteger nullable

Hide images narrower than this (picker gate).

minHeightinteger nullable

Hide images shorter than this (picker gate).

archivedboolean
includeDerivedboolean
sort'createdAt' | '-createdAt' | 'size' | '-size'
pageinteger
sizeinteger

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Changes

  • 615ebc9bfa17Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status