Media

List media attachments for a workspace

get/media

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/media
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Query parameters

workspace_idstring required

Filter by workspace ID

filterstring

Filter: all, used, unused, favorites

sortstring

Sort: newest, oldest, name, size, recently_used

searchstring

Search filename, alt text, and tag

typestring

Filter by dominant media type

sourcestring

Filter by media provenance

asset_kindstring

Filter by asset role; defaults to library

lifecycle'library' | 'temporary' | 'trash' | 'all'

Lifecycle view; defaults to library

aspectstring

Filter: square, portrait, landscape

tag_idstring

Filter by one tag ID

tag_idsstring

Comma-separated tag IDs; media must have every selected tag

untaggedboolean

Only media that has no tags

min_widthinteger
min_heightinteger
max_widthinteger
max_heightinteger
date_fromstring

Created on or after this YYYY-MM-DD date

date_tostring

Created on or before this YYYY-MM-DD date

limitinteger

Limit (default 50, max 200)

offsetinteger

Offset for pagination

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

totalinteger required

Total count matching filter

Example response

{
  "$schema": "https://example.com/api/v1/schemas/ListMediaOutputBody.json"
}

Changes

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