assets

List the workspace's files

One page of live assets, most recently changed first. Narrow with category (document | media | app), kind (pdf, image, …) and search (case-insensitive substring of the name). total is the true number of matches across all pages, not the number returned, so a truncated page can never read as a complete library. Deleted files are never listed. Dashboards (category=app) list newest first by creation unless sort says otherwise, take scope, source and sort, and carry app_facets, the filter options for the same reader.

get/v1/assets

Request

  • Base URL: https://api.patricia.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.patricia.app/v1/assets
  • Auth: HTTP bearer

Query parameters

categorystring nullable

Narrow to 'document', 'media' or 'app'.

kindstring nullable

Narrow to one kind, e.g. 'pdf' or 'image'.

searchstring nullable

Case-insensitive name substring.

folder_idstring uuid nullable

Narrow to one folder. Omit for no folder narrowing: every file, filed or not, unless unfiled=true also narrows to the unfiled ones.

author_actor_idstring uuid nullable

Narrow to files one workspace member is credited with.

favoriteboolean nullable

True narrows to favourites (the Liked filter). False and unset both mean all.

unfiledboolean

Narrow to files in no folder — the dashboard's top level. Cannot combine with folder_id.

scope'all' | 'mine' | 'shared' nullable

Dashboards only (category=app). 'all' (the default) lists every dashboard the caller can open, 'mine' the ones the caller made, 'shared' the rest.

sourcestring[] nullable

Dashboards only (category=app). Repeat to narrow to dashboards that read from ANY of these provider keys. At most 50 values of 1 to 255 characters. An unknown key matches nothing.

sort'newest' | 'name_asc' | 'name_desc' nullable

Dashboards only (category=app). 'newest' (the default), 'name_asc' or 'name_desc'.

limitinteger
offsetinteger

Headers

X-Tenant-Idstring nullable

Response

Successful Response

totalinteger required

Live assets matching the filter, across all pages.

limitinteger required

The page size actually applied.

offsetinteger required

The offset actually applied.

Changes

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