Media

List the media library

Every photo and file the user uploaded to the project's media library (in the portal under Media, or with an upload link from POST /media/links), newest first, with the folders. Per file: path under /media/, size, width and height, the 640 version for srcset, alt text, and the sites that use it. A file on no site has url null: it is private until you put it on a site with POST /sites or PUT /sites/{id} and media. Never contains the bytes. folder narrows to a folder (with its subfolders), path to one file, site_id to the files on one site.

get/media

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/media
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: sites:read)

Query parameters

folderstring

Only this folder under /media/, with its subfolders, like portfolio.

pathstring

Only the file with this path, like /media/logo.webp.

site_idstring uuid

Only the files this site uses.

limitinteger

At most this many files (default 100).

cursorstring

next_cursor from the previous page.

tagstring

Only files with this tag.

kind'image' | 'video' | 'audio' | 'pdf' | 'font' | 'archive' | 'document' | 'data' | 'other'

Only this kind of file.

qstring

A word in the name, path or title.

include_deletedboolean

true: also the files in the trash (deleted_at set).

Response

The files and the folders.

next_cursorstring nullable required

Pass it as cursor for the next page; null when there is no more.

Changes

No recorded changes to this operation across all 1 revision of this API.